Introduce endpoints for service observability:
- A Health Check endpoint for basic service status
- A Prometheus Metrics endpoint for monitoring and alerting
Tasks
Considerations
- Should the health check endpoint be publicly accessible?
This needs to be decided. In many deployments, health checks are available publicly or to a load balancer but not necessarily to anyone else.
- Ensure that
/metrics is secured or restricted to monitoring tools only.
Introduce endpoints for service observability:
Tasks
/healthendpoint to verify that the service is running/metricsendpoint compatible with Prometheus scrapingConsiderations
This needs to be decided. In many deployments, health checks are available publicly or to a load balancer but not necessarily to anyone else.
/metricsis secured or restricted to monitoring tools only.