查询基础

Prometheus 提供了一种名为 PromQL（Prometheus 查询语言）的功能性查询语言，允许用户实时选择和聚合时间序列数据。

当你向 Prometheus 发送查询请求时，它可以是即时查询（在某个时间点评估），或者是范围查询（在起始时间和结束时间之间以等间隔的步长评估）。PromQL 在这两种情况下工作方式完全相同；范围查询就像是在不同时间戳多次运行的即时查询。

在 Prometheus 用户界面中，“Table”选项卡用于即时查询，“Graph”选项卡用于范围查询。

其他程序可以通过HTTP API获取 PromQL 表达式的结果。

示例

本文档是 Prometheus 基本语言参考。为了学习方便，从一些示例开始可能更容易。

表达式语言数据类型

在 Prometheus 的表达式语言中，表达式或子表达式可以评估为以下四种类型之一：

• 即时向量 - 一组时间序列，其中每个时间序列包含一个单独的样本，所有样本共享相同的时间戳
• 范围向量 - 一组时间序列，其中每个时间序列包含一段时间内的数据点范围
• 标量 - 一个简单的浮点数值
• 字符串 - 一个简单的字符串值；目前未使用

根据使用场景（例如，在绘图或显示表达式输出时），只有其中一些类型作为用户指定表达式的结果是合法的。对于即时查询，上述任何数据类型都可以作为表达式的根。而范围查询只支持标量类型和即时向量类型的表达式。

关于实验性原生直方图的注意事项

• 摄取原生直方图必须通过功能标志启用。
• 一旦原生直方图被摄取到 TSDB 中（即使再次禁用该功能标志），即时向量和范围向量现在都可能包含的样本，不再是简单的浮点数（浮点样本），而是完整的直方图（直方图样本）。一个向量可以包含浮点样本和直方图样本的混合。请注意，PromQL 文档中“直方图样本”一词始终指原生直方图。经典直方图被分解为多个浮点样本序列。从 PromQL 的角度来看，没有“经典直方图样本”。
• 与浮点样本一样，直方图样本可以是计数器或仪表盘，分别称为计数器直方图或仪表盘直方图。
• 原生直方图可以有不同的桶布局，但它们通常可以转换为兼容版本，以便对其应用二进制和聚合操作。并非所有分桶模式都如此。如果在操作中遇到不兼容的直方图，则相应的输出向量元素将从结果中移除，并带有警告级别的注释。更多详细信息可以在原生直方图规范中找到。

字面量

字符串字面量

字符串字面量由单引号、双引号或反引号指定。

PromQL 遵循与Go 相同的转义规则。对于单引号或双引号中的字符串字面量，反斜杠表示转义序列的开始，其后可以是a、b、f、n、r、t、v 或 \。可以使用八进制（\nnn）或十六进制（\xnn、\unnnn 和 \Unnnnnnnn）表示法提供特定字符。

相反，用反引号指定的字符串字面量中不解析转义字符。重要的是要注意，与 Go 不同，Prometheus 不会丢弃反引号内的换行符。

示例

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

浮点字面量和时间持续量

标量浮点值可以写成字面整数或浮点数，格式如下（仅为提高可读性包含空格）：

[-+]?(
      [0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?
    | 0[xX][0-9a-fA-F]+
    | [nN][aA][nN]
    | [iI][nN][fF]
)

示例

23
-2.43
3.4e-9
0x8f
-Inf
NaN

此外，下划线（_）可用于十进制或十六进制数字之间，以提高可读性。

示例

1_000_000
.123_456_789
0x_53_AB_F3_82

浮点字面量也用于指定以秒为单位的持续时间。为方便起见，十进制整数可以与以下时间单位结合使用：

• ms – 毫秒
• s – 秒 – 1秒 等于 1000毫秒
• m – 分钟 – 1分钟 等于 60秒（忽略闰秒）
• h – 小时 – 1小时 等于 60分钟
• d – 天 – 1天 等于 24小时（忽略所谓的夏令时）
• w – 周 – 1周 等于 7天
• y – 年 – 1年 等于 365天（忽略闰日）

在十进制整数后加上上述单位之一，是裸浮点字面量等效秒数的另一种表示。

示例

1s # Equivalent to 1.
2m # Equivalent to 120.
1ms # Equivalent to 0.001.
-2h # Equivalent to -7200.

以下示例**不**起作用

0xABm # No suffixing of hexadecimal numbers.
1.5h # Time units cannot be combined with a floating point.
+Infd # No suffixing of ±Inf or NaN.

多个单位可以通过带后缀整数的串联来组合。单位必须按从长到短的顺序排列。每个浮点字面量中，给定单位只能出现一次。

示例

1h30m # Equivalent to 5400s and thus 5400.
12h34m56s # Equivalent to 45296s and thus 45296.
54s321ms # Equivalent to 54.321.

时间序列选择器

这些是 PromQL 获取数据的基本构建块。

即时向量选择器

即时向量选择器允许选择一组时间序列，以及在给定时间戳（时间点）下每个时间序列的单个样本值。最简单的形式是只指定一个指标名称，这将导致即时向量包含所有具有此指标名称的时间序列的元素。

返回的值将是查询评估时间戳（对于即时查询）或查询当前步骤（对于范围查询）时或之前最近的样本值。@ 修饰符允许覆盖选择发生的时间戳。时间序列仅在其最近的样本早于回溯周期时返回。

此示例选择所有具有 http_requests_total 指标名称的时间序列，并返回每个序列的最新样本：

http_requests_total

可以通过在花括号（{}）中添加逗号分隔的标签匹配器列表来进一步过滤这些时间序列。

此示例仅选择具有 http_requests_total 指标名称，且 job 标签设置为 prometheus 并且 group 标签设置为 canary 的时间序列。

http_requests_total{job="prometheus",group="canary"}

也可以对标签值进行负匹配，或根据正则表达式匹配标签值。存在以下标签匹配运算符：

• =: 选择与提供的字符串完全相等的标签。
• !=: 选择与提供的字符串不相等的标签。
• =~: 选择与提供的字符串正则表达式匹配的标签。
• !~: 选择与提供的字符串正则表达式不匹配的标签。

正则表达式匹配是完全锚定的。 env=~"foo" 的匹配被视为 env=~"^foo$"。

例如，这会选择所有针对 staging、testing 和 development 环境以及除 GET 以外的 HTTP 方法的 http_requests_total 时间序列。

http_requests_total{environment=~"staging|testing|development",method!="GET"}

匹配空标签值的标签匹配器还会选择所有根本未设置特定标签的时间序列。可以为同一个标签名称设置多个匹配器。

例如，给定数据集：

http_requests_total
http_requests_total{replica="rep-a"}
http_requests_total{replica="rep-b"}
http_requests_total{environment="development"}

查询 http_requests_total{environment=""} 将匹配并返回：

http_requests_total
http_requests_total{replica="rep-a"}
http_requests_total{replica="rep-b"}

并排除：

http_requests_total{environment="development"}

同一个标签名称可以使用多个匹配器；它们必须全部通过才能返回结果。

查询

http_requests_total{replica!="rep-a",replica=~"rep.*"}

则会匹配

http_requests_total{replica="rep-b"}

向量选择器必须指定一个名称，或者至少一个不匹配空字符串的标签匹配器。以下表达式是非法的：

{job=~".*"} # Bad!

相反，这些表达式是有效的，因为它们都有一个不匹配空标签值的选择器。

{job=~".+"}              # Good!
{job=~".*",method="get"} # Good!

标签匹配器也可以通过匹配内部的 __name__ 标签应用于指标名称。例如，表达式 http_requests_total 等同于 {__name__="http_requests_total"}。除了 =（!=、=~、!~）之外的匹配器也可以使用。以下表达式选择所有名称以 job: 开头的指标：

{__name__=~"job:.*"}

指标名称不能是 bool、on、ignoring、group_left 和 group_right 这些关键字之一。以下表达式是非法的：

on{} # Bad!

解决此限制的方法是使用 __name__ 标签：

{__name__="on"} # Good!

范围向量选择器

范围向量字面量的工作方式与即时向量字面量类似，不同之处在于它们从当前即时时间点开始向后选择一个范围的样本。在语法上，在向量选择器末尾的方括号（[]）中附加一个浮点字面量，以指定应为每个结果范围向量元素获取多少秒前的值。通常，浮点字面量使用带有一个或多个时间单位的语法，例如 [5m]。该范围是一个左开右闭区间，即与范围左边界时间戳重合的样本被排除在选择之外，而与范围右边界时间戳重合的样本被包含在选择之中。

在此示例中，我们选择所有具有指标名称 http_requests_total 且 job 标签设置为 prometheus 的时间序列中，5 分钟前记录的所有值。

http_requests_total{job="prometheus"}[5m]

偏移修饰符

offset 修饰符允许更改查询中单个即时向量和范围向量的时间偏移量。

例如，以下表达式返回 http_requests_total 相对于当前查询评估时间点，5 分钟前的值：

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)

当查询过去样本时，负偏移量将启用时间上的向前比较。

rate(http_requests_total[5m] offset -1w)

请注意，这允许查询超出其评估时间向前看。

@ 修饰符

@ 修饰符允许更改查询中单个即时向量和范围向量的评估时间。提供给 @ 修饰符的时间是一个 Unix 时间戳，并用浮点字面量描述。

例如，以下表达式返回 http_requests_total 在 2021-01-04T07:40:00+00:00 的值：

http_requests_total @ 1609746000

请注意，@ 修饰符必须紧跟在选择器之后，即以下写法是正确的：

sum(http_requests_total{method="GET"} @ 1609746000) // GOOD.

而以下写法是不正确的：

sum(http_requests_total{method="GET"}) @ 1609746000 // INVALID.

同样，对于范围向量也适用。这会返回 http_requests_total 在 2021-01-04T07:40:00+00:00 的 5 分钟速率。

rate(http_requests_total[5m] @ 1609746000)

@ 修饰符支持上述所有数字字面量表示。它与 offset 修饰符一起使用时，偏移量是相对于 @ 修饰符时间应用的。无论修饰符的顺序如何，结果都相同。

例如，以下两个查询将产生相同的结果：

# offset after @
http_requests_total @ 1609746000 offset 5m
# offset before @
http_requests_total offset 5m @ 1609746000

此外，start() 和 end() 也可以作为特殊值用于 @ 修饰符。

对于范围查询，它们分别解析为范围查询的起始时间和结束时间，并且在所有步骤中保持不变。

对于即时查询，start() 和 end() 都解析为评估时间。

http_requests_total @ start()
rate(http_requests_total[5m] @ end())

请注意，@ 修饰符允许查询超出其评估时间向前看。

子查询

子查询允许你针对给定的范围和分辨率运行即时查询。子查询的结果是一个范围向量。

语法：<instant_query> '[' <range> ':' [<resolution>] ']' [ @ <float_literal> ] [ offset <float_literal> ]

• <resolution> 是可选的。默认值为全局评估间隔。

运算符

Prometheus 支持许多二进制和聚合运算符。这些在表达式语言运算符页面中有详细描述。

函数

Prometheus 支持多种函数来操作数据。这些在表达式语言函数页面中有详细描述。

注释

PromQL 支持以 # 开头的行注释。示例：

    # This is a comment

正则表达式

Prometheus 中的所有正则表达式都使用RE2 语法。

正则表达式匹配始终是完全锚定的。

注意事项

陈旧性

在查询期间，采样数据的时间戳是独立于实际存在的时间序列数据选择的。这主要是为了支持聚合（sum、avg 等）等情况，其中多个聚合时间序列在时间上不精确对齐。由于它们的独立性，Prometheus 需要为每个相关时间序列在这些时间戳上分配一个值。它通过获取小于回溯周期前的最新样本来实现。回溯周期默认为 5 分钟，但可以通过--query.lookback-delta 标志进行设置。

如果目标抓取或规则评估不再返回之前存在的时间序列的样本，则此时间序列将被标记为陈旧。如果目标被移除，则先前检索到的时间序列将在移除后不久被标记为陈旧。

如果时间序列被标记为陈旧后，在某个采样时间戳评估查询，则不会返回该时间序列的任何值。如果随后为该时间序列摄取了新样本，它们将按预期返回。

当时间序列不再被导出或目标不再存在时，它将变为陈旧。此类时间序列将从其最新收集样本的时间点从图中消失，并且在被标记为陈旧后将不会在查询中返回。

一些导出器，它们在样本上添加自己的时间戳，会表现出不同的行为：停止导出的序列会保留最后一个值（默认为 5 分钟），然后才消失。track_timestamps_staleness 设置可以更改此行为。

避免慢查询和过载

如果查询需要操作大量数据，绘图可能会超时或使服务器或浏览器过载。因此，当构建针对未知数据的查询时，请始终在 Prometheus 表达式浏览器的表格视图中开始构建查询，直到结果集看起来合理（最多数百个，而不是数千个时间序列）。只有当您充分过滤或聚合了数据后，才切换到图表模式。如果表达式即时绘图仍然耗时过长，请通过记录规则对其进行预记录。

这对于 Prometheus 的查询语言尤为重要，其中像 api_http_requests_total 这样的裸指标名称选择器可能会扩展到数千个具有不同标签的时间序列。此外，请记住，即使输出仅是少量时间序列，聚合大量时间序列的表达式也会在服务器上产生负载。这类似于在关系数据库中对某一列的所有值求和会很慢，即使输出值只是一个数字。