Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions content/billing/managing-your-billing/about-usage-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,26 @@ permissions: '{% data reusables.permissions.enhanced-billing-platform %}'
product: '{% data reusables.billing.enhanced-billing-platform-product %}'
---

The usage report shows detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.
The usage report shows detailed information about your account’s {% data variables.product.github %} usage, including how much of each SKU was used and the resulting billable amount.

To generate a usage report, see [AUTOTITLE](/billing/managing-your-billing/gathering-insights-on-your-spending).

## Usage report types

### Summarized report

The summarized usage report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `repository`, `cost_center_name`. If the usage report is for an enterprise with organizations, the amounts will be summarized by the organization value as well.

Summarized reports can be requested for a maximum time frame of one year.

### Detailed report

The detailed usage report includes the same fields as the summarized report and adds `username` and `workflow_path`.

The detailed usage report sums the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `organization`, `repository`, `cost_center_name`, `username`, `workflow_path`.

Detailed reports can be requested for a maximum time frame of 31 days.

## Usage report fields

The usage report contains the following fields.
Expand All @@ -30,10 +46,10 @@ The usage report contains the following fields.
| `gross_amount` | The amount of the product SKU that was used. |
| `discount_amount` | The amount of usage that was discounted. Usage that is discounted as part of your account’s included usage is reflected in this field. Also includes discounts for {% data variables.product.prodname_actions %} usage for standard {% data variables.product.github %}-hosted runners in public repositories and for self-hosted runners. |
| `net_amount` | The billable amount of usage after applying the `discount_amount`. This is the amount that your account will be billed. `gross_amount - discount_amount = net_amount`. |
| `username` | The user associated with the usage, if applicable. |
| `username` | The user associated with the usage, if applicable. Only available in the detailed report. |
| `organization` | The organization associated with the usage, if applicable. |
| `repository` | The repository associated with the usage, if applicable. |
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. |
| `workflow_path` | The path of the {% data variables.product.prodname_actions %} workflow that generated the usage, if applicable. Only available in the detailed report. |
| `cost_center_name` | The cost center associated with the usage, if applicable. |

### Deprecated report fields
Expand All @@ -45,10 +61,6 @@ The usage report contains the following fields.
| `usage_at` | Refer to `date` instead. |
| `workflow_name` | Refer to `workflow_path` instead. |

## How usage is summarized

To reduce the size of the report, similar usage entries are grouped and totaled. The report summarizes the `quantity`, `gross_amount`, `discount_amount`, and `net_amount` fields based on the combination of the following values: `date`, `sku`, `username`, `workflow_path`, `repository`, `cost_center_name`.

## Receiving the report

Usage reports are sent via email to the default email address associated with your {% data variables.product.github %} account.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Excluding content from GitHub Copilot
shortTitle: Exclude content from Copilot
intro: 'You can prevent {% data variables.product.prodname_copilot_short %} from accessing certain content.'
permissions: 'Repository administrators{% ifversion ghec%}, organization owners, and enterprise owners{% else %} and organization owners{% endif %} can manage content exclusion settings. People with the "Maintain" role for a repository can view, but not edit, content exclusion settings for that repository.'
permissions: 'Repository administrators, organization owners, and enterprise owners can manage content exclusion settings. People with the "Maintain" role for a repository can view, but not edit, content exclusion settings for that repository.'
product: '{% data reusables.gated-features.copilot-business-and-enterprise %}'
layout: inline
versions:
Expand All @@ -22,9 +22,9 @@ topics:
- Copilot
---

## About content exclusions for {% data variables.product.prodname_copilot_short %}
## About content exclusion for {% data variables.product.prodname_copilot_short %}

You can use content exclusions to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When you exclude content from {% data variables.product.prodname_copilot_short %}:
You can use content exclusion to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When you exclude content from {% data variables.product.prodname_copilot_short %}:

* Code completion will not be available in the affected files.
* The content in affected files will not inform code completion suggestions in other files.
Expand All @@ -33,11 +33,13 @@ You can use content exclusions to configure {% data variables.product.prodname_c

### Who can configure content exclusion

Repository administrators{% ifversion ghec %}, organization owners, and enterprise owners{% else %} and organization owners{% endif %} can configure content exclusion.
Repository administrators, organization owners, and enterprise owners can configure content exclusion.

{% data reusables.copilot.content-exclusions-scope %}

### Availability of content exclusions
### Availability of content exclusion

The {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} plans provide the following level of support for content exclusion.

| Tool | Code completion support | {% data variables.copilot.copilot_chat_short %} support |
|-------------------------------------------------|:---------------------------------------------:|:----------------------------------------------------------------:|
Expand All @@ -57,7 +59,7 @@ Content exclusions also apply to {% data variables.copilot.copilot_code-review_s
> * Content exclusion is in {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website and in {% data variables.product.prodname_mobile %} and is subject to change.
> * Content exclusion is currently not supported in Edit and Agent modes of {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode %}.

### Limitations of content exclusions
### Limitations of content exclusion

{% data reusables.copilot.content-exclusion-limitations %}

Expand All @@ -67,16 +69,16 @@ Currently, content exclusions do not apply to symbolic links (symlinks).

After you configure content exclusion, the client (for example, the {% data variables.product.prodname_copilot_short %} extension for {% data variables.product.prodname_vscode_shortname %}) sends the current repository URL to the {% data variables.product.prodname_dotcom %} server so that the server can return the correct policy to the client. These URLs are not logged anywhere.

## Configuring content exclusions for your repository
## Configuring content exclusion for your repository

You can use your repository settings to specify content in your repository that {% data variables.product.prodname_copilot %} should ignore.

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}

1. In the "Code & automation" section of the sidebar, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**.
1. In the "Code & automation" section of the sidebar, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}** then click **Content exclusion**.

If your repository inherits any exclusions from {% ifversion fpt %}its parent organization{% else %} organizations in the same enterprise{% endif %}, you'll see {% ifversion ghec %}one or more{% else %} a{% endif %} gray box{% ifversion ghec %}es{% endif %} at the top of the page containing details of these exclusions. You cannot edit these settings.
If your repository inherits any exclusions from its parent organization, or from organizations in the same enterprise, you'll see one or more gray boxes at the top of the page, containing details of these exclusions. You cannot edit these settings.

1. In the box following "Paths to exclude in this repository," enter the paths to files from which {% data variables.product.prodname_copilot_short %} should be excluded.

Expand All @@ -103,7 +105,7 @@ You can use your repository settings to specify content in your repository that
- "/scripts/**"
```

## Configuring content exclusions for your organization
## Configuring content exclusion for your organization

You can use your organization settings to specify files that {% data variables.product.prodname_copilot %} should ignore. The files can be within a Git repository or anywhere on the file system that is not under Git control.

Expand Down Expand Up @@ -186,23 +188,19 @@ [email protected]:gitlab-org/gitlab-runner.git:
- "**/security/**"
```

{% ifversion ghec %}

## Configuring content exclusions for your enterprise
## Configuring content exclusion for your enterprise

As an enterprise owner, you can use the enterprise settings to specify files that {% data variables.product.prodname_copilot %} should ignore. The files can be within a Git repository or anywhere on the file system that is not under Git control.

{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.policies-tab %}
{% data reusables.enterprise-accounts.copilot-tab %}
1. Click the **Content exclusion** tab.
1. Use paths to specify which content to exclude. See the previous section, [Configuring content exclusions for your organization](#configuring-content-exclusions-for-your-organization).
1. Use paths to specify which content to exclude. See the previous section, [Configuring content exclusion for your organization](#configuring-content-exclusion-for-your-organization).

> [!NOTE]
> The key difference between setting content exclusion at the enterprise level and the organization level is that rules set at the enterprise level apply to all {% data variables.product.prodname_copilot_short %} users in the enterprise, whereas the rules set by organization owners only apply to users who are assigned a {% data variables.product.prodname_copilot_short %} seat by that organization.

{% endif %}

## Testing changes to content exclusions

You can use your IDE to confirm that your changes to content exclusions are working as expected.
Expand All @@ -220,13 +218,19 @@ After you add or change content exclusions, it can take up to 30 minutes to take

### Test your content exclusions

There are a few different ways to test your content exclusions, depending on which IDE you're using.
You can verify that content exclusions you have configured are working as expected.

1. First confirm that content exclusion is working in files that are not subject to content exclusion. To do this:
* In your IDE, open a file that is not subject to content exclusion.
* Make an edit that would normally generate a code completion suggestion. A suggestion should be offered
1. Open a file that should be excluded and make the same edit. No suggestion should be offered.
1. To test content exclusion for {% data variables.copilot.copilot_chat_short %}:
* In your IDE, open the {% data variables.copilot.copilot_chat_short %} panel.
* Open a file that should be excluded and close any other files that are open in the editor.
* Make sure that the open file is attached to the prompt as the context file.
* Enter the prompt `explain this file`.

1. Open a file that you expect to be affected by your content exclusions.
1. Use one or more of the following techniques to test if content is being excluded:
* **In JetBrains IDEs, {% data variables.product.prodname_vs %}, and {% data variables.product.prodname_vscode %}**, check the {% data variables.product.prodname_copilot_short %} icon in the status bar. If a {% data variables.product.prodname_copilot_short %} content exclusion applies to the file, the {% data variables.product.prodname_copilot_short %} icon will have a diagonal line through it. Hover over the icon to see whether an organization or the parent repository disabled {% data variables.product.prodname_copilot_short %} for the file.
* **In Vim/Neovim**, begin typing in the file. If {% data variables.product.prodname_copilot %} no longer provides inline suggestions as you type, the file is excluded.
* You can also test content exclusions in {% data variables.copilot.copilot_chat_short %}. Open the {% data variables.copilot.copilot_chat_short %} window, and ask {% data variables.copilot.copilot_chat_short %} a question about the excluded file. If your content is excluded successfully, {% data variables.product.prodname_copilot_short %} will be unable to answer your question, and will explain that some files were excluded from the conversation due to content exclusion rules.
If the file is excluded, {% data variables.copilot.copilot_chat_short %} will not be able to use the file to generate a response. The file will not be listed as a reference in {% data variables.product.prodname_copilot_short %}'s response.

## Further reading

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ shortTitle: Allow Copilot traffic

If your company employs security measures like a firewall or proxy server, you should add the following URLs, ports, and protocols to an allowlist to ensure {% data variables.product.prodname_copilot_short %} works as expected:

## GitHub Enterprise Related URLs
## {% data variables.product.prodname_enterprise %} related URLs

| Domain and/or URL | Purpose |
| :------------------------------------- | :--------------------------------- |
| `https://github.com/YOUR-ENTERPRISE/*` | Enterprise URL |
| `https://github.com/YOUR-ENTERPRISE?*` | Enterprise URL |
| `https://github.com/enterprises/YOUR-ENTERPRISE/*` | Authentication for {% data variables.enterprise.prodname_managed_users %}, only required with {% data variables.product.prodname_emus %} |

## GitHub Public URLs
## {% data variables.product.github %} public URLs

| Domain and/or URL | Purpose |
| :------------------------------------- | :--------------------------------- |
| `https://github.com/login/*` | Authentication, only required with Personal Users |
Expand All @@ -44,7 +46,8 @@ If your company employs security measures like a firewall or proxy server, you s
| `https://github.com/switch_account?*` | Switch Account |
| `https://github.com/switch_account/*` | Switch Account |

## GitHub Copilot Related URLs
## {% data variables.product.prodname_copilot_short %} related URLs

| Domain and/or URL | Purpose |
| :------------------------------------- | :--------------------------------- |
| `https://api.github.com/copilot_internal/*` | User Management |
Expand All @@ -57,13 +60,11 @@ If your company employs security measures like a firewall or proxy server, you s
| `https://*.business.githubcopilot.com/*`[^3] | API service for {% data variables.product.prodname_copilot_short %} suggestions |
| `https://*.enterprise.githubcopilot.com/*`[^4] | API service for {% data variables.product.prodname_copilot_short %} suggestions |


If your organization is using Microsoft Extra ID, you also need to add the following URLs to the allowlist:
- `https://login.microsoftonline.com/*`
- `https://aadcdn.msauth.net/*`
- `https://login.live.com/*`
- `https://*.activedirectory.windowsazure.com/*`

If your organization is using Microsoft Entra ID, you also need to add the following URLs to the allowlist:
* `https://login.microsoftonline.com/*`
* `https://aadcdn.msauth.net/*`
* `https://login.live.com/*`
* `https://*.activedirectory.windowsazure.com/*`

Depending on the security policies and editors your organization uses, you may need to allowlist additional domains and URLs. For more information on specific editors, see [Further reading](#further-reading).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,4 @@ To summarize:
## Further reading

* [AUTOTITLE](/enterprise-cloud@latest/copilot/customizing-copilot/managing-copilot-knowledge-bases)
* [AUTOTITLE](/enterprise-cloud@latest/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot)
* [AUTOTITLE](/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task)
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,5 @@ Planning and implementing an effective enablement process is essential to drive
Enhance the {% data variables.product.prodname_copilot_short %} experience for your organization by:

* **Setting up knowledge bases** for use with {% data variables.copilot.copilot_chat_short %} _({% data variables.copilot.copilot_enterprise_short %} only)_. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-copilot-knowledge-bases).
* **Fine tuning {% data variables.product.prodname_copilot_short %}** by creating a custom large language model. See [AUTOTITLE](/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot).
* **Installing {% data variables.copilot.copilot_extensions_short %}** to integrate other tools with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/installing-github-copilot-extensions-for-your-organization).
* **Adding {% data variables.copilot.copilot_coding_agent %}** as a team member to work asynchronously on issues. See [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org).
Loading
Loading