控制台模板
控制台模板允许使用 Go 模板语言 创建任意控制台。这些由 Prometheus 服务器提供服务。
控制台模板是创建易于在源代码控制中管理的模板的最强大方法。但它需要一定的学习曲线,因此新用户应首先尝试 Grafana。
入门
Prometheus 提供了一套示例控制台供您入门。在运行的 Prometheus 上,您可以在 /consoles/index.html.example 找到它们。如果 Prometheus 正在抓取带有 job="node" 标签的 Node Exporter,它们将显示 Node Exporter 的控制台。
示例控制台包含 5 个部分
- 顶部的导航栏
- 左侧的菜单
- 底部的时间控件
- 中间的主内容,通常是图表
- 右侧的表格
导航栏用于链接到其他系统,例如其他 Prometheus 1、文档以及任何其他您认为有用的系统。菜单用于导航同一 Prometheus 服务器内部,这对于能够快速在另一个选项卡中打开控制台以关联信息非常有用。两者都在 console_libraries/menu.lib 中配置。
时间控件允许更改图表的持续时间和范围。控制台 URL 可以共享,并将向他人显示相同的图表。
主内容通常是图表。提供了一个可配置的 JavaScript 图表库,该库将处理从 Prometheus 请求数据,并通过 Rickshaw 进行渲染。
最后,右侧的表格可以用来以比图表更紧凑的形式显示统计信息。
示例控制台
这是一个基本的控制台。它显示任务数量、有多少任务正在运行、平均 CPU 使用率以及右侧表格中的平均内存使用量。主内容有一个每秒查询次数的图表。
{{template "head" .}}
{{template "prom_right_table_head"}}
<tr>
<th>MyJob</th>
<th>{{ template "prom_query_drilldown" (args "sum(up{job='myjob'})") }}
/ {{ template "prom_query_drilldown" (args "count(up{job='myjob'})") }}
</th>
</tr>
<tr>
<td>CPU</td>
<td>{{ template "prom_query_drilldown" (args
"avg by(job)(rate(process_cpu_seconds_total{job='myjob'}[5m]))"
"s/s" "humanizeNoSmallPrefix") }}
</td>
</tr>
<tr>
<td>Memory</td>
<td>{{ template "prom_query_drilldown" (args
"avg by(job)(process_resident_memory_bytes{job='myjob'})"
"B" "humanize1024") }}
</td>
</tr>
{{template "prom_right_table_tail"}}
{{template "prom_content_head" .}}
<h1>MyJob</h1>
<h3>Queries</h3>
<div id="queryGraph"></div>
<script>
new PromConsole.Graph({
node: document.querySelector("#queryGraph"),
expr: "sum(rate(http_query_count{job='myjob'}[5m]))",
name: "Queries",
yAxisFormatter: PromConsole.NumberFormatter.humanizeNoSmallPrefix,
yHoverFormatter: PromConsole.NumberFormatter.humanizeNoSmallPrefix,
yUnits: "/s",
yTitle: "Queries"
})
</script>
{{template "prom_content_tail" .}}
{{template "tail"}}
prom_right_table_head 和 prom_right_table_tail 模板包含右侧表格。这是可选的。
prom_query_drilldown 是一个模板,它将评估传递给它的表达式,对其进行格式化,并链接到 表达式浏览器 中的表达式。第一个参数是表达式。第二个参数是要使用的单位。第三个参数是输出的格式。只需要第一个参数。
prom_query_drilldown 的第三个参数的有效输出格式
- 未指定:默认 Go 显示输出。
humanize:使用 度量前缀 显示结果。humanizeNoSmallPrefix:对于大于 1 的绝对值,使用 度量前缀 显示结果。对于小于 1 的绝对值,显示 3 位有效数字。这有助于避免humanize产生的“每秒毫克查询”等单位。humanize1024:使用 1024 为基数而不是 1000 来显示人类可读的结果。这通常与B一起用作第二个参数,以生成KiB和MiB等单位。printf.3g:显示 3 位有效数字。
可以定义自定义格式。有关示例,请参阅 prom.lib 。
图表库
图表库的调用方式是:
<div id="queryGraph"></div>
<script>
new PromConsole.Graph({
node: document.querySelector("#queryGraph"),
expr: "sum(rate(http_query_count{job='myjob'}[5m]))"
})
</script>
head 模板加载所需的 Javascript 和 CSS。
传递给图表库的参数
| 名称 | 描述 |
|---|---|
| expr | 必需。要绘制的表达式。可以是列表。 |
| node | 必需。要渲染到的 DOM 节点。 |
| duration | 可选。图表的持续时间。默认为 1 小时。 |
| endTime | 可选。图表结束的 Unix 时间戳。默认为当前时间。 |
| width | 可选。图表的宽度,不包括标题。默认为自动检测。 |
| height | 可选。图表的高度,不包括标题和图例。默认为 200 像素。 |
| min | 可选。X 轴的最小值。默认为最低数据值。 |
| max | 可选。Y 轴的最大值。默认为最高数据值。 |
| renderer | 可选。图表的类型。选项为 line(折线图)和 area(堆积图)。默认为 line。 |
| name | 可选。图例和悬停详细信息中绘图的标题。如果传递字符串,[[ label ]] 将被标签值替换。如果传递函数,它将接收一个标签映射并应返回名称字符串。可以是列表。 |
| xTitle | 可选。X 轴的标题。默认为 Time。 |
| yUnits | 可选。Y 轴的单位。默认为空。 |
| yTitle | 可选。Y 轴的标题。默认为空。 |
| yAxisFormatter | 可选。Y 轴的数字格式化器。默认为 PromConsole.NumberFormatter.humanize。 |
| yHoverFormatter | 可选。悬停详细信息的数字格式化器。默认为 PromConsole.NumberFormatter.humanizeExact。 |
| colorScheme | 可选。绘图使用的颜色方案。可以是十六进制颜色代码列表,也可以是 Rickshaw 支持的 颜色方案名称 之一。默认为 'colorwheel'。 |
如果 expr 和 name 都是列表,则它们必须长度相同。名称将应用于对应表达式的绘图。
yAxisFormatter 和 yHoverFormatter 的有效选项