模板参考

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 sample 等效于 index a 0
label label, sample string 等效于 index sample.Labels label
value sample interface{} 等效于 sample.Value
sortByLabel label, []samples []sample 按给定的标签对样本进行排序。是稳定的。

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

数字

名称 参数 返回 注释
humanize 数字或字符串 string 使用 公制前缀 将数字转换为更易读的格式。
humanize1024 数字或字符串 string 类似于 humanize，但使用 1024 作为基数而不是 1000。
humanizeDuration 数字或字符串 string 将以秒为单位的持续时间转换为更易读的格式。
humanizePercentage 数字或字符串 string 将比率值转换为 100 的分数。
humanizeTimestamp 数字或字符串 string 将以秒为单位的 Unix 时间戳转换为更易读的格式。
toTime 数字或字符串 *time.Time 将以秒为单位的 Unix 时间戳转换为 time.Time。

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

字符串

名称 参数 返回 注释
title string string cases.Title，将每个单词的首字母大写。
toUpper string string strings.ToUpper，将所有字符转换为大写。
toLower string string strings.ToLower，将所有字符转换为小写。
stripPort string string net.SplitHostPort，将字符串拆分为主机和端口，然后仅返回主机。
match pattern, text boolean regexp.MatchString 测试非锚定的正则表达式匹配。
reReplaceAll pattern, replacement, text string Regexp.ReplaceAllString 正则表达式替换，非锚定的。
graphLink expr string 返回 表达式浏览器 中表达式的图形视图路径。
tableLink expr string 返回 表达式浏览器 中表达式的表格（“Table”）视图路径。
parseDuration string float 将持续时间字符串（例如“1h”）解析为其表示的秒数。
stripDomain string string 删除 FQDN 的域部分。保持端口不变。

其他

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

本文档是开源的。请通过提交问题或拉取请求来帮助改进它。