promhippie/github-exporter

GitHub Exporter 镜像文档

镜像概述

GitHub Exporter是一个专为Prometheus设计的指标导出器，用于从GitHub平台收集各类项目指标。该镜像支持容器化部署，可轻松集成到Prometheus监控体系中，帮助用户实时监控GitHub仓库的活跃度、贡献情况及项目健康状态。

核心功能

• 收集GitHub仓库基础指标：包括星标数、分支数、fork数、开放/关闭的issues和PR数量等
• 监控贡献者活动：贡献者数量、提交频率等指标
• 支持GitHub API认证：通过GitHub令牌（Token）访问私有仓库或提高API调用限额
• 多平台部署：提供容器镜像，支持GHCR、Docker Hub、Quay等主流容器 registry
• 标准化指标输出：符合Prometheus指标格式，可直接被Prometheus抓取

使用场景

• 监控开源项目活跃度：跟踪星标增长、issue处理效率、贡献者参与度
• 团队GitHub工作流监控：监控PR审核周期、代码提交频率等团队协作指标
• 私有仓库管理：监控企业内部GitHub仓库的访问量、修改记录等安全相关指标
• DevOps监控体系集成：作为Prometheus监控链的一部分，构建完整的开发运维监控平台

使用方法

镜像来源

该镜像在以下平台提供，可根据需求选择：

• GHCR: ghcr.io/promhippie/github-exporter:latest
• Docker Hub: docker.io/promhippie/github-exporter:latest
• Quay: quay.io/promhippie/github-exporter:latest

Docker 部署示例

基础运行命令

bash
docker run -d \
  --name github-exporter \
  -p 9504:9504 \
  -e GITHUB_TOKEN="your_github_personal_access_token" \
  -e GITHUB_REPOS="promhippie/github_exporter,owner/another-repo" \
  ghcr.io/promhippie/github-exporter:latest

Docker Compose 配置

yaml
version: '3.8'
services:
  github-exporter:
    image: ghcr.io/promhippie/github-exporter:latest
    container_name: github-exporter
    ports:
      - "9504:9504"
    environment:
      - GITHUB_TOKEN=your_github_personal_access_token
      - GITHUB_REPOS=promhippie/github_exporter,owner/repo1,owner/repo2
      - LOG_LEVEL=info
    restart: unless-stopped

访问指标

启动容器后，可通过 http://<容器IP>:9504/metrics 访问导出的Prometheus指标，Prometheus配置文件中添加如下抓取配置即可收集指标：

yaml
scrape_configs:
  - job_name: 'github-exporter'
    static_configs:
      - targets: ['github-exporter:9504']

配置参数

以下环境变量可用于配置GitHub Exporter：

注意：GITHUB_REPOS和GITHUB_ORGS至少需配置一项，以指定监控目标。GitHub令牌可通过https://github.com/settings/tokens%E5%88%9B%E5%BB%BA%EF%BC%8C%E9%9C%80%E8%87%B3%E5%B0%91%E5%8C%85%E5%90%AB%60repo%60%E6%9D%83%E9%99%90%EF%BC%88%E8%AE%BF%E9%97%AE%E7%A7%81%E6%9C%89%E4%BB%93%E5%BA%93%EF%BC%89%E6%88%96%60public_repo%60%E6%9D%83%E9%99%90%EF%BC%88%E4%BB%85%E8%AE%BF%E9%97%AE%E5%85%AC%E5%85%B1%E4%BB%93%E5%BA%93%EF%BC%89%E3%80%82