Skip to main content

Monitor Github Copilot usage

Of course you have provided all your developers with a Github Copilot license. But do you have a clue on how they are using it? In this post I show you how to use the Github Copilot Metrics API to monitor the usage.

Let's dive in...

Connect to the Metrics API

To start calling the Metrics API endpoint, we need to generate a Personal Access Token(PAT).

  • Click on your profile icon in the upper-right corner of any of your Github Pages and choose Settings from the dropdown.

  • In the left sidebar, click on Developer settings at the bottom.


  • Click on Fine-grained tokens under Personal access tokens.

 

  • Click on Generate new token.

 

  • Under Token name, enter a name for the token.

 


  • Set the Resource owner to the organization you want to monitor the metrics for.

  • Under Permissions, select at least the following permission sets:

    • "GitHub Copilot Business" organization permissions (read)

    • "Administration" organization permissions (read)

  • Click Generate token. Copy and save the token to a secure location.

Now you can already try to call the API through Postman for example:

 

Visualize the data with Power BI

If you want to have a better visualization of the results, you can use the provided Power BI dashboard.

  • Clone the repository found here.
  • Go to the samples folder and open the GitHub Copilot - Telemetry Sample (DM).pbix file in Power BI Desktop.
  • Open Power Query Editor by right clicking the GH Copilot – Details data source and selecting Edit query.

 

  • Go to the Advanced Editor and replace the existing lines with the following code:
  • Click Close & Apply to apply the changes and refresh the report.

 

Visualize the data with the Copilot Metrics Viewer

If you don’t have Power BI, you also have the option to use the Copilot Metrics Viewer.

This application displays a set of charts with various metrics related to GitHub Copilot for your GitHub Organization or Enterprise Account. 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.

  • Clone the repository found here.
  • Update the .env file with the following settings:
  • Build the docker image using:
docker build -t copilot-metrics-viewer .
  • Remark: I had to change the line endings to LF for the 99-config-app.sh file before I was able to build and run the image successfully.
  • Run the docker image using:
docker run -p 8080:80 --env-file ./.env copilot-metrics-viewer
  • If we now browse to localhost:8080, you should see the metrics viewer application:

More information

github-copilot-resources/copilot-metrics-viewer-power-bi: A sample Power BI dashboard that leverages the GitHub Copilot Metrics API.

REST API endpoints for GitHub Copilot usage metrics - GitHub Docs

Managing your personal access tokens - GitHub Docs

github-copilot-resources/copilot-metrics-viewer: Tool to visualize the Copilot metrics provided via the Copilot Business Metrics API (current in public beta)

Labels:

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Cache stampede: when our cache turned against us

While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...
Read more

A complex system designed from scratch never works

A few years ago, I worked as an architect on a big mainframe rewrite. I still count it as one of my failures. Not because the technology was wrong, but because I couldn't convince the management team to simplify the approach. Years later, the organization is still struggling to get the new system up and running. I left the project at the time, because I couldn't put my name behind an approach that would take very long and cost a lot of money without a working system to show for it along the way. Gall’s Law That memory keeps coming back to me, because it's a textbook case of Gall's Law playing out in real life. Gall's Law , from John Gall's Systemantics , states it plainly: A complex system that works is invariably found to have evolved from a simple system that worked. A complex system designed from scratch never works, and it cannot be patched to make it work. You have to start over with a simple system that works. What does that mean in practice,...
Read more