Actuator health indicator and endpoints.
Portated from Spring Boot's health package.
Classes
- CompositeHealth
- Health
- HealthContributorRegistry
- HealthEndpoint
- HttpCodeStatusMapper
- SimpleHttpCodeStatusMapper
- SimpleStatusAggregator
- Status
- StatusAggregator
Type Definitions
EndpointResponse
Returned by an operation to provide addtional, web-specific information such as the HTTP status code.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
status |
number | The HTTP status code. |
body |
Health | CompositeHealth | The response body. |
HealthEndpointGroup
A logical grouping of health contributors that can be exposed by the HealthEndpoint.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
statusAggregator |
StatusAggregator | The status aggregator. |
httpCodeStatusMapper |
HttpCodeStatusMapper | The HTTP code status mapper. |
HealthEndpointGroups
A collection of groups for use with a health endpoint.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
primary |
HealthEndpointGroup | The primary group. |
HealthIndicator
Strategy interface used to contribute Health to the results returned from the HealthEndpoint.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
health |
function | Returns the health of the component. |
NamedContributor
A named HealthIndicator.
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
name |
string | The name of the contributor. |
contributor |
HealthIndicator | The contributor. |