forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Actions Usage Metrics - [Public Beta] (#49865)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
- Loading branch information
Showing
17 changed files
with
98 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 16 additions & 0 deletions
16
...hooting-workflows/viewing-github-actions-usage-metrics-for-your-organization.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: Viewing GitHub Actions usage metrics for your organization | ||
shortTitle: GitHub Actions usage metrics | ||
intro: 'Organization owners and CI/CD administrators can view usage metrics for how and where their organization uses {% data variables.product.prodname_actions %}.' | ||
permissions: 'Organization owners and users with the "View organization Actions usage metrics" permissions.' | ||
product: 'Your organization must be on a {% data variables.product.prodname_ghe_cloud %} plan.' | ||
versions: | ||
fpt: '*' | ||
ghec: '*' | ||
--- | ||
|
||
{% data reusables.actions.actions-usage-metrics-beta-note %} | ||
|
||
If you are on a {% data variables.product.prodname_ghe_cloud %} plan, {% data reusables.actions.about-actions-usage-metrics %} | ||
|
||
For more information about how to use {% data variables.product.prodname_actions %} usage metrics, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)" in the {% data variables.product.prodname_ghe_cloud %} documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 4 additions & 3 deletions
7
...viewing-insights-for-your-organization.md → ...-for-dependencies-in-your-organization.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
...rating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Viewing usage metrics for GitHub Actions | ||
shortTitle: GitHub Actions usage metrics | ||
intro: 'GitHub Actions usage metrics provide insights into how and where your organization is using resources for its CI/CD pipelines.' | ||
permissions: 'Organization owners and users with the "View organization Actions usage metrics" permission.' | ||
product: 'Your organization must be on a {% data variables.product.prodname_ghe_cloud %} plan.' | ||
versions: | ||
feature: actions-usage-metrics | ||
--- | ||
|
||
{% data reusables.actions.actions-usage-metrics-beta-note %} | ||
|
||
## About {% data variables.product.prodname_actions %} usage metrics | ||
|
||
{% data reusables.actions.about-actions-usage-metrics %} | ||
|
||
{% data reusables.actions.actions-usage-metrics-not-billing-metrics %} | ||
|
||
## Enabling access to {% data variables.product.prodname_actions %} usage metrics | ||
|
||
Organization owners can create custom organization roles to allow people to view {% data variables.product.prodname_actions %} usage metrics for their organization. To provide users with access, select the "View organization Actions usage metrics" role when creating a custom organization role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." | ||
|
||
## Viewing {% data variables.product.prodname_actions %} usage metrics | ||
|
||
{% data reusables.profile.access_org %} | ||
{% data reusables.user-settings.access_org %} | ||
{% data reusables.organizations.insights %} | ||
1. In the "Insights" navigation menu, click **Actions Usage Metrics**. | ||
1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. | ||
1. Click on the tab that contains the usage metrics you would like to view. For more information, see "[About {% data variables.product.prodname_actions %} usage metrics](#about-github-actions-usage-metrics)." | ||
1. Optionally, to filter the data displayed in a tab, create a filter. | ||
1. Click on the **{% octicon "filter" aria-hidden="true" %} Filter** button. | ||
1. Click **{% octicon "plus" aria-hidden="true" %} Add a filter**. | ||
1. Choose a metric you would like to filter results by. | ||
1. Depending on the metric you chose, fill out information in the "Qualifier," "Operator," and "Value" columns. | ||
1. Optionally, click **{% octicon "plus" aria-hidden="true" %} Add a filter** to add another filter. | ||
1. Click **Apply**. | ||
1. Optionally, to download usage metrics to a CSV file, click {% octicon "download" aria-label="Download report" %}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Issue 13896 | ||
# Versioning for Actions Usage Metrics | ||
versions: | ||
ghec: '*' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{% data variables.product.prodname_actions %} usage metrics enable you to analyze how your organization is using Actions minutes. You can view usage information related to: | ||
|
||
- **Workflows**. View usage data for each workflow in your organization, and use this information to identify opportunities for optimization, such as refactoring a workflow or using a {% data variables.actions.hosted_runner %}. | ||
- **Jobs**. See which jobs are the most resource-intensive and where they are running. | ||
- **Repositories**. Get a high-level snapshot of each repository in your organization and their volume of Actions minutes usage. | ||
- **Runtime OS**. Understand how runners for each operating system are using Actions minutes and what types of operating systems your workflows are running on most often. | ||
- **Runner type**. Compare how your self-hosted runners and GitHub-hosted runners use Actions minutes and the volume of workflow runs for each type of runner. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
>[!NOTE] {% data variables.product.prodname_actions %} usage metrics are in beta and subject to change. |
3 changes: 3 additions & 0 deletions
3
data/reusables/actions/actions-usage-metrics-not-billing-metrics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{% data variables.product.prodname_actions %} usage metrics do not apply minute multipliers to the metrics displayed. While they _can_ help you understand your bill, their primary purpose is to help you understand how and where Actions minutes are being used in your organization. | ||
|
||
For more information about minute multipliers, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers)." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters