sergiitk / pagerbeauty

:pager::sparkles: PagerDuty on-call widget for monitoring dashboard. Datadog and Grafana compatible
https://demo.pagerbeauty.sergii.org/v1/schedules/PDUQGYJ.html
MIT License
338 stars 27 forks source link

Add Health Check Endpoint #156

Open JamesFrost opened 3 years ago

JamesFrost commented 3 years ago

Having a dedicated endpoint that could be used to check the health of the service would help enable monitoring PagerBeauty deployments. This is a common pattern that can be used with other services.

We're currently using the /v1/schedules endpoint for health checking, but this isn't ideal, as it isn't the purpose of this endpoint. Additionally, this endpoint displays information about the schedules, and so should be authenticated.

Optionally, the health check endpoint could do some functional checks e.g. is the PagerDuty integration still working.