注意:有关支持和帮助的信息,请点击这里。
GitHub Copilot 指标查看器
这个应用程序为您的GitHub 组织或企业账户展示了一系列与 GitHub Copilot 相关的各种指标图表。这些可视化设计旨在清晰地呈现数据,使其易于理解和分析 GitHub Copilot 的影响和采用情况。本应用利用了 GitHub Copilot 指标 API。
视频
图表
关键指标
以下是这些图表中可视化的关键指标:
- 接受率: 该指标表示接受的行数与 GitHub Copilot 建议的总行数的比率。这个比率是 Copilot 建议相关性和有用性的指标。
-
总建议数: 这个图表展示了 GitHub Copilot 提供的代码建议总数。它提供了该工具活动和用户参与度随时间变化的视图。
-
总接受数: 这个可视化专注于用户接受的建议总数。
-
建议总行数: 展示 GitHub Copilot 建议的代码总行数。这给出了代码生成和辅助提供量的概念。
-
接受总行数: 顾名思义,用户接受的代码总行数(完全接受),提供了对实际被使用和纳入代码库的建议代码量的洞察。
- 活跃用户总数: 表示与 GitHub Copilot 互动的活跃用户数量。这有助于理解用户基础的增长和采用率。
语言细分分析
顶部显示了按接受提示和接受率排名的前 5 种语言的饼图。
语言细分分析标签页还显示了一个表格,展示了过去 28 天内每种语言的已接受提示、已接受代码行数和接受率(%)。条目按_已接受代码行数降序_排列。
Copilot 聊天指标
-
累计对话轮次: 该指标表示过去 28 天内与 Copilot 的总对话轮次(交互)。一个"轮次"包括用户输入和 Copilot 的回应。
-
累计接受次数: 该指标显示过去 28 天内用户接受的 Copilot 建议代码行总数。
-
总轮次 | 总接受次数: 这是一个显示总轮次和接受次数的图表。
-
Copilot 聊天活跃用户总数: 一个条形图,展示过去 28 天内与 Copilot 积极互动的用户总数。
席位分析
1. **总分配数:** 该指标表示当前组织/企业内分配的 Copilot 席位总数。
-
已分配但从未使用: 该指标显示在当前组织/企业内已分配但从未使用的席位。图表中还显示了分配时间戳。
-
最近 7 天无活动: 从未使用的席位或已使用但在过去 7 天内无活动的席位。
-
最近 7 天无活动(包括从未使用的席位): 一个表格,显示过去 7 天内无活动的席位,按最后活动日期排序。较早使用过的席位显示在顶部。
设置说明
在 .env
文件中,您可以配置几个控制应用程序行为的环境变量。
VUE_APP_SCOPE
.env
文件中的 VUE_APP_SCOPE
环境变量决定了应用程序进行 API 调用的范围。它可以设置为 'enterprise' 或 'organization'。
- 如果设置为 'enterprise',应用程序将针对
VUE_APP_GITHUB_ENT
变量中定义的 GitHub 企业账户进行 API 调用。 - 如果设置为 'organization',应用程序将针对
VUE_APP_GITHUB_ORG
变量中定义的 GitHub 组织账户进行 API 调用。
例如,如果您想针对组织进行 API 调用,您可以在 .env
文件中设置 VUE_APP_SCOPE=organization
。
VUE_APP_SCOPE=organization
VUE_APP_GITHUB_ORG= <您的组织>
VUE_APP_GITHUB_ENT=
VUE_APP_MOCKED_DATA
要通过 API 访问过去 28 天的 Copilot 指标并显示实际数据,请将以下布尔环境变量设置为 false
:
VUE_APP_MOCKED_DATA=false
VUE_APP_GITHUB_TOKEN
指定用于 API 请求的 GitHub 个人访问令牌。生成此令牌时需要以下权限范围:copilot、manage_billing:copilot、manage_billing:enterprise、read:enterprise、read:org。
VUE_APP_GITHUB_TOKEN=
安装依赖
npm install
编译并运行应用程序
npm run serve
Docker 构建
docker build -t copilot-metrics-viewer .
Docker 运行
docker run -p 8080:80 --env-file ./.env copilot-metrics-viewer
应用程序将可在 http://localhost:8080 访问
许可证
本项目根据 MIT 开源许可证的条款授权。请参阅 MIT 了解完整条款。
维护者
支持
本项目是独立开发和维护的,不是 GitHub 的官方产品。它通过我(@martedesco)和我们出色的贡献者的专注努力而蓬勃发展。衷心感谢所有贡献者!✨
我致力于通过 GitHub Issues 提供支持。虽然我努力保持响应及时,但无法保证立即回复。对于紧急问题,请在标题中包含"CRITICAL"以获得更快的关注。🙏🏼
即将推出 🔮
- 团队分析
- 持久化层