在 HTTP API 中使用 PromQL

Prometheus 当前稳定的 HTTP API 可以通过 /api/v1 访问。

API 响应格式

Prometheus API 使用了 JSON 格式的响应内容。 当 API 调用成功后将会返回 2xx 的 HTTP 状态码。

反之,当 API 调用失败时可能返回以下几种不同的HTTP状态码:

  • 404 Bad Request:当参数错误或者缺失时。
  • 422 Unprocessable Entity 当表达式无法执行时。
  • 503 Service Unavailiable 当请求超时或者被中断时。

所有的API请求均使用以下的JSON格式:

  1. {
  2. "status": "success" | "error",
  3. "data": <data>,
  4. // Only set if status is "error". The data field may still hold
  5. // additional data.
  6. "errorType": "<string>",
  7. "error": "<string>"
  8. }

在 HTTP API 中使用 PromQL

通过 HTTP API 我们可以分别通过 /api/v1/query 和 /api/v1/query_range 查询 PromQL 表达式当前或者一定时间范围内的计算结果。

瞬时数据查询

通过使用 QUERY API 我们可以查询 PromQL 在特定时间点下的计算结果。

  1. GET /api/v1/query

URL请求参数:

  • query=:PromQL 表达式。
  • time=:用于指定用于计算 PromQL 的时间戳。可选参数,默认情况下使用当前系统时间。
  • timeout=:超时设置。可选参数,默认情况下使用 -query,timeout 的全局设置。

例如使用以下表达式查询表达式 up 在时间点 2015-07-01T20:10:51.781Z 的计算结果:

  1. $ curl 'http://localhost:9090/api/v1/query?query=up&time=2015-07-01T20:10:51.781Z'
  2. {
  3. "status" : "success",
  4. "data" : {
  5. "resultType" : "vector",
  6. "result" : [
  7. {
  8. "metric" : {
  9. "__name__" : "up",
  10. "job" : "prometheus",
  11. "instance" : "localhost:9090"
  12. },
  13. "value": [ 1435781451.781, "1" ]
  14. },
  15. {
  16. "metric" : {
  17. "__name__" : "up",
  18. "job" : "node",
  19. "instance" : "localhost:9100"
  20. },
  21. "value" : [ 1435781451.781, "0" ]
  22. }
  23. ]
  24. }
  25. }

响应数据类型

当 API 调用成功后,Prometheus 会返回 JSON 格式的响应内容,格式如上小节所示。并且在data节点中返回查询结果。data 节点格式如下:

  1. {
  2. "resultType": "matrix" | "vector" | "scalar" | "string",
  3. "result": <value>
  4. }

PromQL表达式可能返回多种数据类型,在响应内容中使用resultType表示当前返回的数据类型,包括:

  • 瞬时向量:vector

当返回数据类型resultType为vector时,result响应格式如下:

  1. [
  2. {
  3. "metric": { "<label_name>": "<label_value>", ... },
  4. "value": [ <unix_time>, "<sample_value>" ]
  5. },
  6. ...
  7. ]

其中metrics表示当前时间序列的特征维度,value只包含一个唯一的样本。

  • 区间向量:matrix

当返回数据类型resultType为matrix时,result响应格式如下:

  1. [
  2. {
  3. "metric": { "<label_name>": "<label_value>", ... },
  4. "values": [ [ <unix_time>, "<sample_value>" ], ... ]
  5. },
  6. ...
  7. ]

其中metrics表示当前时间序列的特征维度,values包含当前事件序列的一组样本。

  • 标量:scalar

当返回数据类型resultType为scalar时,result响应格式如下:

  1. [ <unix_time>, "<scalar_value>" ]

由于标量不存在时间序列一说,因此result表示为当前系统时间一个标量的值。

  • 字符串:string

当返回数据类型resultType为string时,result响应格式如下:

  1. [ <unix_time>, "<string_value>" ]

字符串类型的响应内容格式和标量相同。

区间数据查询

使用QUERY_RANGE API我们则可以直接查询PromQL表达式在一段时间返回内的计算结果。

  1. GET /api/v1/query_range

URL请求参数:

  • query=: PromQL表达式。
  • start=: 起始时间。
  • end=: 结束时间。
  • step=: 查询步长。
  • timeout=: 超时设置。可选参数,默认情况下使用-query,timeout的全局设置。

当使用QUERY_RANGE API查询PromQL表达式时,返回结果一定是一个区间向量:

  1. {
  2. "resultType": "matrix",
  3. "result": <value>
  4. }

需要注意的是,在QUERY_RANGE API中PromQL只能使用瞬时向量选择器类型的表达式。

例如使用以下表达式查询表达式up在30秒范围内以15秒为间隔计算PromQL表达式的结果。

  1. $ 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'
  2. {
  3. "status" : "success",
  4. "data" : {
  5. "resultType" : "matrix",
  6. "result" : [
  7. {
  8. "metric" : {
  9. "__name__" : "up",
  10. "job" : "prometheus",
  11. "instance" : "localhost:9090"
  12. },
  13. "values" : [
  14. [ 1435781430.781, "1" ],
  15. [ 1435781445.781, "1" ],
  16. [ 1435781460.781, "1" ]
  17. ]
  18. },
  19. {
  20. "metric" : {
  21. "__name__" : "up",
  22. "job" : "node",
  23. "instance" : "localhost:9091"
  24. },
  25. "values" : [
  26. [ 1435781430.781, "0" ],
  27. [ 1435781445.781, "0" ],
  28. [ 1435781460.781, "1" ]
  29. ]
  30. }
  31. ]
  32. }
  33. }