Dashboard YAML properties

原文：https://docs.gitlab.com/ee/operations/metrics/dashboards/yaml.html

Dashboard YAML properties

仪表板包含几个组件：

  • 模板变量.
  • 面板组，由面板组成.
  • 支持一个或多个指标的面板.

下表概述了预期属性的详细信息.

Dashboard (top-level) properties

Property Type Required Description
dashboard string yes 前往仪表板. 每个文件只能定义一个仪表板.
panel_groups array yes 应在仪表板上的面板组.
templating hash no 可以在其下添加模板相关选项的顶级键.
links array no 添加链接以显示在仪表板上.

Templating (templating) properties

Property Type Required Description
variables hash yes 可以在这里定义变量.

阅读有关模板的文档.

Links (links) properties

Property Type Required Description
url string yes 链接的地址.
title string no 显示链接的标题.
type string no 链接的类型. 指定链接类型，可以是： grafana

阅读有关链接的文档.

Panel group (panel_groups) properties

Property Type Required Description
group string required 前往面板组.
priority number 可选，默认为按文件顺序 命令显示在仪表板上. 数字越高意味着优先级越高，该页面上的优先级越高. 数字不必是连续的.
panels array required 应在面板组中的面板.

面板组中的面板排成一排，每行包含两个面板. 该规则的一个例外是一行上的单个面板：这些面板将采用其所在行的整个宽度.

Panel (panels) properties

Property Type Required Description
type enum 不，默认为area-chart 指定要使用的面板类型，例如area-chart ， line-chart或anomaly-chart . 查看所有面板类型的文档.
title string yes 前往面板.
y_label string 不，但强烈鼓励 面板的 Y 轴标签.
y_axis string no 面板的 Y 轴配置.
max_value number no 分母值用于计算基于百分位数的结果
weight number 否，默认为按文件顺序 顺序出现在分组中. 较低的数字表示较高的优先级，在页面上较高. 数字不必是连续的.
metrics array yes 应在面板中显示的指标. 当type是area-chart或line-chart ，可以显示任意数量的度量标准，而当type是anomaly-chart时，只能显示 3 个度量标准.
links array no 添加链接以显示在图表的上下文菜单上 .

Axis (panels[].y_axis) properties

Property Type Required Description
name string 不，但强烈鼓励 面板的 Y 轴标签. 如果设置，则替换y_label .
format string 否，默认为engineering 使用的单位格式. 请参阅单位的完整列表 .
precision number 否，默认为2 要显示在数字中的小数位数.

Metrics (metrics) properties

Property Type Required Description
id string no 用于将仪表板指标与数据库记录相关联. 在仪表板配置文件中必须唯一. 警报所必需（尚未启用支持，请参阅相关问题 ）.
unit string yes 定义查询的返回数据的单位.
label string 不，但强烈鼓励 定义查询的图例标签. 在面板指标内应唯一. 可以包含时间序列标签作为内插变量.
query string 是，如果没有定义query_range 定义用于填充图表/面板的 Prometheus 查询. 如果定义，将使用Prometheus API的query端点.
query_range string 是，如果未定义query 定义用于填充图表/面板的 Prometheus 查询. 如果定义，将使用Prometheus API的query_range端点.
step number 不，如果未定义，则计算值 定义查询解析步长（以秒为单位）. 同一面板上的指标应使用相同的step值.

Dynamic labels

从 Prometheus 查询返回多个时间序列时，动态标签很有用.

当使用静态标签并且查询返回多个时间序列时，所有图例项将被标记为相同，这使得识别每个时间序列变得困难：

  1. metrics:
  2.   - id: my_metric_id
  3.     query_range: 'http_requests_total'
  4.     label: "Time  Series"
  5.     unit: "count"

这可能会生成如下图例：

repeated legend label chart

为了使标签更明确，使用反映时间序列标签的变量是一个好习惯. 渲染图例时，变量将被时间序列标签的值替换：

  1. metrics:
  2.   - id: my_metric_id
  3.     query_range: 'http_requests_total'
  4.     label: "Instance:  {{instance}},  method:  {{method}}"
  5.     unit: "count"

生成的渲染图例将如下所示：

legend with label variables

动态仪表板标签还有一个简写值，该标签仅使用一个时间序列标签：

  1. metrics:
  2.   - id: my_metric_id
  3.     query_range: 'http_requests_total'
  4.     label: "Method"
  5.     unit: "count"

这可以通过降低label的值来实现，如果还有更多的单词用空格分隔，请用下划线（ _ ）替换这些空格. 然后根据 Prometheus 查询返回的时间序列的标签检查转换后的值. 如果找到与转换后的值相等的时间序列标签，则将使用标签值并将其呈现在图例中，如下所示：

legend with label shorthand variable

Dashboard YAML syntax validation

在 GitLab 13.1 中引入 .

要确认您的仪表板定义包含有效的 YAML 语法，请执行以下操作：

  1. 导航 存储库>文件 .
  2. 导航到存储库中的仪表板文件.
  3. 查看文件内容上方显示的有关文件的信息窗格.

具有有效语法的文件显示Metrics 仪表板 YAML 定义有效 ，而具有无效语法的文件显示Metrics Dashboard YAML 定义无效 .

Metrics Dashboard_YAML_syntax_validation

当” 指标仪表板” YAML 定义无效时 ，将至少显示以下消息之一：

  1. dashboard: can't be blank learn more
  2. panel_groups: should be an array of panel_groups objects learn more
  3. group: can't be blank learn more
  4. panels: should be an array of panels objects learn more
  5. title: can't be blank learn more
  6. metrics: should be an array of metrics objects learn more
  7. query: can't be blank learn more
  8. query_range: can't be blank learn more
  9. unit: can't be blank learn more

  10. YAML syntax: The parsed YAML is too big

    当 YAML 文件大于 1 MB 时显示.

  11. YAML syntax: Invalid configuration format

    当 YAML 文件为空或不包含有效的 YAML 时显示.

指标仪表板 YAML 定义验证信息也可以作为GraphQL API 字段获得