控制台模板

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

控制台模板是创建模板的最强大方式，可以轻松地在源代码控制中进行管理。但是，它有一定的学习曲线，因此刚接触这种监控风格的用户应首先尝试 Grafana。

开始使用

Prometheus 自带了一套示例控制台来帮助你入门。这些可以在运行中的 Prometheus 的 /consoles/index.html.example 路径下找到，如果 Prometheus 正在抓取带有 job="node" 标签的 Node Exporter，它将显示 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	必需。要绘制图表的表达式。可以是一个列表。
节点	必需。要渲染到的 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 作为基数来格式化人性化的结果。

本页内容