Skip to content

Commit 3bd1c10

Browse files
committed
microprofile-health-35 Provide different types of health check
Typos and rewording Signed-off-by: Antoine Sabot-Durand <antoine@sabot-durand.net>
1 parent 8518431 commit 3bd1c10

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

spec/src/main/asciidoc/java-api.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface HealthCheck {
3434

3535
Applications provide health check procedures (implementation of a `HealthCheck`), which will be used by the runtime hosting the application to verify the healthiness of the computing node.
3636

37-
== Different kind of Health Checks
37+
== Different kinds of Health Checks
3838

3939
This specification provides different kind of health check procedures.
4040
Difference between them is only semantic.
@@ -45,24 +45,25 @@ The nature of the procedure is defined by annotating the `HealthCheck` procedure
4545
* Custom checks defined with `@Health` annotation
4646

4747

48-
An `HealthCheck` procedures with none of the above annotations is not an active procedure and should be ignored.
48+
A `HealthCheck` procedures with none of the above annotations is not an active procedure and should be ignored.
4949

5050
=== Readiness check
5151

5252
A Health Check for readiness allows third party services to know if the application is ready to process request or not.
5353

54-
The `@Readiness` annotation must be applied on an `HealthCheck` implementation to define a readiness check procedure.
54+
The `@Readiness` annotation must be applied on a `HealthCheck` implementation to define a readiness check procedure.
5555

5656
=== Liveness check
5757

58-
A Health Check for liveness allows third party services to know if the application is alive and able to process request or not.
58+
A Health Check for liveness allows third party services to determine if the application is running.
59+
This means that if this procedure fails the application can be discarded (terminated, shutdown).
5960

60-
The `@Liveness` annotation must be applied on an `HealthCheck` implementation to define a Liveness check procedure.
61+
The `@Liveness` annotation must be applied on a `HealthCheck` implementation to define a Liveness check procedure.
6162

6263

6364
=== Custom check
6465

65-
To provide backward compatibility with previous specification version, an `HealthCheck` implementation with `@Health` annotation is still supported.
66+
To provide backward compatibility with previous specification version, a `HealthCheck` implementation with `@Health` annotation is still supported.
6667

6768
Semantic of such a health check procedure is let to the implementor and therefor is defined as "custom".
6869

@@ -92,9 +93,9 @@ public abstract class HealthCheckResponse {
9293
The status of all `HealthCheck` 's determines the overall status for the given Health check kind.
9394

9495

95-
== Combining multiple kind of checks
96+
== Combining multiple kinds of checks
9697

97-
An `HealthCheck` implementation may be annotated with multiple kind of check.
98+
A `HealthCheck` implementation may be annotated with multiple kinds of checks.
9899
The procedure will be used to resolve every kind of health check for which it is annotated.
99100

100101
For instance this procedure will be used to resolve liveness and readiness health check.
@@ -161,7 +162,7 @@ public class MyCheck implements HealthCheck {
161162
}
162163
```
163164

164-
Health check procedures are CDI bean, therefore, they can also be defined with CDI producers:
165+
Health check procedures are CDI beans, therefore, they can also be defined with CDI producers:
165166

166167

167168
```

spec/src/main/asciidoc/overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-read
2727

2828
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.
2929

30-
The MP-HC architecture consists of two `/health/ready` and `/health/live` endpoints in a MicroProfile runtime that respectively represents the readiness and the liveness of the entire runtime.
30+
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.
3131
For backward compatibility, a 3rd endpoint `/health` can also be used to provide a custom Health Check.
3232
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.
3333
Further, the MP-HC defines the notion of a procedure that represents the health of a particular
3434
subcomponent of an application.
3535

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

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

0 commit comments

Comments
 (0)