控制台模板允许使用 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
的第三个参数的有效输出格式
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
的有效选项
PromConsole.NumberFormatter.humanize
:使用公制前缀格式化。PromConsole.NumberFormatter.humanizeNoSmallPrefix
:对于绝对值大于 1 的情况,使用公制前缀格式化。对于绝对值小于 1 的情况,格式化为 3 个有效数字。这对于避免 PromConsole.NumberFormatter.humanize
可能产生的毫查询/秒等单位很有用。PromConsole.NumberFormatter.humanize1024
:使用 1024 作为基数而不是 1000 格式化人可读的结果。本文档是开源的。请通过提交问题或拉取请求来帮助改进它。