mirror of
https://github.com/prometheus/prometheus.git
synced 2024-11-10 07:34:04 -08:00
9594fa4dbd
Some frameworks issue HEAD requests to determine health. This resolves prometheus/prometheus#11159 Signed-off-by: Nicolas Dumazet <nicdumz.commits@gmail.com> Signed-off-by: Nicolas Dumazet <nicdumz.commits@gmail.com>
53 lines
1 KiB
Markdown
53 lines
1 KiB
Markdown
---
|
|
title: Management API
|
|
sort_rank: 8
|
|
---
|
|
|
|
# Management API
|
|
|
|
Prometheus provides a set of management APIs to facilitate automation and integration.
|
|
|
|
|
|
### Health check
|
|
|
|
```
|
|
GET /-/healthy
|
|
HEAD /-/healthy
|
|
```
|
|
|
|
This endpoint always returns 200 and should be used to check Prometheus health.
|
|
|
|
|
|
### Readiness check
|
|
|
|
```
|
|
GET /-/ready
|
|
HEAD /-/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.
|
|
|
|
Alternatively, a configuration reload can be triggered 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.
|
|
|
|
Alternatively, a graceful shutdown can be triggered by sending a `SIGTERM` to the Prometheus process.
|