模板参考

Prometheus 支持在告警的注解和标签以及所提供的控制台页面中使用模板。模板能够对本地数据库运行查询、遍历数据、使用条件、格式化数据等。Prometheus 模板语言基于 Go 模板系统。

数据结构

处理时间序列数据的主要数据结构是样本，定义为

type sample struct {
  Labels map[string]string
  Value  interface{}
}

样本的指标名称编码在 Labels 映射中的一个特殊 __name__ 标签中。

[]sample 表示样本列表。

Go 中的 interface{} 类似于 C 中的 void 指针。

函数

除了 Go 模板提供的默认函数之外，Prometheus 还提供了用于在模板中更轻松地处理查询结果的函数。

如果函数在管道中使用，管道值将作为最后一个参数传递。

查询

名称	参数	返回	备注
query	查询字符串	[]sample	查询数据库，不支持返回范围向量。
first	[]sample	样本	等同于 `index a 0`
label	标签，样本	字符串	等同于 `index sample.Labels label`
value	样本	interface{}	等同于 `sample.Value`
sortByLabel	标签, []samples	[]sample	根据给定的标签对样本进行排序。排序是稳定的。

first、label 和 value 旨在使查询结果在管道中易于使用。

数字

名称	参数	返回	备注
humanize	数字或字符串	字符串	使用公制前缀将数字转换为更易读的格式。
humanize1024	数字或字符串	字符串	与 `humanize` 类似，但使用 1024 作为基数而不是 1000。
humanizeDuration	数字或字符串	字符串	将以秒为单位的持续时间转换为更易读的格式。
humanizePercentage	数字或字符串	字符串	将比率值转换为百分比。
humanizeTimestamp	数字或字符串	字符串	将以秒为单位的 Unix 时间戳转换为更易读的格式。
toTime	数字或字符串	*time.Time	将以秒为单位的 Unix 时间戳转换为 time.Time。
toDuration	数字或字符串	*time.Duration	将以秒为单位的持续时间转换为 time.Duration。
now	无	float64	返回模板评估时的 Unix 时间戳（以秒为单位）。

人性化函数旨在为人类消费产生合理的输出，并且不保证在 Prometheus 版本之间返回相同的结果。

字符串

名称	参数	返回	备注
title	字符串	字符串	cases.Title ，将每个单词的首字母大写。
toUpper	字符串	字符串	strings.ToUpper ，将所有字符转换为大写。
toLower	字符串	字符串	strings.ToLower ，将所有字符转换为小写。
stripPort	字符串	字符串	net.SplitHostPort ，将字符串拆分为主机和端口，然后仅返回主机。
match	模式，文本	布尔值	regexp.MatchString 测试非锚定的正则表达式匹配。
reReplaceAll	模式, 替换, 文本	字符串	Regexp.ReplaceAllString 正则表达式替换，非锚定。
graphLink	expr	字符串	返回表达式浏览器中表达式的图形视图路径。
tableLink	expr	字符串	返回表达式浏览器中表达式的表格（“Table”）视图路径。
parseDuration	字符串	浮点数	将持续时间字符串（如“1h”）解析为其表示的秒数。
stripDomain	字符串	字符串	移除 FQDN 的域名部分。端口保持不变。
urlQueryEscape	字符串	字符串	url.QueryEscape 转义字符串，使其可以安全地放置在 URL 查询中。

其他

名称	参数	返回	备注
args	[]interface{}	map[string]interface{}	这将对象列表转换为一个带有 arg0、arg1 等键的映射。这旨在允许多个参数传递给模板。
tmpl	字符串, []interface{}	无	与内置的 `template` 类似，但允许非字面量作为模板名称。请注意，结果被假定为安全的，并且不会被自动转义。仅在控制台中可用。
safeHtml	字符串	字符串	将字符串标记为不需要自动转义的 HTML。
externalURL	无	字符串	Prometheus 外部可访问的外部 URL。
pathPrefix	无	字符串	用于控制台模板的外部 URL 路径。

模板类型差异

每种模板类型都提供不同的信息，可用于参数化模板，并有一些其他差异。

告警字段模板

.Value、.Labels、.ExternalLabels 和 .ExternalURL 分别包含告警值、告警标签、全局配置的外部标签和外部 URL（使用 --web.external-url 配置）。为方便起见，它们也作为 $value、$labels、$externalLabels 和 $externalURL 变量公开。

控制台模板

控制台在 /consoles/ 上公开，其源自 -web.console.templates 标志指向的目录。

控制台模板使用 html/template 进行渲染，该模板提供自动转义。要绕过自动转义，请使用 safe* 函数。

URL 参数在 .Params 中以映射的形式提供。要按相同名称访问多个 URL 参数，.RawParams 是每个参数的列表值映射。URL 路径在 .Path 中可用，不包括 /consoles/ 前缀。全局配置的外部标签可用作 .ExternalLabels。所有这四个也都有方便的变量：$rawParams、$params、$path 和 $externalLabels。

控制台还可以访问在 -web.console.libraries 标志指向的目录中的 *.lib 文件中找到的所有使用 {{define "templateName"}}...{{end}} 定义的模板。由于这是一个共享命名空间，请注意避免与其他用户发生冲突。以 prom、_prom 和 __ 开头的模板名称保留给 Prometheus 使用，上述函数也是如此。

本页内容