diff options
Diffstat (limited to 'doc/operations/metrics')
| -rw-r--r-- | doc/operations/metrics/alerts.md | 47 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/develop.md | 8 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/index.md | 16 | ||||
| -rw-r--r-- | doc/operations/metrics/dashboards/settings.md | 8 | ||||
| -rw-r--r-- | doc/operations/metrics/embed.md | 4 | ||||
| -rw-r--r-- | doc/operations/metrics/embed_grafana.md | 6 | ||||
| -rw-r--r-- | doc/operations/metrics/index.md | 2 |
7 files changed, 30 insertions, 61 deletions
diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 0e446f04b9b..12bd975db5d 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -17,46 +17,15 @@ your team when environment performance falls outside of the boundaries you set. Alerts are not currently supported for [Prometheus cluster integrations](../../user/clusters/integrations.md). -## External Prometheus instances +<!--- start_remove The following content will be removed on remove_date: '2022-09-22' --> -> [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42640) to GitLab Free in 12.10. +## External Prometheus instances (removed) + +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/219142) in GitLab 13.2 and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/338834) in 15.0. +To manually configure a Prometheus server, we recommend +you use the [generic alerts integration](../incident_management/integrations.md). -For manually configured Prometheus servers, GitLab provides a notify endpoint for -use with Prometheus webhooks. If you have manual configuration enabled, an -**Alerts** section is added to **Settings > Integrations > Prometheus**. -This section contains the needed **URL** and **Authorization Key**. The -**Reset Key** button invalidates the key and generates a new one. - - - -To send GitLab alert notifications, copy the **URL** and **Authorization Key** into the -[`webhook_configs`](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config) -section of your Prometheus Alertmanager configuration: - -```yaml -receivers: - - name: gitlab - webhook_configs: - - http_config: - authorization: - type: Bearer - credentials: 9e1cbfcd546896a9ea8be557caf13a76 - send_resolved: true - url: http://192.168.178.31:3001/root/manual_prometheus/prometheus/alerts/notify.json - # Rest of configuration omitted - # ... -``` - -For GitLab to associate your alerts with an [environment](../../ci/environments/index.md), -you must configure a `gitlab_environment_name` label on the alerts you set up in -Prometheus. The value of this should match the name of your environment in GitLab. - -You can display alerts with a `gitlab_environment_name` of `production` -[on a dashboard](../../user/operations_dashboard/index.md#adding-a-project-to-the-dashboard). - -In GitLab versions 13.1 and greater, you can configure your manually configured -Prometheus server to use the -[Generic alerts integration](../incident_management/integrations.md). +<!--- end_remove --> ## Trigger actions from alerts **(ULTIMATE)** @@ -67,7 +36,7 @@ Alerts can be used to trigger actions, like opening an issue automatically 1. Enable the option to create issues. 1. Choose the [issue template](../../user/project/description_templates.md) to create the issue from. 1. Optionally, select whether to send an email notification to the developers of the project. -1. Click **Save changes**. +1. Select **Save changes**. After enabling, GitLab automatically opens an issue when an alert is triggered containing values extracted from the [`alerts` field in webhook payload](https://prometheus.io/docs/alerting/latest/configuration/#webhook_config): diff --git a/doc/operations/metrics/dashboards/develop.md b/doc/operations/metrics/dashboards/develop.md index 513e5532bee..e09f56e27cf 100644 --- a/doc/operations/metrics/dashboards/develop.md +++ b/doc/operations/metrics/dashboards/develop.md @@ -23,14 +23,14 @@ Navigate to the browser-based editor of your choice: - In the **Repository view**: 1. Navigate to **{doc-text}** **Repository > Files**. - 1. Click **{plus}** **Add to tree** and select **New file**, - then click **Select a template type** to see a list of available templates: + 1. Select **{plus}** **Add to tree** and select **New file**, + then select **Select a template type** to see a list of available templates:  - In the **[Web IDE](../../../user/project/web_ide/index.md)**: - 1. Click **Web IDE** when viewing your repository. - 1. Click **{doc-new}** **New file**, then click **Choose a template** to see a list of available templates: + 1. Select **Web IDE** when viewing your repository. + 1. Select **{doc-new}** **New file**, then select **Choose a template** to see a list of available templates:  ## Custom dashboard templates **(PREMIUM SELF)** diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index 052f678f1b7..152e3dca27d 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -33,10 +33,10 @@ 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 **Monitor > 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, select the **{ellipsis_v}** **More actions** menu, and select **Create new**:  -1. In the modal window, click **Open Repository**, then follow the instructions +1. In the modal window, select **Open Repository**, then follow the instructions for creating a new dashboard from the command line. To create a new dashboard from the command line: @@ -84,7 +84,7 @@ with the **Add Panel** page: 1. Sign in to GitLab as a user with Maintainer or Owner [permissions](../../../user/permissions.md#project-members-permissions). -1. Click **Add panel** in the **{ellipsis_v}** **More actions** menu. +1. Select **Add panel** in the **{ellipsis_v}** **More actions** menu. NOTE: You can only add panels to custom dashboards. @@ -92,7 +92,7 @@ with the **Add Panel** page:  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 +1. Select **Preview panel**, and GitLab displays a preview of the chart below the `Define and preview panel` section:  @@ -106,8 +106,8 @@ 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. To duplicate a GitLab-defined dashboard: -1. Click **Duplicate current dashboard** in the **{ellipsis_v}** **More actions** menu. -1. Enter the filename and other information, such as the new commit's message, and click **Duplicate**. +1. Select **Duplicate current dashboard** in the **{ellipsis_v}** **More actions** menu. +1. Enter the filename and other information, such as the new commit's message, and select **Duplicate**. 1. Select a branch to add your dashboard to: - *If you select your **default** branch,* the new dashboard becomes immediately available. - *If you select another branch,* this branch should be merged to your **default** branch first. @@ -133,7 +133,7 @@ any chart on a dashboard: The options are: - **Expand panel** - Displays a larger version of a visualization. To return to - the dashboard, click the **Back** button in your browser, or press the <kbd>Escape</kbd> key. + the dashboard, select the **Back** button in your browser, or press the <kbd>Escape</kbd> key. ([Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3100) in GitLab 13.0.) - **View logs** **(ULTIMATE)** - Displays [Logs](../../../user/project/clusters/kubernetes_pod_logs.md), if they are enabled. If used in conjunction with the [timeline zoom](#timeline-zoom-and-url-sharing) @@ -146,7 +146,7 @@ The options are: > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/198910) in GitLab 12.8. You can use the **Timeline zoom** function at the bottom of a chart to zoom in -on a date and time of your choice. When you click and drag the sliders to select +on a date and time of your choice. When you select and drag the sliders to select a different beginning or end date of data to display, GitLab adds your selected start and end times to the URL, enabling you to share specific time frames more easily. diff --git a/doc/operations/metrics/dashboards/settings.md b/doc/operations/metrics/dashboards/settings.md index aae5a623420..45f0e906e9c 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -28,12 +28,12 @@ time zone: 1. Sign in as a user with Manage Project Operations [permissions](../../../user/permissions.md). 1. Navigate to **Settings > Monitor**. -1. Scroll to **Metrics Dashboard** and click **Expand**. +1. Scroll to **Metrics Dashboard** and select **Expand**. 1. In the **Dashboard timezone** select box, select *User's local timezone* or *UTC*:  -1. Click **Save changes**. +1. Select **Save changes**. ## Link to an external dashboard @@ -44,12 +44,12 @@ existing external dashboards: 1. Sign in as a user with Manage Project Operations [permissions](../../../user/permissions.md). 1. Navigate to **Settings > Monitor**. -1. Scroll to **Metrics Dashboard** and click **Expand**. +1. Scroll to **Metrics Dashboard** and select **Expand**. 1. In **External dashboard URL**, provide the URL to your external dashboard:  -1. Click **Save changes**. +1. Select **Save changes**. GitLab displays a **View full dashboard** button in the top right corner of your [monitoring dashboard](../../../ci/environments/index.md#monitor-environments) diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md index 44b998dc3ee..3fd5daba4fb 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -48,8 +48,8 @@ GitLab unfurls the link as an embedded metrics panel:  -You can also embed a single chart. To get a link to a chart, click the -**{ellipsis_v}** **More actions** menu in the upper right corner of the chart, +You can also embed a single chart. To get a link to a chart, select +**{ellipsis_v}** **More actions** in the upper right corner of the chart, and select **Copy link to chart**, as shown in this example:  diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 5bfb097619d..700bf821a49 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -52,7 +52,7 @@ To set up the Grafana API in Grafana: 1. To enable the integration, check the **Active** checkbox. 1. For **Grafana URL**, enter the base URL of the Grafana instance. 1. For **API Token**, enter the Administrator API token you just generated. -1. Click **Save Changes**. +1. Select **Save Changes**. ### Generate a link to a panel @@ -61,10 +61,10 @@ To generate a link to a panel: 1. In Grafana, go to the dashboard you wish to embed a panel from. 1. In the upper-left corner of the page, select a specific value for each variable required for the queries in the dashboard. -1. In Grafana click on a panel's title, then click **Share** to open the panel's sharing dialog to +1. In Grafana select a panel's title, then select **Share** to open the panel's sharing dialog to the **Link** tab. - If you click the dashboard's share button instead, GitLab attempts to embed the first supported + If you select the dashboard's share button instead, GitLab attempts to embed the first supported panel on the dashboard (if available). 1. If your Prometheus queries use Grafana's custom template variables, ensure the **Template variables** option is set to on. Only the Grafana global template variables diff --git a/doc/operations/metrics/index.md b/doc/operations/metrics/index.md index 937bd329570..916fe6b0ea9 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -87,7 +87,7 @@ navigation bar contains: [custom dashboards](dashboards/index.md). ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34779) in GitLab 12.5.) - **Duplicate current dashboard** - Save a [complete copy of a dashboard](dashboards/index.md#duplicate-a-gitlab-defined-dashboard). Only available on GitLab-defined dashboards. - - **Star dashboard** **{star-o}** - Click to mark a dashboard as a favorite. + - **Star dashboard** **{star-o}** - Mark a dashboard as a favorite. Starred dashboards display a solid star **{star}** button, and display first in the **Dashboard** dropdown list. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214582) in GitLab 13.0.) |