Grafana配置即代码：仪表盘与数据源的自动化管理-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01026/article/details/148323686

Grafana配置即代码：仪表盘与数据源的自动化管理

grafana The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more. 项目地址: https://gitcode.com/gh_mirrors/gr/grafana

前言

在现代监控系统中，Grafana作为可视化工具的核心地位日益凸显。随着企业规模的扩大，如何高效管理大量仪表盘和数据源成为运维团队面临的挑战。本文将深入讲解如何利用Grafana的配置即代码(Configuration as Code)功能，通过版本控制的方式自动化管理仪表盘和数据源。

配置即代码的核心价值

配置即代码是一种将系统配置存储在版本控制系统中，而非数据库的实践方式。这种模式具有以下显著优势：

版本控制：所有变更都有迹可循，便于回滚和审计
环境一致性：配置可在不同环境间复用，避免重复劳动
协作效率：团队成员可以并行工作，通过代码评审流程保证质量
自动化部署：与CI/CD流程集成，实现配置的自动化部署

准备工作

在开始之前，请确保满足以下条件：

已安装Grafana 7.0或更高版本
拥有系统管理员权限
了解基本的YAML和JSON语法

配置Grafana的Provisioning目录

Provisioning是Grafana实现配置即代码的核心机制。它通过读取指定目录下的配置文件来初始化系统资源。

目录结构

标准的Provisioning目录结构如下：

provisioning/
├── datasources/    # 数据源配置文件
└── dashboards/     # 仪表盘配置文件

自定义目录位置

默认情况下，Grafana会在配置目录(grafana/conf)下查找Provisioning目录。如需修改位置，可在主配置文件中设置：

[paths]
provisioning = /path/to/your/provisioning

数据源自动化配置

创建数据源清单

在provisioning/datasources/目录下创建default.yaml文件：

apiVersion: 1

datasources:
  - name: TestData
    type: testdata
    access: proxy
    isDefault: true

关键参数说明：

name：数据源显示名称
type：数据源类型(testdata、prometheus等)
access：访问模式(proxy/direct)
isDefault：是否设为默认数据源

高级配置示例

对于生产环境，您可能需要配置更复杂的数据源：

apiVersion: 1

datasources:
  - name: Production_Prometheus
    type: prometheus
    url: http://prometheus.prod:9090
    access: proxy
    basicAuth: true
    basicAuthUser: monitor
    jsonData:
      timeInterval: "30s"
      httpMethod: "POST"
    secureJsonData:
      basicAuthPassword: "secure_password"

仪表盘自动化配置

创建仪表盘提供者

在provisioning/dashboards/目录下创建default.yaml：

apiVersion: 1

providers:
  - name: Production_Dashboards
    folder: 'Production'
    type: file
    disableDeletion: true
    updateIntervalSeconds: 30
    options:
      path: /var/lib/grafana/dashboards/production

参数说明：

folder：仪表盘存放的文件夹
disableDeletion：防止通过UI删除仪表盘
updateIntervalSeconds：检查更新的频率

仪表盘定义文件

在指定路径下创建JSON格式的仪表盘定义文件，例如cluster.json：

{
  "title": "集群监控",
  "tags": ["kubernetes", "production"],
  "timezone": "Asia/Shanghai",
  "panels": [
    {
      "title": "CPU使用率",
      "type": "graph",
      "datasource": "Production_Prometheus",
      "targets": [
        {
          "expr": "sum(rate(container_cpu_usage_seconds_total[1m])) by (pod)",
          "legendFormat": "{{pod}}"
        }
      ]
    }
  ]
}