Doc for 3.x describes the use of helidon.health.exclude
to exclude built-in checks but that's not the correct config key
#8617
Milestone
Environment Details
Problem Description
The doc https://helidon.io/docs/v3/mp/health#_configuration_options describes the ability to set
helidon.health.exclude
to a comma-separated list of built-in health check names. In fact, Helidon looks athealth.exclude
(nohelidon
prefix).(Similar problem most likely with
include
,include-classes
, andexclude-classes
.)The Javadoc for the built-in health checks repeats the same error.
(See #9322 for the remaining problem.)
Further confusing matters, some built-in health checks support configuration to fine-tune their behavior and those settings do use the longerhelidon.health
prefix (e.g.,helidon.health.diskSpace.thresholdPercent
).We might want/need to support both prefix styles for both types of settings (the per-health-check configuration and theexclude
andinclude
configuration), deprecating the keys with thehelidon
prefix and perhaps even logging a warning if thehelidon
prefix appears for health settings.Steps to reproduce
Use the Helidon 3 MP QuickStart example app.
Build and run the application without change.
Run
curl -v http://localhost:8080/health
. The output includes thedeadlock
health check.In the Helidon 3 MP quickstart app, add the following to
META-INF/microprofile-config.properties
:Rebuild and rerun the app.
Run
curl -v http://localhost:8080/health
again. The output does not contain thedeadlock
health check information.Change the added config line to
Rebuild and rerun the app.
Access
curl -v http://llocalhost:8080/health
again. The output again contains thedeadlock
health check.The text was updated successfully, but these errors were encountered: