Prometheus提供一个函数式的表达式语言PromQL (Prometheus Query Language),可以使用户实时地查找和聚合时间序列数据。表达式计算结果可以在图表中展示,也可以在Prometheus表达式浏览器中以表格形式展示,或者作为数据源, 以HTTP API的方式提供给外部系统使用。
一、例子
本文档仅供参考。 对于学习,从几个例子开始可能更容易。
二、表达式语言数据类型
在Prometheus的表达式语言中,任何表达式或者子表达式都可以归为四种类型:
-
instant vector
瞬时向量 - 它是指在同一时刻,抓取的所有度量指标数据。这些度量指标数据的key都是相同的,也即相同的时间戳。 -
range vector
范围向量 - 它是指在任何一个时间范围内,抓取的所有度量指标数据。 -
scalar
标量 - 一个简单的浮点值 -
string
字符串 - 一个当前没有被使用的简单字符串
依赖于使用场景(例如:图表 vs. 表格),根据用户所写的表达式,仅仅只有一部分类型才适用这种表达式。例如:瞬时向量类型是唯一可以直接在图表中使用的。
三、字面量
3.1 字符串字面量
字符串可以用单引号,双引号或反引号指定为文字。
PromQL遵循与Go相同的转义规则。在单引号,双引号中,反斜杠成为了转义字符,后面可以跟着a
,b
, f
, n
, r
, t
, v
或者\
。 可以使用八进制(\nnn
)或者十六进制(\xnn
, \unnnn
和\Unnnnnnnn
)提供特定字符。
在反引号内不处理转义字符。与Go不同,Prom不会丢弃反引号中的换行符。例如:
"this is a string"
'these are unescaped: \n \\ \t'
`these are not unescaped: \n ' " \t"'`
3.2 浮点数字面量
标量浮点值可以直接写成形式[-](digits)[.(digits)]
。
-2.43
四、时间序列选择器
4.1 瞬时向量选择器
瞬时向量选择器允许在给定时间戳(即时)为每个选择一组时间序列和单个样本值:在最简单的形式中,仅指定度量名称。 这会生成包含具有此度量标准名称的所有时间序列的元素的即时向量。
下面这个例子选择所有时间序列度量名称为http_requests_total
的样本数据:
http_requests_total
通过在度量指标后面增加{}一组标签可以进一步地过滤这些时间序列数据。
此示例仅选择具有http_requests_total
度量标准名称的时间系列,该名称也将作业标签设置为prometheus
,并将其group
标签设置为canary
:
http_requests_total{job="prometheus",group="canary"}
可以采用不匹配的标签值也是可以的,或者用正则表达式不匹配标签。标签匹配操作如下所示:
-
=
: 精确地匹配标签给定的值 -
!=
: 不等于给定的标签值 -
=~
: 正则表达匹配给定的标签值 -
!~
: 给定的标签值不符合正则表达式
例如:度量指标名称为http_requests_total
,正则表达式匹配标签environment
为staging, testing, development
的值,且http请求方法不等于GET
。
http_requests_total{environment=~"staging|testing|development", method!="GET"}
匹配空标签值的标签匹配器也可以选择没有设置任何标签的所有时间序列数据。正则表达式完全匹配。 可以为同一标签名称提供多个匹配器。
向量选择器必须指定一个名称或至少一个与空字符串不匹配的标签匹配器。 以下表达式是非法的:
{job=~".*"} #Bad!
相反,这些表达式是有效的,因为它们都有一个与空标签值不匹配的选择器。
{job=~".+"} # Good!
{job=~".*", method="get"} # Good!
标签匹配器能够被应用到度量指标名称,使用__name__
标签筛选度量指标名称。例如:表达式http_requests_total
等价于{__name__="http_requests_total"}
。 其他的匹配器,如:= ( !=, =~, !~)
都可以使用>
。下面的表达式选择了度量指标名称以job:
开头的时间序列数据:
{__name__=~"^job:.*"}
Prometheus中的所有正则表达式都使用RE2语法。
4.2 范围向量选择器
范围向量文字像即时向量文字一样工作,除了它们从当前时刻选择一系列样本。 在语法上,范围持续时间附加在向量选择器末尾的方括号([]
)中,以指定应为每个结果范围向量元素提取多长时间值。
持续时间指定为数字,紧接着是以下单位之一:
-
s
- seconds -
m
- minutes -
h
- hours -
d
- days -
w
- weeks -
y
- years
在此示例中,我们选择在过去5分钟内为度量标准名称为http_requests_total
且job
标签设置为prometheus
的所有时间序列记录的所有值:
http_requests_total{job="prometheus"}[5m]
4.3 偏移修饰符
这个offset
偏移修饰符允许在查询中改变单个瞬时向量和范围向量中的时间偏移
例如,以下表达式返回过去相对于当前查询评估时间5分钟的http_requests_total
值:
http_requests_total offset 5m
注意:offset
偏移修饰符必须直接跟在选择器后面,例如:以下是正确的:
sum(http_requests_total{method="GET"} offset 5m) // GOOD.
然而,下面这种情况是不正确的:
sum(http_requests_total{method="GET"}) offset 5m // INVALID.
同样适用于范围向量。 这将返回http_requests_total
一周前的5分钟费率:
rate(http_requests_total[5m] offset 1w)
五、子查询
子查询允许您针对给定范围和分辨率运行即时查询。 子查询的结果是范围向量。
语法:
-
是可选的。 默认值是全局评估间隔。
六、操作符
Prometheus支持二元和聚合操作符。详见表达式语言操作符
七、函数
Prometheus提供了一些函数列表操作时间序列数据。详见表达式语言函数
八、陷阱
8.1 Staleness
运行查询时,独立于实际当前时间序列数据选择采样数据的时间戳。这主要是为了支持聚合(总和,平均等)这样的情况,其中多个聚合时间序列在时间上不完全对齐。由于它们的独立性,Prometheus需要在每个相关时间序列的时间戳上分配值。它只需在此时间戳之前采用最新的样本即可。
如果目标抓取或规则评估不再返回先前存在的时间序列的样本,则该时间序列将被标记为陈旧。如果目标被移除,之前很快就会将其先前返回的时间序列标记为陈旧。
如果在时间序列标记为过时后在采样时间戳处评估查询,则不会为该时间系列返回任何值。如果随后在该时间序列中摄取新样本,它们将照常返回。
如果在采样时间戳前5分钟未找到任何样本(默认情况下),则此时间点不返回该时间序列的值。这实际上意味着时间序列在其最新收集的样本超过5分钟或标记为陈旧之后从图表“消失”。
对于在其抓取中包含时间戳的时间序列,不会标记陈旧性。在这种情况下,仅应用5分钟的阈值。
8.2 避免慢查询和重载
如果查询需要对大量数据进行操作,则绘制图表可能会超时或使服务器或浏览器过载。因此,在构建对未知数据的查询时,始终在Prometheus表达式浏览器的表格视图中开始构建查询,直到结果集看起来合理(最多数百个,而不是数千个时间序列)。只有在您充分过滤或汇总数据后,才能切换到图表模式。如果表达式仍然需要很长时间来绘制ad-hoc图形,请通过录制规则预先录制它。
这与Prometheus的查询语言尤其相关,其中像api_http_requests_total
这样的简单度量标准名称选择器可以扩展到具有不同标签的数千个时间序列。还要记住,即使输出只是少量的时间序列,聚合在许多时间序列上的表达式也会在服务器上产生负载。这类似于在关系数据库中对列的所有值求和的速度很慢,即使输出值只是一个数字。
九、链接
Prometheus官网地址:https://prometheus.io/
我的Github:https://github.com/Alrights/prometheus