HTTP API
在HTTP API 中使用PromQL
我们不仅仅可以在
我们看下
- GET /api/v1/query
- GET /api/v1/query_range
- GET /api/v1/series
- GET /api/v1/label/<label_name>/values
- GET /api/v1/targets
- GET /api/v1/rules
- GET /api/v1/alerts
- GET /api/v1/targets/metadata
- GET /api/v1/alertmanagers
- GET /api/v1/status/config
- GET /api/v1/status/flags
从
- POST /api/v1/admin/tsdb/snapshot
- POST /api/v1/admin/tsdb/delete_series
- POST /api/v1/admin/tsdb/clean_tombstones
API 响应格式
反之,当
- 404 Bad Request:当参数错误或者缺失时。
422 Unprocessable Entity 当表达式无法执行时。503 Service Unavailiable 当请求超时或者被中断时。
所有的
{
"status": "success" | "error",
"data": <data>,
// Only set if status is "error". The data field may still hold
// additional data.
"errorType": "<string>",
"error": "<string>"
}
在HTTP API 中使用PromQL
通过
瞬时数据查询
通过使用
GET /api/v1/query
- query=
: PromQL 表达式。 - time=<rfc3339 | unix_timestamp>:用于指定用于计算
PromQL 的时间戳。可选参数,默认情况下使用当前系统时间。 - timeout=
:超时设置。可选参数,默认情况下使用 -query,timeout 的全局设置。
例如使用以下表达式查询表达式
$ curl 'http://localhost:9090/api/v1/query?query=up'
{
"status" : "success",
"data" : {
"resultType" : "vector",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"value": [ 1435781451.781, "1" ]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9100"
},
"value" : [ 1435781451.781, "0" ]
}
]
}
}
响应数据类型
当
{
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
}
- 瞬时向量:vector
当返回数据类型
[
{
"metric": { "<label_name>": "<label_value>", ... },
"value": [ <unix_time>, "<sample_value>" ]
},
...
]
其中
- 区间向量:matrix
当返回数据类型
[
{
"metric": { "<label_name>": "<label_value>", ... },
"values": [ [ <unix_time>, "<sample_value>" ], ... ]
},
...
]
其中
- 标量:scalar
当返回数据类型
[ <unix_time>, "<scalar_value>" ]
由于标量不存在时间序列一说,因此
- 字符串:string
当返回数据类型
[ <unix_time>, "<string_value>" ]
字符串类型的响应内容格式和标量相同。
区间数据查询
使用
GET /api/v1/query_range
query= : PromQL 表达式。start=<rfc3339 | unix_timestamp>: 起始时间。end=<rfc3339 | unix_timestamp>: 结束时间。step= : 查询步长。timeout= : 超时设置。可选参数,默认情况下使用-query,timeout 的全局设置。
当使用
{
"resultType": "matrix",
"result": <value>
}
需要注意的是,在
QUERY_RANGE API 中PromQL 只能使用瞬时向量选择器类型的表达式。
例如使用以下表达式查询表达式
$ curl 'http://localhost:9090/api/v1/query_range?query=up&start=2015-07-01T20:10:30.781Z&end=2015-07-01T20:11:00.781Z&step=15s'
{
"status" : "success",
"data" : {
"resultType" : "matrix",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"values" : [
[ 1435781430.781, "1" ],
[ 1435781445.781, "1" ],
[ 1435781460.781, "1" ]
]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9091"
},
"values" : [
[ 1435781430.781, "0" ],
[ 1435781445.781, "0" ],
[ 1435781460.781, "1" ]
]
}
]
}
}