控制台模板 | Prometheus - Prometheus 监控系统

入门指南
示例控制台
图形库

控制台模板允许使用 Go 模板语言创建任意控制台。这些控制台从 Prometheus 服务器提供。

控制台模板是创建可轻松在源代码控制中管理的模板的最强大方式。不过，它存在一个学习曲线，因此初次接触这种监控方式的用户应该首先尝试 Grafana。

入门

Prometheus 附带了一组示例控制台，可帮助您入门。这些控制台可在运行中的 Prometheus 上的 /consoles/index.html.example 找到，如果 Prometheus 正在抓取带有 job="node" 标签的 Node Exporters，则会显示 Node Exporter 控制台。

示例控制台有 5 个部分

顶部的导航栏
左侧的菜单
底部的时钟控件
中间的主要内容，通常是图形
右侧的表格

导航栏用于链接到其他系统，例如其他 Prometheus ¹、文档以及您认为有意义的任何其他内容。菜单用于在同一 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 的有效选项

PromConsole.NumberFormatter.humanize：使用度量前缀格式化。
PromConsole.NumberFormatter.humanizeNoSmallPrefix：对于大于 1 的绝对值，使用度量前缀格式化。对于小于 1 的绝对值，使用 3 位有效数字格式化。这对于避免诸如 PromConsole.NumberFormatter.humanize 可能产生的每秒毫查询单位之类的单位非常有用。
PromConsole.NumberFormatter.humanize1024：使用 1024 而不是 1000 的基数格式化人性化的结果。

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