Skip to content

Commit 4d4f7c5

Browse files
authored
Docs for GitHub-hosted runners management experience
1 parent 1e9b424 commit 4d4f7c5

10 files changed

Lines changed: 66 additions & 1 deletion

File tree

29.6 KB
Loading
21.4 KB
Loading

content/actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ miniTocMaxHeadingLevel: 3
1313
{% data reusables.actions.enterprise-beta %}
1414
{% data reusables.actions.enterprise-github-hosted-runners %}
1515

16-
## Monitoring your workflows
16+
## Monitoring your workflows
17+
18+
{% if github-runner-dashboard %}
19+
### Monitoring your current jobs in your organization or enterprise
20+
21+
{% data reusables.github-actions.github-hosted-runners-check-concurrency %}
22+
23+
{% endif %}
1724

1825
{% ifversion fpt or ghae or ghes > 3.0 or ghec %}
1926

content/actions/using-github-hosted-runners/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ versions:
77
ghes: '*'
88
children:
99
- /about-github-hosted-runners
10+
- /monitoring-your-current-jobs
1011
- /customizing-github-hosted-runners
1112
shortTitle: Use GitHub-hosted runners
1213
---
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Monitoring your current jobs
3+
intro: 'Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints.'
4+
versions:
5+
feature: 'github-runner-dashboard'
6+
shortTitle: Monitoring your current jobs
7+
---
8+
9+
{% data reusables.actions.enterprise-beta %}
10+
{% data reusables.actions.enterprise-github-hosted-runners %}
11+
12+
## Viewing active jobs in your organization or enterprise
13+
14+
You can get a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise.
15+
16+
{% data reusables.github-actions.github-hosted-runners-navigate-to-repo-org-enterprise %}
17+
{% data reusables.github-actions.github-hosted-runners-table-entry %}
18+
1. Review the "Active jobs" section, which contains a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners.
19+
20+
![Screenshot of the list of active jobs](/assets/images/help/settings/actions-runner-active-jobs.png)
21+
22+
## Viewing queued jobs in your organization or enterprise
23+
24+
{% 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)."
25+
26+
The following procedure demonstrates how to check the maximum number of concurrent jobs you can run.
27+
28+
{% data reusables.github-actions.github-hosted-runners-navigate-to-repo-org-enterprise %}
29+
{% data reusables.github-actions.github-hosted-runners-table-entry %}
30+
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`.
31+
![Screenshot of the maximum jobs for an account](/assets/images/help/settings/github-hosted-runners-max-jobs.png)

content/actions/using-jobs/using-concurrency.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,8 @@ miniTocMaxHeadingLevel: 4
1717

1818
{% data reusables.actions.jobs.section-using-concurrency-jobs %}
1919

20+
{% if github-runner-dashboard %}
21+
## Monitoring your current jobs in your organization or enterprise
22+
23+
{% data reusables.github-actions.github-hosted-runners-check-concurrency %}
24+
{% endif %}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
versions:
2+
fpt: '*'
3+
ghec: '*'
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
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.
2+
3+
![Screenshot of a list of active jobs](/assets/images/help/settings/actions-runner-active-jobs.png)
4+
5+
For more information, see "[Monitoring your current jobs](/actions/using-github-hosted-runners/monitoring-your-current-jobs)."
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{% ifversion fpt %}
2+
1. Navigate to the main page of the organization or repository.
3+
1. Click {% octicon "gear" aria-label="The Settings gear" %} **Settings**.
4+
1. In the left sidebar, click **Actions**, then click **Runners**.
5+
{% elsif ghec %}
6+
1. Navigate to your runner settings:
7+
* **In an organization or repository**: Navigate to the main page, then click {% octicon "gear" aria-label="The Settings gear" %} **Settings**.
8+
* **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.
9+
1. Navigate to the {% data variables.product.prodname_actions %} settings:
10+
* **In an organization or repository**: Click **Actions** in the left sidebar, then click **Runners**.
11+
* **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.
12+
{% endif %}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

0 commit comments

Comments
 (0)