Skip to content

Commit 78f8ed7

Browse files
Copilotkarpikpl
andcommitted
Update README with latest screenshots and feature documentation
Co-authored-by: karpikpl <[email protected]>
1 parent 4b7b392 commit 78f8ed7

11 files changed

+75
-13
lines changed

README.md

Lines changed: 75 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,47 @@ _NOTE: For information on support and assistance, click [here](https://github.co
77

88
This application displays a set of charts with various metrics related to GitHub Copilot for your <i>GitHub Organization</i> or <i>Enterprise Account</i>. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and adoption of GitHub Copilot. This app utilizes the [GitHub Copilot Metrics API](https://docs.github.com/en/enterprise-cloud@latest/rest/copilot/copilot-usage?apiVersion=2022-11-28).
99

10-
## Video
10+
## Application Overview
1111

12-
https://github.com/github-copilot-resources/copilot-metrics-viewer/assets/3329307/bc7e2a16-cc73-43c4-887a-b50809c08533
12+
The GitHub Copilot Metrics Viewer provides comprehensive analytics through an intuitive dashboard interface:
13+
14+
<p align="center">
15+
<img width="800" alt="Main Dashboard Overview" src="./images/main-metrics-dashboard.png">
16+
</p>
17+
18+
## New Features
19+
20+
### Date Range Filtering (up to 100 days)
21+
Users can now filter metrics for custom date ranges up to 100 days, with an intuitive calendar picker interface. The system also supports excluding weekends and holidays from calculations.
22+
23+
<p align="center">
24+
<img width="800" alt="Date Range Filter" src="./images/date-range-filter.png">
25+
</p>
26+
27+
### Teams Comparison
28+
Compare Copilot metrics across multiple teams within your organization to understand adoption patterns and identify high-performing teams.
29+
30+
<p align="center">
31+
<img width="800" alt="Teams Comparison" src="./images/teams-comparison.png">
32+
</p>
33+
34+
### GitHub.com Integration & Model Analytics
35+
View comprehensive statistics for GitHub.com features including Chat, PR Summaries, and detailed model usage analytics. Each section provides expandable details showing model types, editors, and usage patterns.
36+
37+
<p align="center">
38+
<img width="800" alt="GitHub.com Tab" src="./images/github-com-tab.png">
39+
</p>
40+
41+
<p align="center">
42+
<img width="800" alt="Model Usage Details" src="./images/github-com-models-expanded.png">
43+
</p>
44+
45+
### CSV Export Functionality
46+
Export your metrics data in multiple formats for further analysis or reporting. Options include summary reports, full detailed exports, and direct clipboard copying.
47+
48+
<p align="center">
49+
<img width="800" alt="CSV Export Options" src="./images/csv-export-functionality.png">
50+
</p>
1351

1452
## Charts
1553

@@ -19,7 +57,7 @@ https://github.com/github-copilot-resources/copilot-metrics-viewer/assets/332930
1957
2058
Here are the key metrics visualized in these charts:
2159
<p align="center">
22-
<img width="800" alt="image" src="./images/KeyMetrics.png">
60+
<img width="800" alt="Key Metrics Overview" src="./images/main-metrics-dashboard.png">
2361
</p>
2462

2563
1. **Acceptance Rate:** This metric represents the ratio of accepted lines and suggestions to the total suggested by GitHub Copilot. This rate is an indicator of the relevance and usefulness of Copilot's suggestions. However, as with any metric, it should be used with caution as developers use Copilot in many different ways (research, confirm, verify, etc., not always "inject").
@@ -50,31 +88,28 @@ Here are the key metrics visualized in these charts:
5088

5189
Pie charts with the top 5 languages by accepted prompts and acceptance rate (by count/by lines) are displayed at the top.
5290
<p align="center">
53-
<img width="800" alt="image" src="./images/Language_breakdown.png">
91+
<img width="800" alt="Updated Language breakdown with charts and data table" src="./images/languages-breakdown.png">
5492
</p>
5593

56-
The language breakdown analysis tab also displays a table showing the Accepted Prompts, Accepted Lines of Code, and Acceptance Rate (%) for each language over the past 28 days. The entries are sorted by the number of _accepted lines of code descending_.
57-
<p align="center">
58-
<img width="800" alt="image" src="./images/Language_breakdown_list.png">
59-
</p>
94+
The language breakdown analysis tab also displays a table showing the Accepted Prompts, Accepted Lines of Code, and Acceptance Rate (%) for each language over the selected time period. The entries are sorted by the number of _accepted lines of code descending_.
6095

6196
## Copilot Chat Metrics
6297

6398
<p align="center">
64-
<img width="800" alt="image" src="https://github.com/github-copilot-resources/copilot-metrics-viewer/assets/3329307/79867d5f-8933-4509-a58a-8c6deeb47536">
99+
<img width="800" alt="Copilot Chat Metrics Dashboard" src="./images/copilot-chat-metrics.png">
65100
</p>
66101

67-
1. **Cumulative Number of Turns:** This metric represents the total number of turns (interactions) with the Copilot over the past 28 days. A 'turn' includes both user inputs and Copilot's responses.
102+
1. **Cumulative Number of Turns:** This metric represents the total number of turns (interactions) with the Copilot over the selected time period. A 'turn' includes both user inputs and Copilot's responses.
68103

69-
2. **Cumulative Number of Acceptances:** This metric shows the total number of lines of code suggested by Copilot that have been accepted by users over the past 28 days.
104+
2. **Cumulative Number of Acceptances:** This metric shows the total number of lines of code suggested by Copilot that have been accepted by users over the selected time period.
70105

71106
3. **Total Turns | Total Acceptances Count:** This is a chart that displays the total number of turns and acceptances.
72107

73-
4. **Total Active Copilot Chat Users:** A bar chart that illustrates the total number of users who have actively interacted with Copilot over the past 28 days.
108+
4. **Total Active Copilot Chat Users:** A bar chart that illustrates the total number of users who have actively interacted with Copilot over the selected time period.
74109

75110
## Seat Analysis
76111
<p align="center">
77-
<img width="800" alt="image" src="https://github.com/github-copilot-resources/copilot-metrics-viewer/assets/54096296/51747194-df30-4bfb-8849-54a0510fffcb">
112+
<img width="800" alt="Seat Analysis Dashboard" src="./images/seat-analysis.png">
78113
</p>
79114

80115
1. **Total Assigned:** This metric represents the total number of Copilot seats assigned within the current organization/enterprise.
@@ -85,6 +120,33 @@ The language breakdown analysis tab also displays a table showing the Accepted P
85120

86121
4. **No Activity in the Last 7 Days (including never used seats):** A table to display seats that have had no activity in the past 7 days, ordered by the date of last activity. Seats that were used earlier are displayed at the top.
87122

123+
## Advanced Features
124+
125+
### Flexible Date Range Selection
126+
The application supports flexible date range selection allowing users to analyze metrics for any period up to 100 days. The date picker provides an intuitive calendar interface with options to exclude weekends and holidays from the analysis.
127+
128+
### Data Export Capabilities
129+
Multiple export options are available in the API Response tab:
130+
- **Download CSV (Summary)**: Exports key metrics in a condensed format
131+
- **Download CSV (Full)**: Exports comprehensive detailed data
132+
- **Copy Metrics to Clipboard**: Quick copy functionality for immediate use
133+
- **Check Metric Data Quality**: Validates data integrity and completeness
134+
135+
### Team Analytics
136+
Organizations can compare metrics across different teams to:
137+
- Identify high-performing teams
138+
- Understand adoption patterns
139+
- Share best practices across teams
140+
- Monitor team-specific engagement levels
141+
142+
### Model Usage Analytics
143+
Detailed insights into AI model usage including:
144+
- IDE Code Completions by editor and model type
145+
- IDE Chat interactions and model preferences
146+
- GitHub.com Chat usage patterns
147+
- PR Summary generation statistics
148+
- Custom vs. default model adoption rates
149+
88150
## Setup Instructions
89151

90152
In the `.env` file, you can configure several environment variables that control the behavior of the application.

images/100-day-date-range.png

71.9 KB
Loading

images/copilot-chat-metrics.png

172 KB
Loading

images/csv-export-functionality.png

123 KB
Loading

images/date-range-filter.png

84.7 KB
Loading

images/github-com-models-expanded.png

227 KB
Loading

images/github-com-tab.png

212 KB
Loading

images/languages-breakdown.png

164 KB
Loading

images/main-metrics-dashboard.png

362 KB
Loading

images/seat-analysis.png

88.1 KB
Loading

0 commit comments

Comments
 (0)