diff options
Diffstat (limited to 'doc/ci/runners/runner_fleet_dashboard.md')
| -rw-r--r-- | doc/ci/runners/runner_fleet_dashboard.md | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/ci/runners/runner_fleet_dashboard.md b/doc/ci/runners/runner_fleet_dashboard.md new file mode 100644 index 00000000000..f329561cf4b --- /dev/null +++ b/doc/ci/runners/runner_fleet_dashboard.md @@ -0,0 +1,90 @@ +--- +stage: Verify +group: Runner +info: >- + To determine the technical writer assigned to the Stage/Group associated with + this page, see + https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- +# Runner Fleet Dashboard **(ULTIMATE)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/424495) in GitLab 16.6 + +GitLab administrators can use the Runner Fleet Dashboard to assess the health of your instance runners. +The Runner Fleet Dashboard shows: + +- Recent CI errors related caused by runner infrastructure. +- Number of concurrent jobs executed on most busy runners. +- Histogram of job queue times [(available only with ClickHouse)](#enable-more-ci-analytics-features-with-clickhouse). + +Support for usage and cost analysis are proposed in [epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). + + + +## View the Runner Fleet Dashboard + +Prerequisites: + +- You must be an administrator. + +To view the runner fleet dashboard: + +1. On the left sidebar, at the bottom, select **Admin Area**. +1. Select **Runners**. +1. Select **Fleet dashboard**. + +Most of the dashboard works without any additional actions, with the +exception of **Wait time to pick a job** chart and features proposed in [epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). +These features require [setting up an additional infrastructure](#enable-more-ci-analytics-features-with-clickhouse). + +## Export compute minutes used by instance runners + +Prerequisites: + +- You must be an administrator. + +To analyze runner usage, you can export a CSV file that contains the number of jobs and executed runner minutes. The +CSV file shows the runner type and job status for each project. The CSV is sent to your email when the export is completed. + +To export compute minutes used by instance runners: + +1. On the left sidebar, at the bottom, select **Admin Area**. +1. Select **Runners**. +1. Select **Fleet dashboard**. +1. Select **Export CSV**. + +## Enable more CI analytics features with ClickHouse **(ULTIMATE EXPERIMENT)** + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/11180) in GitLab 16.7 with the [flags](../../administration/feature_flags.md) named `ci_data_ingestion_to_click_house` and `clickhouse_ci_analytics`. Disabled by default. +> - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/424866) in GitLab 16.8. Feature flag `clickhouse_ci_analytics` removed. + +This feature is an [Experiment](../../policy/experiment-beta-support.md). +To test it, we have launched an early adopters program. +To join the list of users testing this feature, see +[epic 11180](https://gitlab.com/groups/gitlab-org/-/epics/11180). + +### Enable ClickHouse integration + +To enable additional CI analytics features: + +1. [Configure ClickHouse integration](../../integration/clickhouse.md) +1. [Enable](../../administration/feature_flags.md#how-to-enable-and-disable-features-behind-flags) the following feature flags: + + | Feature flag name | Purpose | Status | + |------------------------------------|---------------------------------------------------------------------------|------------------------------------| + | `ci_data_ingestion_to_click_house` | Enables synchronization of new finished CI builds to ClickHouse database. | Enabled by default in GitLab 16.8. | + | `clickhouse_ci_analytics` | Enables the **Wait time to pick a job** chart. | Removed in 16.8. | + +<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> +For a video walkthrough, see [Setting up Runner Fleet Dashboard with ClickHouse](https://www.youtube.com/watch?v=YpGV95Ctbpk). + +## Feedback + +To help us improve the Runner Fleet Dashboard, you can provide feedback in +[issue 421737](https://gitlab.com/gitlab-org/gitlab/-/issues/421737). +In particular: + +- How easy or difficult it was to setup GitLab to make the dashboard work. +- How useful you found the dashboard. +- What other information you would like to see on that dashboard. +- Any other related thoughts and ideas. |