Monitoring Service Availability via the Health Endpoint

Purpose

To ensure the reliability and availability of the service, a health monitoring endpoint is provided. This endpoint returns the status of the admin database, platform/application server, and all registered repository databases. By regularly checking this endpoint, users and automated monitoring tools can detect potential issues early and take corrective actions if a service component becomes unavailable.

Health Check Endpoint

The health check can be accessed by making an HTTP GET request to the following URL:

https://<your-service-url>/Health

The H needs to be capitalized!

Response Format

The endpoint returns a JSON response containing:

• Overall system health summary

• Health status of the platform

• Health status of the admin database

• Health status of all registered repository databases

Example Response

{
  "healthSummary": {
    "admindatabase": "UP",
    "platform": "UP",
    "repositories": "UP"
  },
  "platformHealthStatus": {
    "healthIndicator": "UP"
     },
  "adminHealthStatus": {
    "healthIndicator": "UP"
  },
  "repositoryHealthStatus": {
    "[repository UUID]": {
      "healthIndicator": "UP"
    },
    "[repository UUID]": {
      "healthIndicator": "UP"
    }
  }
}

Understanding the Response

• healthSummary

  • Indicates the overall health of the system components (UP means available).

• platformHealthStatus

  • Shows the status of the core platform.

• adminHealthStatus

  • Reports the admin database status.

• repositoryHealthStatus

  • Lists the health of each registered repository database, identified by unique UUIDs.

How to Monitor the Endpoint

To integrate health monitoring into your system checks or monitoring tools, follow these approaches:

1. Manual Health Check

Use cURL or a browser to check the service status:

curl -X GET https://<your-service-url>/Health

If everything is functioning properly, you see a response similar to the example above.

2. Automated Monitoring with Alerting

• Use monitoring tools such as Prometheus, Datadog, Nagios, or AWS CloudWatch to periodically check the /Health endpoint.

• Set up alerts when the response contains "DOWN" for any service.

Common Issues & Troubleshooting

For further assistance, contact your system administrator or our support team at https://echo.igrafx.com/