欢迎使用 grafyaml 的文档!

grafyaml

概览

概述

grafyaml 接收 YAML 格式的 Grafana 仪表盘描述,并将其转换为适合直接导入 Grafana 的 JSON 格式输出。

该工具使用 Voluptuous 数据验证库来确保输入生成有效的仪表盘。 除了验证之外,用户还可以受益于 YAML 标记,例如注释和更清晰的类型支持。

例如,这是一个最小的仪表盘规范

dashboard:
  time:
    from: "2018-02-07T08:42:27.000Z"
    to: "2018-02-07T13:48:32.000Z"
  templating:
    - name: hostname
      type: query
      datasource: graphite
      query: node*
      refresh: true
  title: My great dashboard
  rows:
    - title: CPU Usage
      height: 250px
      panels:
          - title: CPU Usage for $hostname
            type: graph
            datasource: graphite
            targets:
              - target: $hostname.Cpu.cpu_prct_used

grafyaml 在持续集成环境中非常有用。 用户可以通过正常的审查流程指定他们的仪表盘,并且测试可以验证其正确性。

该工具还可以接收手动从 Grafana 界面导出的 JSON,并将其加载为仪表盘。 这允许将使用内置编辑器编辑的仪表盘外部版本控制。

大量的示例可在 OpenStack project-config 仓库中找到,这些示例用于在 http://grafana.openstack.org 上创建仪表盘。

目录

索引和表格