mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-11-09 23:24:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Document new status API endpoints (#6262)

Browse source 
* Document new status API endpoints

These were added in https://github.com/prometheus/prometheus/pull/6243
for the React UI.

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Update new-in notices

Signed-off-by: Julius Volz <julius.volz@gmail.com>
This commit is contained in:
Julius Volz 2019-11-02 18:18:32 +01:00 committed by GitHub
parent cb7cbad5f9
commit f7446778f3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 65 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
docs/querying/api.md
View file

@ -679,7 +679,7 @@ The following endpoint returns flag values that Prometheus was configured with:
GET /api/v1/status/flags
```
All values are in a form of "string".
All values are of the result type `string`.
```json
$ curl http://localhost:9090/api/v1/status/flags
@ -698,6 +698,70 @@ $ curl http://localhost:9090/api/v1/status/flags
*New in v2.2*
### Runtime Information
The following endpoint returns various runtime information properties about the Prometheus server:
```
GET /api/v1/status/runtimeinfo
```
The returned values are of different types, depending on the nature of the runtime property.
```json
$ curl http://localhost:9090/api/v1/status/runtimeinfo
{
"status": "success",
"data": {
"startTime": "2019-11-02T17:23:59.301361365+01:00",
"CWD": "/",
"reloadConfigSuccess": true,
"lastConfigTime": "2019-11-02T17:23:59+01:00",
"chunkCount": 873,
"timeSeriesCount": 873,
"corruptionCount": 0,
"goroutineCount": 48,
"GOMAXPROCS": 4,
"GOGC": "",
"GODEBUG": "",
"storageRetention": "15d"
}
}
```
**NOTE**: The exact returned runtime properties may change without notice between Prometheus versions.
*New in v2.14*
### Build Information
The following endpoint returns various build information properties about the Prometheus server:
```
GET /api/v1/status/buildinfo
```
All values are of the result type `string`.
```json
$ curl http://localhost:9090/api/v1/status/buildinfo
{
"status": "success",
"data": {
"version": "2.13.1",
"revision": "cb7cbad5f9a2823a622aaa668833ca04f50a0ea7",
"branch": "master",
"buildUser": "julius@desktop",
"buildDate": "20191102-16:19:59",
"goVersion": "go1.13.1"
}
}
```
**NOTE**: The exact returned build properties may change without notice between Prometheus versions.
*New in v2.14*
## TSDB Admin APIs
These are APIs that expose database functionalities for the advanced user. These APIs are not enabled unless the `--web.enable-admin-api` is set.