Skip to content

Latest commit

 

History

History
141 lines (91 loc) · 5.83 KB

summary.md

File metadata and controls

141 lines (91 loc) · 5.83 KB
Raw

PromQL 基本使用

PromQL (Prometheus Query Language) 是 Prometheus 自己开发的数据查询 DSL 语言，语言表现力非常丰富，内置函数很多，在日常数据可视化以及rule 告警中都会使用到它。

在页面 http://localhost:9090/graph 中，输入下面的查询语句，查看结果，例如：

http_requests_total{code="200"}

字符串和数字

字符串: 在查询语句中，字符串往往作为查询条件 labels 的值，和 Golang 字符串语法一致，可以使用 "", '', 或者 ``, 格式如：

"this is a string"
'these are unescaped: \n \\ \t'
`these are not unescaped: \n ' " \t`

正数，浮点数: 表达式中可以使用正数或浮点数，例如：

3
-2.4

查询结果类型

PromQL 查询结果主要有 5 种类型：

  • 瞬时数据 (Instant vector): 包含一组时序，每个时序只有一个点，例如：http_requests_total
  • 区间数据 (Range vector): 包含一组时序，每个时序有多个点，例如：http_requests_total[5m]
  • 纯量数据 (Scalar): 纯量只有一个数字，没有时序，例如：count(http_requests_total)
  • 字符串（String）: 返回结果是一个字符串，例如 "hello"
  • 原生直方图（Native Histogram）: 返回的是原生直方图的多个bucket 的数据，这个是新增的类型，相对以前将 Histogram 存储为多个指标，原生直方图将数据存储为一个指标。

查询条件

Prometheus 存储的是时序数据，而它的时序是由名字和一组标签构成的，其实名字也可以写出标签的形式，例如 http_requests_total 等价于 {name="http_requests_total"}。

一个简单的查询相当于是对各种标签的筛选，例如：

http_requests_total{code="200"} // 表示查询名字为 http_requests_total，code 为 "200" 的数据

查询条件支持正则匹配，例如：

http_requests_total{code!="200"}  // 表示查询 code 不为 "200" 的数据
http_requests_total{code=～"2.."} // 表示查询 code 为 "2xx" 的数据
http_requests_total{code!～"2.."} // 表示查询 code 不为 "2xx" 的数据

操作符

Prometheus 查询语句中，支持常见的各种表达式操作符，例如

算术运算符:

支持的算术运算符有 +，-，*，/，%，^, 例如 http_requests_total * 2 表示将 http_requests_total 所有数据 double 一倍。

比较运算符:

支持的比较运算符有 ==，!=，>，<，>=，<=, 例如 http_requests_total > 100 表示 http_requests_total 结果中大于 100 的数据。

逻辑运算符:

支持的逻辑运算符有 and，or，unless, 例如 http_requests_total == 5 or http_requests_total == 2 表示 http_requests_total 结果中等于 5 或者 2 的数据。

聚合运算符:

支持的聚合运算符有 sum，min，max，avg，stddev，stdvar，count，count_values，bottomk，topk，quantile，, 例如 max(http_requests_total) 表示 http_requests_total 结果中最大的数据。

注意，和四则运算类型，Prometheus 的运算符也有优先级，它们遵从（^）> (*, /, %) > (+, -) > (==, !=, <=, <, >=, >) > (and, unless) > (or) 的原则。

修改评估时间

  • offset 操作符

offset 表示指标评估时间往前倒推一定时间，比如 http_requests_total offset 5m 的瞬时查询，返回结果为 http_requests_total 5分钟前的数据。

offset 操作符应该作用于指标的选择，而不是函数/聚合等计算过程。

所以 sum(http_requests_total{method="GET"}) offset 5m 会报错，正确写法为 sum(http_requests_total{method="GET"} offset 5m)

  • @ 操作符

@ 操作符和 offset 作用类似，都可以修改指标评估的时间，但是 @ 是一个更精确的控制，直接指定返回某个时刻的查询结果，当然它和 offset 类似，也都是作用于指标查找，而不是函数和聚合计算。

比如 http_requests_total @ 1609746000 返回的就是 1609746000 的数据，时间戳为 unix 时间戳，float 类型，单位 s，通过小数点来控制 ms。

子查询

子查询语法为：<instant_query> '[' <range> ':' [<resolution>] ']' [ @ <float_literal> ] [ offset <duration> ]

例如：rate(http_requests_total[5m])[1h:] 表示以5分钟为粒度的 rate 评估间隔，最近1h内的数据，默认解析度等于全局 rule 评估间隔，比如是 15s，所以该查询返回的值是一个 range vector，而且包含了 240个点。

可以调整解析度，例如 rate(http_requests_total[5m])[1h:1m] 就将解析度从默认15s，变成 1m 中。

子查询可以与其他函数配合使用，尤其是基于时间维度的聚合函数，例如：

max_over_time(
  rate(
    http_requests_total[5m]
  )[1h:]
)

内置函数

Prometheus 内置不少函数，方便查询以及数据格式化，例如将结果由浮点数转为整数的 floor 和 ceil，

floor(avg(http_requests_total{code="200"}))
ceil(avg(http_requests_total{code="200"}))

查看 http_requests_total 5分钟内，平均每秒数据

rate(http_requests_total[5m])

为了方便记忆，我们可以将这些函数进行简单归类。

  • Counter ：rate、irate、increase、resets。
  • Gauge：delta、idelta、deriv、predict_linear、holt_winters。
  • Histogram： histogram_quantile。
  • Native Histogram： histogram_count、histogram_sum、histogram_fraction、histogram_stddev、histogram_stdvar。
  • 时间聚合：_over_time()，比如 avg_over_time、max_over_time。
  • 时间函数：time、timestamp、minute、hour、month 等。
  • 数学函数： abs、ceil、exp、floor、ln、log2、log10 等。
  • 三角函数： acos、acosh 等。
  • No Data： absent、absent_over_time。
  • scalar 和 vector 互转： scalar、vector。
  • 指标标签修改： label_join、label_replace。

更多请参见详情。