Skip to content

Commit

Permalink
Actions Usage Metrics - [Public Beta] (#49865)
Browse files Browse the repository at this point in the history
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
  • Loading branch information
SiaraMist and jc-clark committed Mar 28, 2024
1 parent cde44e6 commit ed9a231
Show file tree
Hide file tree
Showing 17 changed files with 98 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,18 @@ Usage limits apply to self-hosted runners. For more information, see "[AUTOTITLE
In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#a-actions-usage).
{% endif %}

{% ifversion fpt or ghec %}

## {% data variables.product.prodname_actions %} usage metrics

{% data reusables.actions.actions-usage-metrics-beta-note %}

If you are on a {% data variables.product.prodname_ghe_cloud %} plan, organization owners and users with the "View organization Actions usage metrics" permission can view {% data variables.product.prodname_actions %} usage metrics for their organization. These metrics can help understand how and where your Actions minutes are being used. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)."

When you view usage metrics, it is important to remember that {% data reusables.actions.actions-usage-metrics-not-billing-metrics %}

{% endif %}

## Billing for reusable workflows

If you reuse a workflow, billing is always associated with the caller workflow. Assignment of {% data variables.product.prodname_dotcom %}-hosted runners is always evaluated using only the caller's context. The caller cannot use {% data variables.product.prodname_dotcom %}-hosted runners from the called repository.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ children:
- /using-workflow-run-logs
- /enabling-debug-logging
- /notifications-for-workflow-runs
- /viewing-github-actions-usage-metrics-for-your-organization
---
{% data reusables.actions.enterprise-github-hosted-runners %}
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.
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Additionally, you can enforce policies for the use of {% data variables.product.

## Enforcing a policy for visibility of dependency insights

Dependency insights show all packages that repositories within your enterprise's organizations depend on. Dependency insights include aggregated information about security advisories and licenses. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)."
Dependency insights show all packages that repositories within your enterprise's organizations depend on. Dependency insights include aggregated information about security advisories and licenses. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization)."

Across all organizations owned by your enterprise, you can control whether organization members can view dependency insights. You can also allow owners to administer the setting on the organization level. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ For public repositories, only public repositories that depend on it or on packag
You can use the dependency graph to:

- Explore the repositories your code depends on{% ifversion fpt or ghec %}, and those that depend on it{% endif %}. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository)." {% ifversion ghec %}
- View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization#viewing-organization-dependency-insights)."{% endif %}
- View a summary of the dependencies used in your organization's repositories in a single dashboard. For more information, see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization#viewing-organization-dependency-insights)."{% endif %}
- View and update vulnerable dependencies for your repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."
- See information about vulnerable dependencies in pull requests. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ When the dependency graph is first enabled, any manifest and lock files for supp

## Further reading

{% ifversion ghec %}- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %}
{% ifversion ghec %}- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization)"{% endif %}
- "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)"
- "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies)"
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,6 @@ If a manifest or lock file is not processed, its dependencies are omitted from t

- "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)"
- "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)"{% ifversion ghec %}
- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)"{% endif %}{% ifversion fpt or ghec %}
- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization)"{% endif %}{% ifversion fpt or ghec %}
- "[AUTOTITLE](/get-started/privacy-on-github)"
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ children:
- /accessing-your-organizations-settings
- /customizing-your-organizations-profile
- /about-your-organizations-news-feed
- /viewing-insights-for-your-organization
- /viewing-insights-for-dependencies-in-your-organization
- /viewing-usage-metrics-for-github-actions
shortTitle: Collaborate with groups
---

Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: Viewing insights for your organization
intro: 'Organization insights provide data about your organization dependencies.'
title: Viewing insights for dependencies in your organization
intro: Organization dependency insights provide data about your organization dependencies.
redirect_from:
- /articles/viewing-insights-for-your-organization
- /github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization
- /organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization
versions:
ghec: '*'
topics:
- Organizations
- Teams
shortTitle: View organization insights
shortTitle: Dependency insights
permissions: Organization members can view organization insights.
---

Expand Down
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" %}.
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,8 @@ Manage organization Actions policies | Access to manage all settings on the "Act
Manage organization runners and runner groups | Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. | "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#overview-of-github-hosted-runners)"<br><br>"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)"
Manage organization Actions secrets | Access to create and manage Actions organization secrets. | "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization)"
Manage organization Actions variables | Access to create and manage Actions organization variables. | "[AUTOTITLE](/actions/learn-github-actions/variables#creating-configuration-variables-for-an-organization)"
{%- ifversion actions-usage-metrics %}
View organization Actions usage metrics | View {% data variables.product.prodname_actions %} usage metrics for your organization. | "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)"
{%- endif %}

{% endrowheaders %}
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Some of the features listed below are limited to organizations using {% data var
| See all organization members and teams | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
| @mention any visible team | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
| Can be made a _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghec %}
| View organization insights (see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion team-discussions %}
| View organization insights (see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion team-discussions %}
| View and post public team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
| View and post private team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
| Edit and delete team discussions in **all teams** (see "[AUTOTITLE](/communities/moderating-comments-and-conversations/managing-disruptive-comments)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |
Expand Down
4 changes: 4 additions & 0 deletions data/features/actions-usage-metrics.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Issue 13896
# Versioning for Actions Usage Metrics
versions:
ghec: '*'
7 changes: 7 additions & 0 deletions data/reusables/actions/about-actions-usage-metrics.md
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.
1 change: 1 addition & 0 deletions data/reusables/actions/actions-usage-metrics-beta-note.md
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.
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)."
3 changes: 2 additions & 1 deletion src/fixtures/fixtures/versionless-redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,8 @@
- /github/setting-up-and-managing-your-enterprise/managing-use-of-advanced-security-for-organizations-in-your-enterprise-account
- /github/setting-up-and-managing-billing-and-payments-on-github/viewing-your-github-advanced-security-usage

/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization
/enterprise-cloud@latest/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization
- /organizations/collaborating-with-groups-in-organizations/viewing-insights-for-dependencies-in-your-organization
- /organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization
- /articles/viewing-insights-for-your-organization
- /github/setting-up-and-managing-organizations-and-teams/viewing-insights-for-your-organization
Expand Down

0 comments on commit ed9a231

Please sign in to comment.