Health

The connector reports its health status using the Spring Boot Actuator health endpoint.

To configure the information returned by the health endpoint, configure the following properties:

management.endpoint.health.show-details
management.endpoint.health.show-components

For more information about the health endpoints, see Spring Boot documentation.

Health for the workflow, Solace binder, and the messaging service's binder components are exposed when management.endpoint.health.show-components is enabled. For example:

management: 
  endpoint:
    health:
      show-components: always 
      show-details: always

This configuration would always show the full details of the health check including the workflows and binders. The default value is never.

Workflow Health

A workflows health indicator is provided to show the health status for each of a connector’s workflows. This health indicator has the following form:

{
  "status": "(UP|DOWN)", 
  "components": {
    "<workflow-id>": { 
      "status": "(UP|DOWN)", 
      "details": {
        "error": "<error message>"
      }
    }
  }
}

Health Status	Description
`UP`	A status that indicates the workflow is functioning as expected.
`DOWN`	A status that indicates the workflow is unhealthy. Operator intervention may be required.

Figure 1. Workflow for Health Resolution Diagram

The following diagram describes the workflow to resolve any issues in the health status of this connector.

Illustration depicting the concepts described in the surrounding text.

This health indicator is enabled by default. To disable it, set the property as follows:

management.health.workflows.enabled=false

Solace Binder Health

For more information, see Solace binder documentation.

Amazon SQS Binder Health

The following table lists the health status for binder for Amazon SQS.

Health Status	Description
UP	Status indicating that the binder is functioning as expected.
UNKNOWN	Status indicating that the binder is in an unknown state. The binder will automatically recovers when the underlying connectivity issues are resolved. Operator intervention may be required.
DOWN	Status indicating that the binder is having difficulties reconnecting to Amazon SQS. The binder automatically recover when underlying connectivity issues are resolved. User intervention may be required.

For more information, see Spring Cloud SQS Binder Health Indicator.

Provide feedback