diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-08-13 18:10:03 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-08-13 18:10:03 +0300 |
commit | 6df7943512ca90323c69b926404cc561b6305ce2 (patch) | |
tree | 5dbdb697f641358516ddae9b45ab8bae5d58de81 /doc/operations/metrics | |
parent | 5605efec12c99adf88f641391cb879dedf8fa05e (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/operations/metrics')
-rw-r--r-- | doc/operations/metrics/dashboards/default.md | 2 | ||||
-rw-r--r-- | doc/operations/metrics/dashboards/img/actions_menu_create_add_panel_v13_3.png | bin | 0 -> 9982 bytes | |||
-rw-r--r-- | doc/operations/metrics/dashboards/img/actions_menu_create_new_dashboard_v13_3.png | bin | 18560 -> 14957 bytes | |||
-rw-r--r-- | doc/operations/metrics/dashboards/img/k8s_pod_health_dashboard_v13_3.png | bin | 0 -> 60933 bytes | |||
-rw-r--r-- | doc/operations/metrics/dashboards/index.md | 43 |
5 files changed, 12 insertions, 33 deletions
diff --git a/doc/operations/metrics/dashboards/default.md b/doc/operations/metrics/dashboards/default.md index 78771861222..f086d7737bd 100644 --- a/doc/operations/metrics/dashboards/default.md +++ b/doc/operations/metrics/dashboards/default.md @@ -34,3 +34,5 @@ This dashboard displays CPU, memory, network and disk metrics for the pods in yo [connected K8s cluster](../../../user/project/clusters/index.md). It provides a [variable selector](templating_variables.md#metric_label_values-variable-type) at the top of the dashboard to select which pod's metrics to display. + +![K8s pod health dashboard](img/k8s_pod_health_dashboard_v13_3.png) diff --git a/doc/operations/metrics/dashboards/img/actions_menu_create_add_panel_v13_3.png b/doc/operations/metrics/dashboards/img/actions_menu_create_add_panel_v13_3.png Binary files differnew file mode 100644 index 00000000000..e03fbef3b35 --- /dev/null +++ b/doc/operations/metrics/dashboards/img/actions_menu_create_add_panel_v13_3.png diff --git a/doc/operations/metrics/dashboards/img/actions_menu_create_new_dashboard_v13_3.png b/doc/operations/metrics/dashboards/img/actions_menu_create_new_dashboard_v13_3.png Binary files differindex 4b7a8418eef..ba4780b730b 100644 --- a/doc/operations/metrics/dashboards/img/actions_menu_create_new_dashboard_v13_3.png +++ b/doc/operations/metrics/dashboards/img/actions_menu_create_new_dashboard_v13_3.png diff --git a/doc/operations/metrics/dashboards/img/k8s_pod_health_dashboard_v13_3.png b/doc/operations/metrics/dashboards/img/k8s_pod_health_dashboard_v13_3.png Binary files differnew file mode 100644 index 00000000000..dc0bc951500 --- /dev/null +++ b/doc/operations/metrics/dashboards/img/k8s_pod_health_dashboard_v13_3.png diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index 73909e977c6..11d2dc45008 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -32,7 +32,7 @@ To create a new dashboard from the GitLab user interface: 1. Sign in to GitLab as a user with Maintainer or Owner [permissions](../../../user/permissions.md#project-members-permissions). 1. Navigate to your dashboard at **Operations > Metrics**. -1. In the top-right corner of your dashboard, click the **{{ellipsis_v}}** **More actions** menu, +1. In the top-right corner of your dashboard, click the **{ellipsis_v}** **More actions** menu, and select **Create new**: ![Monitoring Dashboard actions menu with create new item](img/actions_menu_create_new_dashboard_v13_3.png) 1. In the modal window, click **Open Repository**, then follow the instructions @@ -75,49 +75,26 @@ supported and won't be available in the UI. ## Add a new metrics panel to a dashboard -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228761) in GitLab 13.3 behind a disabled [feature flag](../../../administration/feature_flags.md): `metrics_dashboard_new_panel_page`. +> UI option [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228761) in GitLab 13.3. The metrics dashboard supports various [multiple panel types](../../../operations/metrics/dashboards/panel_types.md). You can quickly test how a panel configuration would display in your metrics dashboard with the **Add Panel** page: 1. Sign in to GitLab as a user with Maintainer or Owner - [permissions](../../../user/permissions.md#project-members-permissions) on a - project that has the [feature flag enabled](#enable-or-disable-testing-metrics-panels). -1. Open the URL `https://example.com/PROJECT/-/metrics/panel/new`, replacing - `example.com` with your domain name, and `PROJECT` with the name of your project, - to display the panel configuration page. + [permissions](../../../user/permissions.md#project-members-permissions). +1. Click **Add panel** in the **{ellipsis_v}** **More actions** menu. + + NOTE: **Note:** + You can add panel only to custom dashboards. + + ![Monitoring Dashboard actions menu with add panel item](img/actions_menu_create_add_panel_v13_3.png) 1. In the **Define and preview panel** section, paste in the YAML you want to preview in the **Panel YAML** field. 1. Click **Preview panel**, and GitLab displays a preview of the chart below the `Define and preview panel` section: ![Monitoring Dashboard Add Panel page](img/metrics_dashboard_panel_preview_v13_3.png) -### Enable or disable testing metrics panels - -Testing metrics panels in the UI is under development and not ready for production use. It's -deployed behind a feature flag that's **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) -can enable it for your instance. Testing metrics panels in the UI can be enabled or disabled per-project. - -To enable it: - -```ruby -# Instance-wide -Feature.enable(:metrics_dashboard_new_panel_page) -# or by project -Feature.enable(:metrics_dashboard_new_panel_page, Project.find(metrics_dashboard_new_panel_page)) -``` - -To disable it: - -```ruby -# Instance-wide -Feature.disable(:metrics_dashboard_new_panel_page) -# or by project -Feature.disable(:metrics_dashboard_new_panel_page, Project.find(metrics_dashboard_new_panel_page)) -``` - ## Duplicate a GitLab-defined dashboard > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/37238) in GitLab 12.7. @@ -128,7 +105,7 @@ The resulting `.yml` file can be customized and adapted to your project. You can decide to save the dashboard `.yml` file in the project's **default** branch or in a new branch. -1. Click **Duplicate current dashboard** in the **{{ellipsis_v}}** **More actions** menu. +1. Click **Duplicate current dashboard** in the **{ellipsis_v}** **More actions** menu. NOTE: **Note:** You can duplicate only GitLab-defined dashboards. |