Grafana OnCall 项目教程

1. 项目目录结构及介绍

Grafana OnCall 项目的目录结构如下：

grafana/oncall/
├── dev/
├── docs/
├── engine/
├── grafana-plugin/
├── helm/
├── terraform/
├── tools/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── .markdownlint.json
├── .markdownlintignore
├── .nvmrc
├── .pre-commit-config.yaml
├── .prettierignore
├── .prettierrc.js
├── .yamllint.yml
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── Tiltfile
├── docker-compose-developer.yml
├── docker-compose-mysql-rabbitmq.yml
├── docker-compose.yml

目录介绍：

• dev/: 开发相关的文件和配置。
• docs/: 项目文档。
• engine/: 核心引擎代码。
• grafana-plugin/: Grafana 插件代码。
• helm/: Helm 配置文件。
• terraform/: Terraform 配置文件。
• tools/: 工具脚本和配置。
• .dockerignore: Docker 忽略文件。
• .gitattributes: Git 属性配置。
• .gitignore: Git 忽略文件。
• .markdownlint.json: Markdown 格式检查配置。
• .markdownlintignore: Markdown 忽略文件。
• .nvmrc: Node.js 版本配置。
• .pre-commit-config.yaml: 预提交钩子配置。
• .prettierignore: Prettier 忽略文件。
• .prettierrc.js: Prettier 配置文件。
• .yamllint.yml: YAML 格式检查配置。
• CHANGELOG.md: 项目变更日志。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目介绍和使用说明。
• Tiltfile: Tilt 配置文件。
• docker-compose-developer.yml: 开发者环境 Docker Compose 配置。
• docker-compose-mysql-rabbitmq.yml: MySQL 和 RabbitMQ 环境 Docker Compose 配置。
• docker-compose.yml: 默认 Docker Compose 配置。

2. 项目启动文件介绍

项目的启动文件主要集中在 docker-compose.yml 和 Makefile 中。

docker-compose.yml

这是项目的核心启动文件，定义了 Docker 容器的配置和启动方式。通过以下命令启动项目：

docker-compose pull && docker-compose up -d

Makefile

Makefile 包含了项目的构建和启动命令。常用的命令包括：

• make build: 构建项目。
• make start: 启动项目。
• make stop: 停止项目。

3. 项目配置文件介绍

项目的配置文件主要集中在以下几个文件中：

.env

环境变量配置文件，包含项目的各种配置参数，如：

DOMAIN=http://localhost:8080
SECRET_KEY=my_random_secret_must_be_more_than_32_characters_long

prometheus.yml

Prometheus 配置文件，用于配置 Prometheus 的抓取间隔和目标：

global:
  scrape_interval: 15s
  evaluation_interval: 15s

scrape_configs:
  - job_name: prometheus
    metrics_path: /metrics/
    authorization:
      credentials: my_random_prometheus_secret
    static_configs:
      - targets: ["host.docker.internal:8080"]

Tiltfile

Tilt 配置文件，用于定义项目的开发环境配置。

docker-compose.yml

Docker Compose 配置文件，定义了 Docker 容器的配置和启动方式。

通过这些配置文件，可以灵活地调整项目的运行环境和参数。