Skip to content

Commit a8c3a98

Browse files
authored
Merge pull request #43167 from github/repo-sync
Repo sync
2 parents 8773af8 + 9797939 commit a8c3a98

File tree

5 files changed

+68
-3
lines changed

5 files changed

+68
-3
lines changed

content/copilot/concepts/agents/code-review.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ If {% data variables.product.prodname_actions %} is unavailable or if Actions wo
110110

111111
{% data reusables.copilot.code-review.code-review-actions-usage %}
112112

113+
Organizations in this situation can use self-hosted runners. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-self-hosted-runners).
114+
113115
## Code review monthly quota
114116

115117
Each time {% data variables.product.prodname_copilot_short %} reviews a pull request or reviews code in your IDE, your monthly quota of {% data variables.product.prodname_copilot_short %} premium requests is reduced by one.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Configuring self-hosted runners for GitHub Copilot code review
3+
shortTitle: Configure self-hosted runners
4+
intro: 'Learn how to configure self-hosted runners for {% data variables.copilot.copilot_code-review_short %}.'
5+
allowTitleToDifferFromFilename: true
6+
versions:
7+
feature: copilot
8+
topics:
9+
- Copilot
10+
contentType: how-tos
11+
category:
12+
- Author and optimize with Copilot
13+
---
14+
15+
## About {% data variables.product.prodname_actions %} usage for code review tools
16+
17+
{% data reusables.copilot.code-review.code-review-actions-usage %} Organizations in this situation can use self-hosted runners.
18+
19+
## Configuring self-hosted runners for code review
20+
21+
You can run {% data variables.copilot.copilot_code-review_short %} using self-hosted {% data variables.product.prodname_actions %} runners with ARC (Actions Runner Controller). You must first set up ARC-managed scale sets in your environment. For more information on ARC, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-actions-runner-controller).
22+
23+
> [!WARNING]
24+
> ARC is the only officially supported solution for self-hosting {% data variables.copilot.copilot_code-review_short %}. For security reasons, we do not recommend using non-ARC self-hosted runners.
25+
26+
> [!NOTE]
27+
> {% data variables.copilot.copilot_code-review_short %} is only compatible with Ubuntu x64 Linux runners. Runners with Windows, macOS or other operating systems are not supported.
28+
29+
To configure self-hosted runners for {% data variables.copilot.copilot_code-review_short %}:
30+
31+
1. Configure network security controls for your {% data variables.product.prodname_actions %} runners to ensure that {% data variables.copilot.copilot_code-review_short %} does not have open access to your network or the public internet.
32+
33+
You must configure your firewall to allow connections to the [standard hosts required for {% data variables.product.prodname_actions %} self-hosted runners](/actions/reference/runners/self-hosted-runners#accessible-domains-by-function), plus the following hosts:
34+
35+
* `api.githubcopilot.com`
36+
* `uploads.github.com`
37+
* `user-images.githubusercontent.com`
38+
1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment).
39+
40+
```yaml
41+
# ...
42+
43+
jobs:
44+
copilot-setup-steps:
45+
runs-on: arc-scale-set-name
46+
# ...
47+
```

content/copilot/how-tos/use-copilot-agents/request-a-code-review/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ versions:
77
children:
88
- /use-code-review
99
- /configure-automatic-review
10+
- /configure-self-hosted-runners
1011
redirect_from:
1112
- /copilot/using-github-copilot/code-review
1213
- /copilot/how-tos/agents/copilot-code-review
1314
- /copilot/how-tos/agents/request-a-code-review
14-
- /copilot/how-tos/use-copilot-agents/request-a-code-review/configure-self-hosted-runners
1515
contentType: how-tos
1616
---
1717

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)