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

DOCS: 4.x Health Checks SE and MP #6451

Closed
8 tasks done
ljamen opened this issue Mar 22, 2023 · 0 comments
Closed
8 tasks done

DOCS: 4.x Health Checks SE and MP #6451

ljamen opened this issue Mar 22, 2023 · 0 comments
Assignees
Labels
Milestone

Comments

@ljamen
Copy link
Contributor

ljamen commented Mar 22, 2023

Problem Description

We need to update docs for 4.x

  • update health.adoc for MP
  • update health.adoc for SE
  • update health.adoc guide for MP
  • update health.adoc guide for SE

Guidelines

  • Make sure any fixes from SE 3.x are forward ported to 4.x DOCS: SE Diffs 3.x to Main *.adoc  #7515
  • Make sure any fixes from MP 3.x are forward ported to 4.x
  • Initial focus is on correctness
  • Record migration impact in this issue

Migration Impact

Summarize incompatibilities between Helidon 3 and Helidon 4.

  • MP: To set the path for the health endpoint, use the health.endpoint config key instead of health.web-context.
  • SE: To set the path for the health endpoint:
    • Use the features.observe.observers.health.endpoint key instead of health.web-context.
    • Use the endpoint method on the HealthObserver.Builder type instead of the webContext method on the HealthSupport.Builder type.
  • SE and MP: To set up a non-default socket for health (and all observability endpoints) use the server.features.observe.socket config key:
    server:
      sockets:
        - name: "admin"
        - port: 8081
      features:
        observe:
          socket: "admin"
    
  • SE: The HealthSupport type is replaced by the combination of ObserveFeature and HealthObserver. See the doc for details.
  • SE: The default health endpoint is now at /observe/health instead of /health as in 3.x.
  • SE: SE applications now use the io.helidon.health.HealthCheck and ...HealthCheckResponse types instead of the counterpart types from MicroProfile Health.
  • SE: Adding the helidon-health and helidon-health-checks dependencies to a project automatically adds the built-in health checks and the health endpoint to the application; application code no longer needs to explicitly add health to the application unless it also disables WebServer.Builder.featuresDiscoverServices.

Summarize actions customers must take to migrate code
OK to reference external specs or documents (for example MicroProfile specs)

@ljamen ljamen added docs health 4.x Version 4.x labels Mar 22, 2023
@ljamen ljamen added this to the 4.0.0-RC1 milestone Mar 22, 2023
@ljamen ljamen self-assigned this Mar 22, 2023
@ljamen ljamen changed the title DOCS: 4.x Health Checks Nima and MP DOCS: 4.x Health Checks SE and MP Aug 31, 2023
@ljamen ljamen modified the milestones: 4.0.0-M2, 4.0.0-RC1, 4.0.0 Aug 31, 2023
@m0mus m0mus added this to Backlog Aug 12, 2024
@m0mus m0mus moved this to Closed in Backlog Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Archived in project
Development

No branches or pull requests

2 participants