Skip to content

Commit

Permalink
microprofile-health-35 Provide different types of health check
Browse files Browse the repository at this point in the history
Integrate feedback

Signed-off-by: Antoine Sabot-Durand <antoine@sabot-durand.net>
  • Loading branch information
antoinesd committed Apr 23, 2019
1 parent dce2c95 commit dc0da36
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/java-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The `@Liveness` annotation must be applied on a `HealthCheck` implementation to

To provide backward compatibility with previous specification version, a `HealthCheck` implementation with `@Health` annotation is still supported.

`@Health` annotation being deprecated, new procedures shouldn't use it.
`@Health` annotation is deprecated, new procedures shouldn't use it.

== Multiple HealthChecks procedures for a given kind

Expand Down
7 changes: 5 additions & 2 deletions spec/src/main/asciidoc/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,18 @@ https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-read
In this scenario health checks are used to determine if a computing node needs to be discarded (terminated, shutdown) and eventually replaced by another (healthy) instance.

The MP-HC architecture consists of two `/health/ready` and `/health/live` endpoints in a MicroProfile runtime that respectively represent the readiness and the liveness of the entire runtime.
For backward compatibility, a 3rd endpoint `/health` can also be used to provide a combination of previous endpoints.
These endpoints are linked to Health Check procedures defined with specifications API and annotated respectively with `@Liveness` and `@Readiness` annotations.

For backward compatibility, a 3rd endpoint `/health` may also be used to provide a combination of previous endpoints and Health Check procedures annotated with the deprecated `@Health` annotation.

These endpoints are expected to be associated with a configurable context, such as a web application deployment, that can be configured with settings such as port, virtual-host, security, etc.
Further, the MP-HC defines the notion of a procedure that represents the health of a particular
subcomponent of an application.

In an application, there can be zero or more procedures bound to a given health endpoint.
The overall application health for a given endpoint is the logical AND of all of the procedures bound to it.

The current version of the MP-HC specification does not define how the `/health/live` endpoint may be partitioned in the event
The current version of the MP-HC specification does not define how the `/health/live` and `/health/ready` endpoints may be partitioned in the event
that the MicroProfile runtime supports deployment of multiple applications. If an implementation wishes to
support multiple applications within a MicroProfile runtime, the semantics of individual endpoints are
expected to be the logical AND of all the application in the runtime. The exact details of this are deferred to
Expand Down

0 comments on commit dc0da36

Please sign in to comment.