mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-12-26 06:04:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
prometheus/docs/management_api.md
Marco Pracucci 2ccc48adc6 Documented /healthy, /ready and lifecycle API (#5737) 
Signed-off-by: Marco Pracucci <marco.pracucci@spreaker.com>
2019-07-05 10:50:48 +01:00

1,015 B
Raw Blame History

title sort_rank
Management API 7

Management API

Prometheus provides a set of management API to ease automation and integrations.

Health check

GET /-/healthy

This endpoint always returns 200 and should be used to check Prometheus health.

Readiness check

GET /-/ready

This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries).

Reload

PUT  /-/reload
POST /-/reload

This endpoint triggers a reload of the Prometheus configuration and rule files. It's disabled by default and can be enabled via the --web.enable-lifecycle flag.

An alternative way trigger a configuration reload is by sending a SIGHUP to the Prometheus process.

Quit

PUT  /-/quit
POST /-/quit

This endpoint triggers a graceful shutdown of Prometheus. It's disabled by default and can be enabled via the --web.enable-lifecycle flag.

An alternative way trigger a graceful shutdown is by sending a SIGTERM to the Prometheus process.