Dashboard YAML properties
- Links (
links
) properties - Panel (
panels
) properties - Metrics (
metrics
) properties - Dashboard YAML syntax validation
Dashboard YAML properties
仪表板包含几个组件:
- 模板变量.
- 面板组,由面板组成.
- 支持一个或多个指标的面板.
下表概述了预期属性的详细信息.
Templating (templating
) properties
Property | Type | Required | Description |
---|---|---|---|
variables |
hash | yes | 可以在这里定义变量. |
阅读有关的文档.
Links (links
) properties
阅读有关的文档.
Property | Type | Required | Description |
---|---|---|---|
group |
string | required | 前往面板组. |
number | 可选,默认为按文件顺序 | 命令显示在仪表板上. 数字越高意味着优先级越高,该页面上的优先级越高. 数字不必是连续的. | |
panels |
array | required | 应在面板组中的面板. |
面板组中的面板排成一排,每行包含两个面板. 该规则的一个例外是一行上的单个面板:这些面板将采用其所在行的整个宽度.
Panel (panels
) properties
Axis (panels[].y_axis
) properties
Property | Type | Required | Description | |
---|---|---|---|---|
name |
string | 不,但强烈鼓励 | 面板的 Y 轴标签. 如果设置,则替换y_label . |
|
format |
string | 否,默认为engineering |
使用的单位格式. 请参阅单位的 . | |
number | 否,默认为2 |
要显示在数字中的小数位数. |
Dynamic labels
从 Prometheus 查询返回多个时间序列时,动态标签很有用.
当使用静态标签并且查询返回多个时间序列时,所有图例项将被标记为相同,这使得识别每个时间序列变得困难:
为了使标签更明确,使用反映时间序列标签的变量是一个好习惯. 渲染图例时,变量将被时间序列标签的值替换:
生成的渲染图例将如下所示:
动态仪表板标签还有一个简写值,该标签仅使用一个时间序列标签:
这可以通过降低label
的值来实现,如果还有更多的单词用空格分隔,请用下划线( _
)替换这些空格. 然后根据 Prometheus 查询返回的时间序列的标签检查转换后的值. 如果找到与转换后的值相等的时间序列标签,则将使用标签值并将其呈现在图例中,如下所示:
Dashboard YAML syntax validation
要确认您的仪表板定义包含有效的 YAML 语法,请执行以下操作:
- 导航 存储库>文件 .
- 查看文件内容上方显示的有关文件的信息窗格.
具有有效语法的文件显示Metrics 仪表板 YAML 定义有效 ,而具有无效语法的文件显示Metrics Dashboard YAML 定义无效 .
当” 指标仪表板” YAML 定义无效时 ,将至少显示以下消息之一:
dashboard: can't be blank
learn morepanel_groups: should be an array of panel_groups objects
group: can't be blank
learn morepanels: should be an array of panels objects
title: can't be blank
learn moremetrics: should be an array of metrics objects
query: can't be blank
learn morequery_range: can't be blank
unit: can't be blank
learn more-
当 YAML 文件大于 1 MB 时显示.
指标仪表板 YAML 定义验证信息也可以作为