diff --git a/assets/images/help/settings/actions-runner-active-jobs.png b/assets/images/help/settings/actions-runner-active-jobs.png new file mode 100644 index 0000000000..6ffe07ecc6 Binary files /dev/null and b/assets/images/help/settings/actions-runner-active-jobs.png differ diff --git a/assets/images/help/settings/github-hosted-runners-max-jobs.png b/assets/images/help/settings/github-hosted-runners-max-jobs.png new file mode 100644 index 0000000000..10d6461564 Binary files /dev/null and b/assets/images/help/settings/github-hosted-runners-max-jobs.png differ diff --git a/content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md b/content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md index 116c5b3072..0b8d45730f 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md @@ -13,7 +13,14 @@ miniTocMaxHeadingLevel: 3 {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} -## Monitoring your workflows +## Monitoring your workflows + +{% if github-runner-dashboard %} +### Monitoring your current jobs in your organization or enterprise + +{% data reusables.github-actions.github-hosted-runners-check-concurrency %} + +{% endif %} {% ifversion fpt or ghae or ghes > 3.0 or ghec %} diff --git a/content/actions/using-github-hosted-runners/index.md b/content/actions/using-github-hosted-runners/index.md index c35d53ff24..74adb103aa 100644 --- a/content/actions/using-github-hosted-runners/index.md +++ b/content/actions/using-github-hosted-runners/index.md @@ -7,6 +7,7 @@ versions: ghes: '*' children: - /about-github-hosted-runners + - /monitoring-your-current-jobs - /customizing-github-hosted-runners shortTitle: Use GitHub-hosted runners --- diff --git a/content/actions/using-github-hosted-runners/monitoring-your-current-jobs.md b/content/actions/using-github-hosted-runners/monitoring-your-current-jobs.md new file mode 100644 index 0000000000..022b7e310e --- /dev/null +++ b/content/actions/using-github-hosted-runners/monitoring-your-current-jobs.md @@ -0,0 +1,31 @@ +--- +title: Monitoring your current jobs +intro: 'Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints.' +versions: + feature: 'github-runner-dashboard' +shortTitle: Monitoring your current jobs +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +## Viewing active jobs in your organization or enterprise + +You can get a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise. + +{% data reusables.github-actions.github-hosted-runners-navigate-to-repo-org-enterprise %} +{% data reusables.github-actions.github-hosted-runners-table-entry %} +1. Review the "Active jobs" section, which contains a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners. + + ![Screenshot of the list of active jobs](/assets/images/help/settings/actions-runner-active-jobs.png) + +## Viewing queued jobs in your organization or enterprise + +{% data variables.product.prodname_dotcom %}-hosted runners allow you to run jobs concurrently, and the maximum number of concurrent jobs will vary depending on your plan. If you reach the maximum number of concurrent jobs, any new jobs will start to enter a queue. To find out more about the number of concurrent jobs available to your plan, see "[Usage limits, billing, and administration](/actions/learn-github-actions/usage-limits-billing-and-administration)." + +The following procedure demonstrates how to check the maximum number of concurrent jobs you can run. + +{% data reusables.github-actions.github-hosted-runners-navigate-to-repo-org-enterprise %} +{% data reusables.github-actions.github-hosted-runners-table-entry %} +1. Review the "All jobs usage" section, which lists the number of active jobs and the maximum number of jobs you can run. In this example, `9` jobs are currently running out of a maximum of `180`. + ![Screenshot of the maximum jobs for an account](/assets/images/help/settings/github-hosted-runners-max-jobs.png) diff --git a/content/actions/using-jobs/using-concurrency.md b/content/actions/using-jobs/using-concurrency.md index 0adbbe915a..be98d664c6 100644 --- a/content/actions/using-jobs/using-concurrency.md +++ b/content/actions/using-jobs/using-concurrency.md @@ -17,3 +17,8 @@ miniTocMaxHeadingLevel: 4 {% data reusables.actions.jobs.section-using-concurrency-jobs %} +{% if github-runner-dashboard %} +## Monitoring your current jobs in your organization or enterprise + +{% data reusables.github-actions.github-hosted-runners-check-concurrency %} +{% endif %} \ No newline at end of file diff --git a/data/features/github-runner-dashboard.yml b/data/features/github-runner-dashboard.yml new file mode 100644 index 0000000000..14ba8f5e2d --- /dev/null +++ b/data/features/github-runner-dashboard.yml @@ -0,0 +1,3 @@ +versions: + fpt: '*' + ghec: '*' diff --git a/data/reusables/github-actions/github-hosted-runners-check-concurrency.md b/data/reusables/github-actions/github-hosted-runners-check-concurrency.md new file mode 100644 index 0000000000..76804fd4cd --- /dev/null +++ b/data/reusables/github-actions/github-hosted-runners-check-concurrency.md @@ -0,0 +1,5 @@ +To identify any constraints with concurrency or queuing, you can check how many jobs are currently being processed on the {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise. + +![Screenshot of a list of active jobs](/assets/images/help/settings/actions-runner-active-jobs.png) + +For more information, see "[Monitoring your current jobs](/actions/using-github-hosted-runners/monitoring-your-current-jobs)." \ No newline at end of file diff --git a/data/reusables/github-actions/github-hosted-runners-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/github-hosted-runners-navigate-to-repo-org-enterprise.md new file mode 100644 index 0000000000..ab40fbc875 --- /dev/null +++ b/data/reusables/github-actions/github-hosted-runners-navigate-to-repo-org-enterprise.md @@ -0,0 +1,12 @@ +{% ifversion fpt %} +1. Navigate to the main page of the organization or repository. +1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. +1. In the left sidebar, click **Actions**, then click **Runners**. +{% elsif ghec %} +1. Navigate to your runner settings: + * **In an organization or repository**: Navigate to the main page, then click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **If using an enterprise account**: Navigate to your enterprise account by clicking your profile photo in the top-right corner of {% data variables.product.prodname_dotcom_the_website %}, then clicking **Your enterprises**, then clicking the enterprise. +1. Navigate to the {% data variables.product.prodname_actions %} settings: + * **In an organization or repository**: Click **Actions** in the left sidebar, then click **Runners**. + * **If using an enterprise account**: In the left sidebar, click **"{% octicon "law" aria-label="The law icon" %} Policies"**, then click **Actions**, then click the **Runners** tab. +{% endif %} diff --git a/data/reusables/github-actions/github-hosted-runners-table-entry.md b/data/reusables/github-actions/github-hosted-runners-table-entry.md new file mode 100644 index 0000000000..cb4e59b206 --- /dev/null +++ b/data/reusables/github-actions/github-hosted-runners-table-entry.md @@ -0,0 +1 @@ +1. In the "Runners" table, click the entry for **GitHub-hosted runners**. This entry will only be present if you're using {% data variables.product.prodname_dotcom %}-hosted runners. \ No newline at end of file