控制台模版

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

控制台模板是创建可以轻松在版本控制系统中管理的模板的最强大方式。不过，它的学习曲线可能有些陡峭，因此对于刚开始接触这种监控风格的新用户，建议先尝试使用 Grafana。

开始使用

Prometheus 自带了一组示例控制台来帮助你上手。如果 Prometheus 使用job="node"标签抓取 Node Exporters 的话，这些可以在运行中的 Prometheus 的/consoles/index.html.example路径找到，并会在 Prometheus 正在抓取 Node Exporters 时显示 Node Exporter 控制台。

示例控制台包含以下5部分：

1. 顶部的导航栏
2. 左侧的菜单
3. 底部的时间控制
4. 中间的主内容区域，通常包含图表
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位有效数字。这对于避免产生如每秒毫访问量这样的单位非常有用。
• 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和name都是列表，它们必须具有相同的长度。名称将应用于对应表达式的图。

yAxisFormatter和yHoverFormatter的有效选项：

• PromConsole.NumberFormatter.humanize：使用指标单位前缀格式化。
• PromConsole.NumberFormatter.humanizeNoSmallPrefix：对于绝对值大于 1 的结果，使用指标单位前缀格式化。对于绝对值小于1的结果，格式化为3位有效数字。这对于避免产生如每秒毫询问量这样的单位非常有用。
• PromConsole.NumberFormatter.humanize1024：以1024为基数而非1000格式化人类化的结果。通常与B作为第二个参数一起使用，以产生如KiB和MiB这样的单位。

printf.3g: 显示三位有效数字。

支持自定义格式。查看 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 和 name 都是列表，则它们必须具有相同的长度。名称将应用于与对应表达式相对应的图。

对于 yAxisFormatter 和 yHoverFormatter 的有效选项：

• PromConsole.NumberFormatter.humanize：使用指标前缀格式化。
• PromConsole.NumberFormatter.humanizeNoSmallPrefix：对大于1的绝对值使用指标前缀格式化。对小于 1 的绝对值使用 3 位有效数字格式化。这对于避免由 PromConsole.NumberFormatter.humanize 产生的毫秒查询每秒这样的单位非常有用。
• PromConsole.NumberFormatter.humanize1024：使用 1024 作为基数而不是 1000 来格式化人类化结果。

该文档基于 Prometheus 官方文档翻译而成。