Overview of Copilot Metrics Viewer
The Copilot Metrics Viewer is an insightful tool designed to present various metrics associated with GitHub Copilot. This application is particularly beneficial for GitHub Organizations and Enterprise Accounts, as it facilitates an understanding of Copilot's impact and adoption within these entities. The application leverages the GitHub Copilot Metrics API to gather data and transform it into easy-to-read visualizations.
What the Application Offers
The Copilot Metrics Viewer provides a comprehensive suite of visual charts that display key aspects of Copilot usage. Here are some of the primary metrics tracked by the application:
-
Acceptance Rate: This metric shows how often lines of code suggested by Copilot are accepted. It's a quick way to see how useful and relevant Copilot's suggestions are.
-
Total Suggestions and Acceptances: These graphs visualize the total number of code suggestions made, as well as accepted by users, highlighting Copilot's level of interaction and effectiveness.
-
Total Lines Suggested and Accepted: These metrics give insight into the volume of code Copilot generates and the proportion of it that users incorporate into their projects.
-
Total Active Users: This graph represents the number of users actively engaging with Copilot, which is a good indicator of the tool's adoption rate.
Language Breakdown Analysis
The application further enriches its analysis through a breakdown of the top five programming languages based on their accepted prompts and acceptance rates. This feature helps users understand which languages are most frequently used with Copilot and their respect metrics performance.
Copilot Chat Metrics
Beyond basic metrics, the viewer offers insights into Copilot chat interactions, such as:
- Cumulative Number of Turns: Showcasing the number of interactions (inputs and responses) with Copilot.
- Cumulative Acceptances: Indicating the total number of accepted Code lines following chat interactions.
- Active Copilot Chat Users: Displaying data on active users within the chat environment.
Seat Analysis
The application includes a unique Seat Analysis feature, offering insights such as:
- Total Assigned Seats: The number of Copilot seats assigned.
- Inactive Seats: Details regarding seats assigned but never used, or those that have had no recent activity.
Setting Up and Using the Application
Getting started with the Copilot Metrics Viewer requires some setup, including configuring environment variables. The application can adapt to either an organizational or enterprise scope, and users can set this depending on their needs.
To deploy the application, Docker instructions are available, making it straightforward to build and run the application locally or in a containerized environment. The application supports the use of API proxies for added security, keeping tokens hidden from the frontend.
Support and Maintenance
Copilot Metrics Viewer is an independently developed and maintained project, not an official GitHub product. It is maintained by contributors such as @martedesco and @karpikpl. The project is open-source, licensed under the MIT License, allowing for community contributions and collaborative improvements.
Any support requests can be directed to the project's GitHub Issues page, ensuring the community and maintainers stay in touch to resolve issues and enhance the tool. For urgent matters, users are encouraged to label their issues accordingly to grab the attention of maintainers more swiftly.
The Copilot Metrics Viewer acts as a vital asset for organizations wishing to gauge the influence of GitHub Copilot, making the collection and interpretation of metrics both intuitive and actionable.