githubexporter/github-exporter

Prometheus GitHub Exporter

从GitHub API提取仓库基本指标，并暴露到Prometheus兼容的端点。

核心功能与特性

• 支持监控指定组织、用户或单个仓库的GitHub指标
• 通过环境变量灵活配置监控范围、认证方式、端口等参数
• 可选GitHub认证令牌，提高API查询频率限制
• 兼容Prometheus采集格式，提供标准监控指标
• 可自定义监听端口、指标路径和日志级别

配置说明

导出器通过环境变量进行配置，所有变量均为可选：

使用场景与适用范围

适用于需要将GitHub仓库数据（如提交、分支、PR等指标）集成到Prometheus监控系统的场景，支持：

• 监控特定用户、组织或仓库的GitHub活动
• 通过Prometheus告警规则监控GitHub仓库异常情况
• 结合Grafana构建GitHub数据可视化面板

安装与部署

从Docker Hub手动运行

bash
docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" githubexporter/github-exporter

构建Docker镜像

bash
docker build -t <镜像名称> .
docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" <镜像名称>

Docker Compose配置

yaml
github-exporter:
    tty: true
    stdin_open: true
    expose:
      - 9171
    ports:
      - 9171:9171
    image: githubexporter/github-exporter:latest
    environment:
      - REPOS=<要监控的仓库，格式为"user/repo1, user/repo2">
      - GITHUB_TOKEN=<你的GitHub API令牌>

指标说明

指标默认在9171端口可用。指标示例可在仓库根目录的METRICS.md文件中查看。

测试

test目录中包含一组黑盒行为测试，用于验证指标端点。运行方式如下：

bash
make test

版本发布流程

当新的拉取请求合并到master分支后，需在本地执行以下脚本。该脚本将触发Docker Hub上的新镜像构建，新镜像标签为release-<version>。版本号取自VERSION文件，且必须遵循语义化版本规范（详见semver.org）。

在执行以下命令前，确保已将VERSION文件中的版本号更新至所需版本：

bash
./release-version.sh