Skip to content

Commit 7a16184

Browse files
CopilotkathleenqinCopilotAndrewRPortersunbrye
authored
Docs for v0 CLI telemetry in Copilot usage metrics (#59886)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kathleenqin <36471738+kathleenqin@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Andrew Porter <andrewrporter@github.com> Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
1 parent 62448dc commit 7a16184

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For guidance on how to read and interpret these metrics, see [AUTOTITLE](/copilo
2323

2424
## {% data variables.product.prodname_copilot_short %} usage dashboard metrics
2525

26-
These metrics appear directly in the {% data variables.product.prodname_copilot_short %} usage dashboard.
26+
These metrics appear directly in the {% data variables.product.prodname_copilot_short %} usage dashboard. These charts do **not** include {% data variables.copilot.copilot_cli_short %} usage.
2727

2828
| Metric | Description |
2929
|:--|:--|
@@ -89,6 +89,20 @@ These fields appear in the exported NDJSON reports and in the {% data variables.
8989
| `totals_by_language_feature` | Breakdown combining language and feature dimensions. |
9090
| `totals_by_model_feature` / `totals_by_language_model` | Model-specific breakdowns for chat activity (not completions). |
9191
| `last_known_ide_version` / `last_known_plugin_version` | The most recent IDE and {% data variables.copilot.copilot_chat_short %} extension version detected for each user. |
92+
| `daily_active_cli_users` | Number of unique users in the enterprise who used {% data variables.product.prodname_copilot_short %} via the CLI on a given day. This field is **independent** of IDE active user counts and is **not** included in IDE-based active user definitions. Omitted for enterprises with no CLI usage on that day. |
93+
| `totals_by_cli` | Breakdown of CLI-specific metrics for the enterprise on a given day. Independent of IDE metrics—CLI usage is **not** reflected in other fields such as `totals_by_ide` or `totals_by_feature`. Omitted for enterprises with no CLI usage on that day. See [{% data variables.copilot.copilot_cli_short %} metrics fields](#copilot-cli-metrics-fields-api-only) below. |
94+
95+
### {% data variables.copilot.copilot_cli_short %} metrics fields (API only)
96+
97+
The `totals_by_cli` object contains the following nested fields when CLI usage is present. These metrics are currently only available in the enterprise-level reports.
98+
99+
| Field | Description |
100+
|:--|:--|
101+
| `totals_by_cli.session_count` | Number of distinct CLI sessions initiated on this day. |
102+
| `totals_by_cli.request_count` | Total number of requests made to {% data variables.product.prodname_copilot_short %} via the CLI on this day, including both user-initiated prompts and automated agentic follow-up calls. |
103+
| `totals_by_cli.token_usage.output_tokens_sum` | Total number of output tokens generated across all CLI requests on this day. |
104+
| `totals_by_cli.token_usage.prompt_tokens_sum` | Total number of prompt tokens sent across all CLI requests on this day. |
105+
| `totals_by_cli.token_usage.avg_tokens_per_request` | Average number of **output** and **prompt** tokens per CLI request, computed as `(output_tokens_sum + prompt_tokens_sum) ÷ request_count`.|
92106

93107
### Pull request activity fields (API only)
94108

content/copilot/reference/copilot-usage-metrics/reconciling-usage-metrics.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@ The {% data variables.product.prodname_copilot_short %} usage metrics dashboard,
2323

2424
## Prerequisite
2525

26-
{% data variables.product.prodname_copilot_short %} usage metrics depend on **telemetry from users’ IDEs**. If a developer has disabled telemetry in their IDE, their {% data variables.product.prodname_copilot_short %} activity will **not** appear in the dashboard, API reports, or exported data.
26+
IDE-based {% data variables.product.prodname_copilot_short %} usage metrics depend on **telemetry from users’ IDEs**. If a developer has disabled telemetry in their IDE, their IDE-based {% data variables.product.prodname_copilot_short %} activity will **not** appear in the dashboard, API reports, or exported data.
2727

2828
If you notice missing users or unexpectedly low adoption numbers, verify IDE telemetry settings before troubleshooting other causes.
2929

30+
{% data variables.copilot.copilot_cli_short %} metrics (`daily_active_cli_users` and `totals_by_cli`) are collected and reported separately from IDE telemetry. CLI usage does **not** contribute to IDE-based active user counts or other IDE metrics.
31+
3032
## Metric alignment
3133

3234
The dashboard and APIs use shared definitions for key metrics:

0 commit comments

Comments
 (0)