VS Copilot Metrics

Overview 🚀

VS Copilot Metrics is an extension that tracks usage statistics of GitHub Copilot within your Visual Studio environment. It provides insights into completion counts, generated code character counts (via tab key presses), and chat codeblock generation, giving users a clear understanding of their AI-assisted coding productivity.

While the extension's name references "Copilot," it remains AI-agnostic for models that offer inline completions. However, for chat codeblock generation, the extension currently tracks only GitHub Copilot interactions.

Telemetry 📡

The extension provides integration with a telemetry server for comprehensive project usage metrics analysis.

Configuration

Users can configure the following details in their session:

• Telemetry server address
• API key (sent as x-api-key header)
• Username
• Project name

The server address, API key, and username are saved in the global session, while the project name is saved in the workspace session.

Customizable Endpoints

You can personalize the following endpoints in the extension settings:

1. Metrics endpoint: for sending metrics data
2. Users endpoint: for retrieving the list of users to display in the quickpick
3. Projects endpoint: for retrieving the list of projects to display in the quickpick

Username and Project Name Configuration

Configure the username and project name in two ways:

1. Enter the value directly in the input field
2. Configure endpoints in the extension settings to activate a remote quickpick, fetching the list of projects from your backend

For remote quickpick, the request should follow this structure:

[
  {
    "label": "string",
    "description": "string" // optional
  }
]

Remote Collection

Once configured, metrics are dispatched individually for each accepted suggestion. This facilitates remote collection of fine-grained data, allowing integration into preferred analytics platforms.

Telemetry payload structure:

{
  username: string;
  project_name: string;
  total_lines_generated: number;
  total_chars_generated: number;
  language_id: string;
  editor: "visual_studio";
  plugin_version: string;
}

Requirements 📦

No specific prerequisites are necessary. The extension seamlessly integrates with any AI model offering inline completions within Visual Studio.

Author 🧑‍💻

NTTData Italia