Example
Show whether a service is up
Contracts say whether two systems agree. A health check says whether a system is running right now. Give the auth service a health URL; the app calls it while the Connections view is open and shows Operational, Degraded, Down or Maintenance next to the contract status.
You will build
- A health check on Auth Service
- A rule that reads Degraded from the answer
- The service status on the system page and the map
Part 1: Turn the check on
- 1.
Open Auth Service → Running → Health checks, pick the environment and click Set up. - 2.
Fill in Health check: - Method
- GET
- URL
- https://auth.example.com/health
- Check every
- 1 minute
- Operational when
- 2xx
- 3.
Optional: under Other environments, add your staging URL, and under Headers an Authorizationheader if the URL needs one.Header values are kept on the server. They never reach anyone’s browser.
Part 2: Read Degraded from the answer
- 1.
Under Status from the response, add a rule: when the field statusequalsdegraded, the service isDegraded.Rules are tried top to bottom before the check above. With no rule, a service is only Operational or Down. - 2.
Click Test. The Test result shows the status and the answer it read. - 3.
Click Save.
Check:
