Skip to content

Add Ping Contributor #340

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.

Sign up for GitHub

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

Merged
bart-vmware merged 1 commit into from
Jan 21, 2025
Merged

Add Ping Contributor #340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions api/v4/management/health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Each key must be prefixed with `Management:Endpoints:Health:`.
| `Path` | The relative path at which the endpoint is exposed. | same as `ID` |
| `RequiredPermissions` | Permissions required to access the endpoint, when running on Cloud Foundry. | `Restricted` |
| `AllowedVerbs` | An array of HTTP verbs the endpoint is exposed at. | `GET` |
| `ShowDetails` | The level of detail included in the response. | `Always` |
| `ShowDetails` | The level of detail included in the response. | `Never` |
| `Claim` | The claim required in `HttpContext.User` when `ShowDetails` is set to `WhenAuthorized`. | |
| `Role` | The role required in `HttpContext.User` when `ShowDetails` is set to `WhenAuthorized`. | |
| `Groups` | Specify logical groupings of health contributors. | |
Expand Down Expand Up @@ -84,7 +84,8 @@ The configuration key `Management:Endpoints:UseStatusCodeFromResponse` can be se
Clients can overrule this per request by sending an `X-Use-Status-Code-From-Response` HTTP header with the value `true` or `false`.

> [!TIP]
> By default, health contributors for disk space, liveness, and readiness are activated. They can be turned off through configuration:
> By default, health contributors for disk space, ping, liveness, and readiness are activated. They can be turned off through configuration:
>
> ```json
> {
> "Management": {
Expand All @@ -93,6 +94,9 @@ Clients can overrule this per request by sending an `X-Use-Status-Code-From-Resp
> "DiskSpace": {
> "Enabled": "false"
> },
> "Ping": {
> "Enabled": "false"
> },
> "Liveness": {
> "Enabled": "false"
> },
Expand All @@ -115,16 +119,21 @@ The response will always be returned as JSON, like this:
{
"status": "UP",
"details": {
"diskSpace": {
"total": 1020959649792,
"free": 813492727808,
"threshold": 10485760,
"ping": {
"status": "UP"
},
"diskSpace": {
"status": "UP",
"total": 1999599824896,
"free": 1349396418560,
"threshold": 10485760
},
"readiness": {
"status": "UP",
"ReadinessState": "ACCEPTING_TRAFFIC"
},
"liveness": {
"status": "UP",
"LivenessState": "CORRECT"
}
}
Expand Down
Loading