注意：有关支持和帮助的信息，请点击这里。

ℹ️ v3.0 — 新的 Copilot 使用指标 API

自 v3.0 起，Copilot Metrics Viewer 使用 Copilot 使用指标 API。旧版 Copilot 使用指标 API 已于 2026 年 4 月 2 日关闭，不再可用。

v3.0 的新功能：

• 所有数据均使用异步 Copilot 使用指标 API
• 历史模式：通过 PostgreSQL 数据库存储超过 28 天滚动窗口的数据
• 用户级指标选项卡：提供个人使用情况细分
• 基于用户级数据的团队指标：不再需要已弃用的团队级别 API 端点
• 同步服务：用于每日自动数据收集

您的 GitHub 应用程序需要 “组织 Copilot 指标：读取” 权限。有关设置详情，请参阅 GitHub 应用程序注册。

GitHub Copilot 指标查看器

此应用程序为您的GitHub 组织或企业账户显示一组与 GitHub Copilot 相关的各种指标图表。这些可视化旨在清晰地呈现数据，便于理解和分析 GitHub Copilot 的影响及采用情况。

运行模式

该应用程序支持两种运行模式：

模式	描述	要求	团队指标	数据保留
直接 API	在每次页面加载时直接从 GitHub 的 API 获取指标	仅需 GitHub 令牌	❌ 不可用	滚动 28 天
历史模式	从本地 PostgreSQL 数据库读取数据，每日同步	PostgreSQL + 同步服务	✅ 完整历史	无限制

直接 API 模式是最简单的设置——无需数据库。它会返回来自 Copilot 使用指标 API 的最新 28 天滚动窗口数据。由于团队指标是根据数据库中存储的用户记录推导出来的，因此在此模式下无法查看团队范围的视图。

历史模式则增加了 PostgreSQL 数据库和一个每日下载指标的同步服务。这使得：

• 可以查看 超出 28 天 API 窗口 的指标
• 提供 用户时间序列历史 和趋势图
• 团队指标——由存储的用户数据根据团队成员资格筛选后得出

有关每种模式的设置说明，请参阅 DEPLOYMENT.md。

应用程序概述

GitHub Copilot 指标查看器通过直观的仪表板界面提供全面的分析：

新功能

日期范围筛选（最长 100 天）

用户现在可以使用直观的日历选择界面，按自定义日期范围筛选最多 100 天内的指标。系统还支持在计算中排除周末和节假日。

团队比较

比较您组织内多个团队的 Copilot 指标，以了解采用模式并识别表现优异的团队。

[!NOTE] GitHub 的 Copilot 使用指标 API 不提供团队级别的端点。团队指标是通过从组织/企业端点获取每日用户级指标、利用 GitHub Teams API 解析团队成员资格，并在内存中聚合用户级数据来“推导”出的。此方法适用于直接 API 模式（28 天窗口）和历史模式（完整历史）。

用户级指标

查看个人用户级别的 Copilot 使用指标，包括代码补全、聊天交互和代码审查活动。摘要卡片显示总用户数、活跃用户数以及平均接受率。

在 历史模式（使用 PostgreSQL 数据库）下，用户指标选项卡还会显示用户的时间序列历史图表，使您可以跟踪个人随时间的变化趋势。

GitHub.com 集成与模型分析

查看 GitHub.com 功能的综合统计数据，包括聊天、PR 摘要以及详细的模型使用分析。每个部分都提供可展开的详细信息，显示模型类型、编辑器和使用模式。

CSV 导出功能

将您的指标数据导出为多种格式，以便进一步分析或报告。选项包括摘要报告、完整详细导出以及直接复制到剪贴板。

图表

关键指标

[!NOTE] 指标详情在 Copilot 使用情况指标 API 文档 中有详细说明

以下是在这些图表中可视化的关键指标：

1. 接受率：该指标表示 GitHub Copilot 接受的代码行数和建议数占其总建议数的比例。这一比率是 Copilot 建议相关性和有用性的一个指标。然而，与任何指标一样，使用时也应谨慎，因为开发者使用 Copilot 的方式多种多样（研究、确认、验证等，并非总是直接“注入”代码）。

2. 总建议数：此图表展示了 GitHub Copilot 提出的代码建议总数。它反映了工具的活跃度及其随时间推移与用户的互动情况。

3. 总接受数：此可视化专注于用户接受的建议总数。

4. 总建议行数：展示了 GitHub Copilot 建议的代码行数总和。这有助于了解代码生成和辅助工作的规模。

5. 总接受行数：顾名思义，该指标显示了用户接受的代码行数（完全接受），从而揭示有多少建议代码被实际使用并整合到代码库中。

6. 总活跃用户数：代表与 GitHub Copilot 互动的活跃用户数量。这有助于了解用户群体的增长和采用率。

语言细分分析

顶部展示了按接受提示数和接受率（按次数/按行数）排列的前 5 种语言的饼图。

语言细分分析选项卡还显示了一个表格，列出所选时间段内每种语言的接受提示数、接受代码行数以及接受率（%）。条目按“接受代码行数降序”排列。

Copilot 聊天指标

1. 累计轮次总数：该指标表示在所选时间段内与 Copilot 的累计轮次（交互次数）。一轮包括用户输入和 Copilot 的回复。

2. 累计接受总数：该指标显示在所选时间段内 Copilot 建议并被用户接受的代码行数总和。

3. 总轮次 | 总接受数统计：这是一个展示总轮次和总接受数的图表。

4. 总活跃 Copilot 聊天用户数：一个柱状图，展示了在所选时间段内与 Copilot 积极互动的用户总数。

使用席位分析

1. 总分配席位数：该指标表示当前组织/企业中已分配的 Copilot 席位总数。

2. 已分配但从未使用：该指标显示在当前组织/企业中已分配但从未使用的席位。图表中还显示了分配时间戳。

3. 过去 7 天无活动：包括从未使用过的席位或虽曾使用但过去 7 天内无活动的席位。

4. 过去 7 天无活动（含从未使用过的席位）：一个表格，用于展示过去 7 天内无任何活动的席位，并按最后活动日期排序。较早使用过的席位将显示在顶部。

高级功能

灵活的日期范围选择

该应用支持灵活的日期范围选择，允许用户分析长达 100 天内的任意时间段的指标。日期选择器提供直观的日历界面，并可选择在分析中排除周末和节假日。

数据导出功能

API 响应选项卡中提供了多种导出选项：

• 下载 CSV（摘要）：以精简格式导出关键指标
• 下载 CSV（完整）：导出全面的详细数据
• 将指标复制到剪贴板：快速复制功能，便于即时使用
• 检查指标数据质量：验证数据的完整性和可靠性

团队分析

组织可以比较不同团队的指标，以：

• 识别高绩效团队
• 了解采用模式
• 在团队间分享最佳实践
• 监控各团队的参与度水平

[!NOTE] 团队指标基于每位用户的个人数据，通过解析 GitHub 团队成员关系并进行汇总得出。GitHub Copilot 使用情况指标 API 并没有专门的团队端点——本应用会自动计算团队视图。在直接 API 模式下，团队数据涵盖最近 28 天的数据；而在历史模式（使用 PostgreSQL）下，则可获取完整的团队历史趋势。

模型使用分析

对 AI 模型使用的详细洞察，包括：

• 各编辑器和模型类型的 IDE 代码补全情况
• IDE 聊天互动及模型偏好
• GitHub.com 聊天使用模式
• PR 摘要生成统计数据
• 自定义模型与默认模型的采用率

设置说明

在 .env 文件中，您可以配置多个环境变量来控制应用程序的行为。

公共变量：

• NUXT_PUBLIC_IS_DATA_MOCKED
• NUXT_PUBLIC_SCOPE
• NUXT_PUBLIC_GITHUB_ENT
• NUXT_PUBLIC_GITHUB_ORG
• NUXT_PUBLIC_GITHUB_TEAM
• NUXT_PUBLIC_HIDDEN_TABS
• NUXT_PUBLIC_ENABLE_HISTORICAL_MODE

这些变量可以通过路由参数进行覆盖，例如：

• http://localhost:3000/enterprises/octo-demo-ent
• http://localhost:3000/orgs/octo-demo-org
• http://localhost:3000/orgs/octo-demo-org/teams/the-a-team
• http://localhost:3000/enterprises/octo-demo-ent/teams/the-a-team
• http://localhost:3000/orgs/mocked-org?mock=true

NUXT_PUBLIC_SCOPE（必填！）

.env 文件中的 NUXT_PUBLIC_SCOPE 环境变量决定了应用程序发起的 API 调用的默认作用域。它可以设置为 'enterprise'、'organization'、'team-organization' 或 'team-enterprise'。

• 如果设置为 'enterprise'，应用程序将把 API 调用的目标指向在 NUXT_PUBLIC_GITHUB_ENT 变量中定义的 GitHub Enterprise 账户。
• 如果设置为 'organization'，应用程序将把 API 调用的目标指向在 NUXT_PUBLIC_GITHUB_ORG 变量中定义的 GitHub Organization 账户。
• 如果设置为 'team-organization' 或 'team-enterprise'，应用程序将显示基于指定组织或企业内 NUXT_PUBLIC_GITHUB_TEAM 中定义的团队成员个人数据得出的团队级别指标。

例如，如果您希望将 API 调用的目标指向某个组织，则可以在 .env 文件中设置 NUXT_PUBLIC_SCOPE=organization。

[!INFO] 具有 NUXT_PUBLIC 作用域的环境变量可在浏览器中使用（即公开）。 详情请参阅 Nuxt 运行时配置。

NUXT_PUBLIC_SCOPE=organization

NUXT_PUBLIC_GITHUB_ORG=<YOUR-ORGANIZATION>

NUXT_PUBLIC_GITHUB_ENT=

NUXT_PUBLIC_GITHUB_TEAM

NUXT_PUBLIC_GITHUB_TEAM 环境变量用于筛选组织或企业账户中特定 GitHub 团队的指标。 ‼️ 重要提示 ‼️ 当此变量被设置时，所有显示的指标都将仅与指定团队相关。若要查看整个组织或企业的指标，请移除此环境变量。

[!NOTE] 团队指标是 基于每位用户的个人数据 得出的，而非通过专门的团队 API 端点获取。应用程序会通过 GitHub Teams API 解析团队成员关系，并汇总团队成员的个人指标。对团队规模没有最低要求。

NUXT_PUBLIC_GITHUB_TEAM=

NUXT_PUBLIC_IS_DATA_MOCKED

该变量默认为 false。若要查看模拟数据，可将其设置为 true，或使用查询参数 ?mock=true。

NUXT_PUBLIC_IS_DATA_MOCKED=false

NUXT_GITHUB_TOKEN

指定用于 API 请求的 GitHub 个人访问令牌。生成此令牌时，请确保具备以下权限：读取成员信息、组织 Copilot 指标 和 组织 Copilot 座位管理。

[!IMPORTANT] v3.0 迁移： 新的 Copilot 使用情况指标 API 需要 读取成员信息、组织 Copilot 指标以及组织 Copilot 座位管理 权限。否则，新的 API 端点将返回 400/403 错误。有关设置详情，请参阅 GitHub 应用注册。

该令牌不会在前端使用。

NUXT_GITHUB_TOKEN=

NUXT_SESSION_PASSWORD（必填！）

此变量用于加密用户会话，长度至少为 32 个字符。更多信息请参阅 Nuxt 会话与认证。

[!WARNING] 从版本 2.0.0 开始，此变量为必填项。

NUXT_PUBLIC_USING_GITHUB_AUTH

默认值为 false。当设置为 true 时，将执行 GitHub OAuth 应用程序认证，以验证用户对仪表板的访问权限。为此，必须在企业或组织中注册并安装一个 GitHub 应用程序。有关步骤，请参阅 GitHub 应用程序注册。

GitHub 认证所需的变量包括：

1. NUXT_OAUTH_GITHUB_CLIENT_ID - GitHub 应用程序的客户端 ID。
2. NUXT_OAUTH_GITHUB_CLIENT_SECRET - GitHub 应用程序的客户端密钥。
3. [可选] NUXT_OAUTH_GITHUB_CLIENT_SCOPE，用于在使用 OAuth 应用程序而非 GitHub 应用程序时请求范围。详情请参阅 GitHub 文档。

[!WARNING] 只有具备相应权限（如 NUXT_GITHUB_TOKEN 中列出的范围）的用户才能查看 Copilot 指标。GitHub 会根据已认证用户的权限发起 API 调用来获取数据。

NUXT_PUBLIC_HIDDEN_TABS

逗号分隔的仪表板选项卡名称列表，用于隐藏这些选项卡。此设置在启动时生效，无需重新构建——对于预构建的 Docker 部署非常有用。过滤不区分大小写，并会去除前后空格。

可用选项卡名称：languages、editors、copilot chat、agent activity、pull requests、github.com、seat analysis、user metrics、api response

# 隐藏“Agent Activity”和“API Response”选项卡
NUXT_PUBLIC_HIDDEN_TABS=agent activity,api response

NUXT_PUBLIC_ENABLE_HISTORICAL_MODE

默认值为 false。当设置为 true 时，应用程序将使用 PostgreSQL 数据库（通过 DATABASE_URL 配置）来存储和查询历史 Copilot 指标。

[!IMPORTANT] 当 NUXT_PUBLIC_ENABLE_HISTORICAL_MODE 不为 true 时，Teams 选项卡会自动隐藏。团队级别的指标是从数据库中的每日用户记录（user_day_metrics 表）中得出的。如果没有数据库，团队比较选项卡将显示每个团队完全相同的组织级数据。

NUXT_PUBLIC_ENABLE_HISTORICAL_MODE=false

HTTP_PROXY

在企业环境中运行时，解决方案支持 HTTP 代理设置。只需设置 HTTP_PROXY 环境变量即可。

对于自定义 CA 证书，请使用环境变量 CUSTOM_CA_PATH 将证书加载到代理代理选项中。

NITRO_PORT

Dockerfile 中的默认值为 80，它定义了 Nitro（Nuxt 的服务器引擎）将监听的端口号。

例如，如果应用程序以非 root 用户身份运行，则应将其设置为 1024 到 49151 之间的数字。

安装依赖

npm install

编译并运行应用程序

npm run dev

构建 Docker 镜像

docker build -t copilot-metrics-viewer .

运行 Docker 容器

docker run -p 8080:80 --env-file ./.env copilot-metrics-viewer

应用程序将可通过 http://localhost:8080 访问。

健康检查端点

为 Kubernetes 部署和健康监控，该应用提供了专用的健康检查端点，这些端点无需身份验证且不会发起外部 API 调用：

• /api/health - 通用健康检查端点
• /api/ready - 就绪性探针端点
• /api/live - 存活性探针端点

所有端点均返回包含状态信息的 JSON 响应，并在约 200 毫秒内完成响应，因此非常适合用于 Kubernetes 的健康检查，而非使用会触发 GitHub API 调用的根路径 / 端点。

Kubernetes 配置示例

livenessProbe:
  httpGet:
    path: /api/live
    port: 80
  initialDelaySeconds: 30
  periodSeconds: 10

readinessProbe:
  httpGet:
    path: /api/ready
    port: 80
  initialDelaySeconds: 5
  periodSeconds: 5

许可证

本项目采用 MIT 开源许可证条款进行许可。完整条款请参阅 MIT。

维护者

@martedesco 和 @karpikpl

支持

本项目由独立开发者开发和维护，并非 GitHub 官方产品。它得益于 (@martedesco)、(@karpikpl) 以及我们优秀的贡献者们的辛勤付出而蓬勃发展。衷心感谢所有贡献者！✨

我计划通过 GitHub Issues 提供支持。尽管我会尽力保持响应，但无法保证即时回复。如遇紧急问题，请在标题中注明“CRITICAL”，以便更快得到处理。🙏🏼

GitHub Copilot Metrics Viewer 快速上手指南

GitHub Copilot Metrics Viewer 是一款用于可视化和分析 GitHub Copilot 使用情况的开源工具。它支持查看组织或企业账户的代码建议接受率、活跃用户数、语言分布及团队对比等关键指标。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows (WSL2 推荐)
• Node.js: 版本 18.x 或更高 (推荐使用 nvm 管理)
• 包管理器: npm, yarn 或 pnpm
• GitHub 权限:
  • 需要创建一个 GitHub App 或拥有 Personal Access Token (Fine-grained)。
  • 必须授予 "Organization Copilot metrics: Read" (组织 Copilot 指标：读取) 权限。
  • 若需查看团队指标，还需具备读取团队成员信息的权限。
• 可选依赖 (历史模式):
  • 若需保留超过 28 天的历史数据或使用团队趋势分析，需安装 PostgreSQL 数据库。

安装步骤

1. 克隆项目

git clone https://github.com/github-copilot-resources/copilot-metrics-viewer.git
cd copilot-metrics-viewer

2. 安装依赖

建议使用国内镜像源加速安装（如淘宝镜像）：

# 使用 npm
npm config set registry https://registry.npmmirror.com
npm install

# 或使用 yarn
yarn config set registry https://registry.npmmirror.com
yarn install

3. 配置环境变量

复制示例配置文件并根据实际情况修改：

cp .env.example .env

编辑 .env 文件，配置以下核心变量：

# 必填：设置数据范围 ('enterprise', 'organization', 或 'team-organization')
NUXT_PUBLIC_SCOPE=organization

# 必填：您的 GitHub 组织名称或企业账号名称
NUXT_PUBLIC_GITHUB_ORG=your-org-name
# 如果是企业账号，使用下面这行并注释掉上一行
# NUXT_PUBLIC_GITHUB_ENT=your-enterprise-name

# 必填：GitHub Token (需在 GitHub 开发者设置中生成)
# 注意：生产环境建议使用 GitHub App 的私钥和 ID 配置，此处为简化演示使用 Token
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# 可选：启用历史模式 (需 PostgreSQL)，默认为 false (仅显示最近 28 天)
NUXT_PUBLIC_ENABLE_HISTORICAL_MODE=false

注意：若启用 NUXT_PUBLIC_ENABLE_HISTORICAL_MODE=true，请确保已启动 PostgreSQL 服务并在 .env 中配置正确的数据库连接字符串 (DATABASE_URL)。

基本使用

启动应用

完成配置后，运行以下命令启动开发服务器：

npm run dev
# 或
yarn dev

应用默认将在 http://localhost:3000 运行。

访问仪表盘

打开浏览器访问 http://localhost:3000，您将看到主仪表盘，包含以下核心功能：

1. 概览图表: 查看接受率 (Acceptance Rate)、总建议数、总采纳行数及活跃用户数趋势。
2. 日期筛选: 点击右上角日历图标，可自定义查询最近 100 天内的数据（支持排除周末/节假日）。
3. 团队对比: 切换到 "Teams" 标签页，对比不同团队的 Copilot adoption 情况。
4. 用户明细: 在 "Per-User" 标签页查看具体用户的代码补全和聊天互动数据。
5. 数据导出: 点击 "API Response" 或导出按钮，可将数据下载为 CSV 格式进行二次分析。

进阶：通过 URL 参数快速切换视图

无需修改 .env 文件，可直接通过 URL 路径参数切换查看范围：

• 查看特定组织：http://localhost:3000/orgs/your-org-name
• 查看特定企业：http://localhost:3000/enterprises/your-ent-name
• 查看特定团队：http://localhost:3000/orgs/your-org-name/teams/team-slug
• 开启模拟数据测试：http://localhost:3000/orgs/mocked-org?mock=true