Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
tjquinno opened this issue Apr 4, 2024 · 0 comments
Assignees
Labels
3.x Issues for 3.x version branch bug Something isn't working docs health
Milestone

Comments

@tjquinno
Copy link
Member

tjquinno commented Apr 4, 2024

Environment Details

  • Helidon Version: 3.x
  • Helidon SE or Helidon MP
  • JDK version:
  • OS:
  • Docker version (if applicable):

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 at health.exclude (no helidon prefix).

(Similar problem most likely with include, include-classes, and exclude-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 longer helidon.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 the exclude and include configuration), deprecating the keys with the helidon prefix and perhaps even logging a warning if the helidon prefix appears for health settings.

Steps to reproduce

Use the Helidon 3 MP QuickStart example app.

  1. Build and run the application without change.

  2. Run curl -v http://localhost:8080/health. The output includes the deadlock health check.

  3. In the Helidon 3 MP quickstart app, add the following to META-INF/microprofile-config.properties:

    health.exclude=deadlock
    
  4. Rebuild and rerun the app.

  5. Run curl -v http://localhost:8080/health again. The output does not contain the deadlock health check information.

  6. Change the added config line to

    helidon.health.exclude=deadlock
    
  7. Rebuild and rerun the app.

  8. Access curl -v http://llocalhost:8080/health again. The output again contains the deadlock health check.

@tjquinno tjquinno added bug Something isn't working health 4.x Version 4.x labels Apr 4, 2024
@m0mus m0mus added the docs label Apr 22, 2024
@m0mus m0mus added this to the 4.0.8 milestone Apr 22, 2024
@tjquinno tjquinno changed the title Doc describes use of helidon.health.exclude to exclude built-in checks but 4.x code does not support it Doc describes use of helidon.health.exclude to exclude built-in checks but that's the wrong config key for 3.x and the 4.x code does not support the feature Apr 24, 2024
@tjquinno tjquinno added health and removed health labels Apr 24, 2024
@tjquinno tjquinno changed the title Doc describes use of helidon.health.exclude to exclude built-in checks but that's the wrong config key for 3.x and the 4.x code does not support the feature Doc for 3.x describes the use of helidon.health.exclude to exclude built-in checks but that's not the correct config key Apr 24, 2024
@tjquinno tjquinno added 3.x Issues for 3.x version branch and removed 4.x Version 4.x labels Apr 24, 2024
@tjquinno tjquinno modified the milestones: 4.0.8, 3.2.9 Apr 24, 2024
@m0mus m0mus added this to Backlog Aug 12, 2024
@m0mus m0mus moved this to In Progress in Backlog Aug 12, 2024
@barchetta barchetta modified the milestones: 3.2.9, 3.2.10 Aug 21, 2024
@tjquinno tjquinno closed this as completed Oct 3, 2024
@github-project-automation github-project-automation bot moved this from Sprint Scope to Closed in Backlog Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.x Issues for 3.x version branch bug Something isn't working docs health
Projects
Archived in project
Development

No branches or pull requests

3 participants