diff options
Diffstat (limited to 'doc/operations')
19 files changed, 140 insertions, 108 deletions
diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index 78aa664b339..d4edf324caa 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -27,16 +27,16 @@ least Maintainer [permissions](../user/permissions.md) to enable the Sentry inte 1. [Create](https://docs.sentry.io/product/sentry-basics/guides/integrate-frontend/create-new-project/) a new Sentry project. For each GitLab project that you want to integrate, we recommend that you create a new Sentry project. 1. [Find or generate](https://docs.sentry.io/api/auth/) a Sentry auth token for your Sentry project. Make sure to give the token at least the following scopes: `event:read` and `project:read`. -1. In GitLab, navigate to your project's **Operations > Error Tracking** page, and +1. In GitLab, navigate to your project's **Monitor > Error Tracking** page, and click **Enable Error Tracking**. -1. Navigate to your project's **Settings > Operations**. In the **Error Tracking** section, +1. Navigate to your project's **Settings > Monitor**. In the **Error Tracking** section, ensure the **Active** checkbox is set. 1. In the **Sentry API URL** field, enter your Sentry hostname. For example, enter `https://sentry.example.com` if this is the address at which your Sentry instance is available. For the SaaS version of Sentry, the hostname is `https://sentry.io`. 1. In the **Auth Token** field, enter the token you previously generated. 1. Click the **Connect** button to test the connection to Sentry and populate the **Project** dropdown. 1. From the **Project** dropdown, choose a Sentry project to link to your GitLab project. 1. Click **Save changes** for the changes to take effect. -1. You can now visit **Operations > Error Tracking** in your project's sidebar to [view a list](#error-tracking-list) of Sentry errors. +1. You can now visit **Monitor > Error Tracking** in your project's sidebar to [view a list](#error-tracking-list) of Sentry errors. ### Enabling GitLab issues links @@ -45,7 +45,7 @@ You may also want to enable Sentry's GitLab integration by following the steps i ## Error Tracking List Users with at least Reporter [permissions](../user/permissions.md) -can find the Error Tracking list at **Operations > Error Tracking** in your project's sidebar. +can find the Error Tracking list at **Monitor > Error Tracking** in your project's sidebar. Here, you can filter errors by title or by status (one of Ignored , Resolved, or Unresolved) and sort in descending order by Frequency, First Seen, or Last Seen. By default, the error list is ordered by Last Seen and filtered to Unresolved errors.  diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index dc0d5d77d27..4045e46de04 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -38,7 +38,7 @@ with GitLab, so it's up to developers to use a compatible client library and To create and enable a feature flag: -1. Navigate to your project's **Operations > Feature Flags**. +1. Navigate to your project's **Deployments > Feature Flags**. 1. Click the **New feature flag** button. 1. Enter a name that starts with a letter and contains only lowercase letters, digits, underscores (`_`), or dashes (`-`), and does not end with a dash (`-`) or underscore (`_`). @@ -90,7 +90,7 @@ and the supported strategies are: - [User List](#user-list) Strategies can be added to feature flags when [creating a feature flag](#create-a-feature-flag), -or by editing an existing feature flag after creation by navigating to **Operations > Feature Flags** +or by editing an existing feature flag after creation by navigating to **Deployments > Feature Flags** and clicking **{pencil}** (edit). ### All users @@ -184,14 +184,16 @@ For example: #### Create a user list -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13308) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13308) in GitLab 13.3. +> - [Updated](https://gitlab.com/gitlab-org/gitlab/-/issues/322425) in GitLab 14.0. To create a user list: -1. In your project, navigate to **Operations > Feature Flags**. -1. Click on **New list**. +1. In your project, navigate to **Deployments > Feature Flags**. +1. Select **View user lists** +1. Select **New user list**. 1. Enter a name for the list. -1. Click **Create**. +1. Select **Create**. You can view a list's User IDs by clicking the **{pencil}** (edit) button next to it. When viewing a list, you can rename it by clicking the **Edit** button. @@ -202,7 +204,7 @@ When viewing a list, you can rename it by clicking the **Edit** button. To add users to a user list: -1. In your project, navigate to **Operations > Feature Flags**. +1. In your project, navigate to **Deployments > Feature Flags**. 1. Click on the **{pencil}** (edit) button next to the list you want to add users to. 1. Click on **Add Users**. 1. Enter the user IDs as a comma-separated list of values. For example, @@ -215,7 +217,7 @@ To add users to a user list: To remove users from a user list: -1. In your project, navigate to **Operations > Feature Flags**. +1. In your project, navigate to **Deployments > Feature Flags**. 1. Click on the **{pencil}** (edit) button next to the list you want to change. 1. Click on the **{remove}** (remove) button next to the ID you want to remove. @@ -253,7 +255,7 @@ See [this video tutorial](https://www.youtube.com/watch?v=CAJY2IGep7Y) for help In [GitLab 13.0 and earlier](https://gitlab.com/gitlab-org/gitlab/-/issues/8621), to disable a feature flag for a specific environment: -1. Navigate to your project's **Operations > Feature Flags**. +1. Navigate to your project's **Deployments > Feature Flags**. 1. For the feature flag you want to disable, click the Pencil icon. 1. To disable the flag: @@ -267,7 +269,7 @@ to disable a feature flag for a specific environment: To disable a feature flag for all environments: -1. Navigate to your project's **Operations > Feature Flags**. +1. Navigate to your project's **Deployments > Feature Flags**. 1. For the feature flag you want to disable, slide the Status toggle to **Disabled**. The feature flag is displayed on the **Disabled** tab. @@ -281,7 +283,7 @@ Then prepare your application with a client library. To get the access credentials that your application needs to communicate with GitLab: -1. Navigate to your project's **Operations > Feature Flags**. +1. Navigate to your project's **Deployments > Feature Flags**. 1. Click the **Configure** button to view the following: - **API URL**: URL where the client (application) connects to get a list of feature flags. - **Instance ID**: Unique token that authorizes the retrieval of the feature flags. diff --git a/doc/operations/incident_management/alert_integrations.md b/doc/operations/incident_management/alert_integrations.md index bec0653d464..b08ce8a0ad7 100644 --- a/doc/operations/incident_management/alert_integrations.md +++ b/doc/operations/incident_management/alert_integrations.md @@ -1,5 +1,6 @@ --- redirect_to: 'integrations.md' +remove_date: '2021-05-03' --- This document was moved to [another location](integrations.md). diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index c49684954d9..def54d8dae2 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -11,7 +11,7 @@ Alerts are a critical entity in your incident management workflow. They represen ## Alert List Users with at least Developer [permissions](../../user/permissions.md) can -access the Alert list at **Operations > Alerts** in your project's +access the Alert list at **Monitor > Alerts** in your project's sidebar. The Alert list displays alerts sorted by start time, but you can change the sort order by clicking the headers in the Alert list. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217745) in GitLab 13.1.) @@ -95,7 +95,7 @@ instance. To view the metrics for an alert: 1. Sign in as a user with Developer or higher [permissions](../../user/permissions.md). -1. Navigate to **Operations > Alerts**. +1. Navigate to **Monitor > Alerts**. 1. Select the alert you want to view. 1. Below the title of the alert, select the **Metrics** tab. @@ -115,7 +115,7 @@ your application's performance and how to resolve any problems. To view the logs for an alert: 1. Sign in as a user with Developer or higher [permissions](../../user/permissions.md). -1. Navigate to **Operations > Alerts**. +1. Navigate to **Monitor > Alerts**. 1. Select the alert you want to view. 1. Below the title of the alert, select the **Metrics** tab. 1. Select the [menu](../metrics/dashboards/index.md#chart-context-menu) of @@ -168,7 +168,7 @@ difficult to track who is investigating and working on it. Assigning alerts ease To assign an alert: -1. To display the list of current alerts, navigate to **Operations > Alerts**. +1. To display the list of current alerts, navigate to **Monitor > Alerts**. 1. Select your desired alert to display its details. @@ -193,7 +193,7 @@ You can manually create [To-Do list items](../../user/todos.md) for yourself from the Alert details screen, and view them later on your **To-Do List**. To add a to-do item: -1. To display the list of current alerts, navigate to **Operations > Alerts**. +1. To display the list of current alerts, navigate to **Monitor > Alerts**. 1. Select your desired alert to display its **Alert Management Details View**. 1. Select the **Add a to do** button in the right sidebar: diff --git a/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png b/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png Binary files differindex 0991e963e02..08a45d001c2 100644 --- a/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png +++ b/doc/operations/incident_management/img/pagerduty_incidents_integration_v13_3.png diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index d09dbd2cb04..1cb10fea566 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -26,7 +26,7 @@ Incident, you have two options to do this manually. > [Moved](https://gitlab.com/gitlab-org/monitor/health/-/issues/24) to GitLab Free in 13.3. -- Navigate to **Operations > Incidents** and click **Create Incident**. +- Navigate to **Monitor > Incidents** and click **Create Incident**. - Create a new issue using the `incident` template available when creating it. - Create a new issue and assign the `incident` label to it. @@ -51,7 +51,7 @@ Incident, you have two options to do this manually. With Maintainer or higher [permissions](../../user/permissions.md), you can enable GitLab to create incident automatically whenever an alert is triggered: -1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**. +1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Check the **Create an incident** checkbox. 1. To customize the incident, select an [issue template](../../user/project/description_templates.md#create-an-issue-template). @@ -69,8 +69,8 @@ You can set up a webhook with PagerDuty to automatically create a GitLab inciden for each PagerDuty incident. This configuration requires you to make changes in both PagerDuty and GitLab: -1. Sign in as a user with Maintainer [permissions](../../user/permissions.md). -1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**. +1. Sign in as a user with the [Maintainer role](../../user/permissions.md). +1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Select the **PagerDuty integration** tab:  @@ -87,7 +87,7 @@ confirm that a GitLab incident is created from the incident. ## Incident list For users with at least Guest [permissions](../../user/permissions.md), the -Incident list is available at **Operations > Incidents** +Incident list is available at **Monitor > Incidents** in your project's sidebar. The list contains the following metrics:  @@ -132,7 +132,7 @@ For a live example of the incident list in action, visit this > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4. Users with at least Guest [permissions](../../user/permissions.md) can view -the Incident Details page. Navigate to **Operations > Incidents** in your project's +the Incident Details page. Navigate to **Monitor > Incidents** in your project's sidebar, and select an incident from the list. When you take any of these actions on an incident, GitLab logs a system note and @@ -204,9 +204,11 @@ un-threaded and ordered chronologically, newest to oldest: You can enable the Service Level Agreement Countdown timer on incidents to track the Service Level Agreements (SLAs) you hold with your customers. The timer is automatically started when the incident is created, and shows the time -remaining before the SLA period expires. To configure the timer: +remaining before the SLA period expires. The timer is also dynamically updated +every 15 minutes so you do not have to refresh the page to see the time remaining. +To configure the timer: -1. Navigate to **Settings > Operations**. +1. Navigate to **Settings > Monitor**. 1. Scroll to **Incidents** and click **Expand**, then select the **Incident settings** tab. 1. Select **Activate "time to SLA" countdown timer**. @@ -276,7 +278,7 @@ templates. With Maintainer or higher [permissions](../../user/permissions.md), you can enable GitLab to close an incident automatically when a **Recovery Alert** is received: -1. Navigate to **Settings > Operations > Incidents** and expand **Incidents**. +1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Check the **Automatically close associated Incident** checkbox. 1. Click **Save changes**. diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 07ffb92a000..d2c52123838 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -18,9 +18,9 @@ to use this endpoint. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab Free 13.5. -With Maintainer or higher [permissions](../../user/permissions.md), -you can view the list of configured alerts integrations by navigating to **Settings > Operations** -in your project's sidebar menu, and expanding the **Alert integrations** section. The list displays +With the [Maintainer role or higher](../../user/permissions.md), +you can view the list of configured alerts integrations by navigating to **Settings > Monitor** +in your project's sidebar menu, and expanding the **Alerts** section. The list displays the integration name, type, and status (enabled or disabled):  @@ -38,8 +38,8 @@ receive alert payloads in JSON format. You can always 1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md) for a project. -1. Navigate to **Settings > Operations** in your project. -1. Expand the **Alert integrations** section, and in the **Select integration type** dropdown menu, +1. Navigate to **Settings > Monitor** in your project. +1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu, select **HTTP Endpoint**. 1. Toggle the **Active** alert setting. The URL and Authorization Key for the webhook configuration are available in the **View credentials** tab after you save the integration. You must also input @@ -55,8 +55,8 @@ and you can [customize the payload](#customize-the-alert-payload-outside-of-gitl 1. Sign in to GitLab as a user with maintainer [permissions](../../user/permissions.md) for a project. -1. Navigate to **Settings > Operations** in your project. -1. Expand the **Alert integrations** section. +1. Navigate to **Settings > Monitor** in your project. +1. Expand the **Alerts** section. 1. For each endpoint you want to create: 1. Click the **Add new integration** button. @@ -166,8 +166,8 @@ configures an integration, you can trigger a test alert to confirm your integration works properly. 1. Sign in as a user with Developer or greater [permissions](../../user/permissions.md). -1. Navigate to **Settings > Operations** in your project. -1. Click **Alert integrations** to expand the section. +1. Navigate to **Settings > Monitor** in your project. +1. Click **Alerts** to expand the section. 1. Click the **{settings}** settings icon on the right side of the integration in [the list](#integrations-list). 1. Select the **Send test alert** tab to open it. 1. Enter a test payload in the payload field (valid JSON is required). @@ -219,8 +219,8 @@ active at the same time. To enable Opsgenie integration: -1. Sign in as a user with Maintainer or Owner [permissions](../../user/permissions.md). -1. Navigate to **Operations > Alerts**. +1. Sign in as a user with the [Maintainer or Owner role](../../user/permissions.md). +1. Navigate to **Monitor > Alerts**. 1. In the **Integrations** select box, select **Opsgenie**. 1. Select the **Active** toggle. 1. In the **API URL** field, enter the base URL for your Opsgenie integration, @@ -228,4 +228,4 @@ To enable Opsgenie integration: 1. Select **Save changes**. After you enable the integration, navigate to the Alerts list page at -**Operations > Alerts**, and then select **View alerts in Opsgenie**. +**Monitor > Alerts**, and then select **View alerts in Opsgenie**. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 695b42f7d1a..5d312ef672f 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -28,7 +28,7 @@ Set up an on-call schedule for your team to add rotations to. Follow these steps to create a schedule: -1. Go to **Operations > On-call Schedules** and select **Add a schedule**. +1. Go to **Monitor > On-call Schedules** and select **Add a schedule**. 1. In the **Add schedule** form, enter the schedule's name and description, and select a timezone. 1. Click **Add schedule**. @@ -41,7 +41,7 @@ create [rotations](#rotations) for your schedule. Follow these steps to update a schedule: -1. Go to **Operations > On-call Schedules** and select the **Pencil** icon on the top right of the +1. Go to **Monitor > On-call Schedules** and select the **Pencil** icon on the top right of the schedule card, across from the schedule name. 1. In the **Edit schedule** form, edit the information you wish to update. 1. Click the **Edit schedule** button to save your changes. @@ -53,7 +53,7 @@ interval (if one is set) to the corresponding times in the new time zone. Follow these steps to delete a schedule: -1. Go to **Operations > On-call Schedules** and select the **Trash Can** icon on the top right of the +1. Go to **Monitor > On-call Schedules** and select the **Trash Can** icon on the top right of the schedule card. 1. In the **Delete schedule** window, click the **Delete schedule** button. @@ -63,7 +63,7 @@ Add rotations to an existing schedule to put your team members on-call. Follow these steps to create a rotation: -1. Go to **Operations > On-call Schedules** and select **Add a rotation** on the top right of the +1. Go to **Monitor > On-call Schedules** and select **Add a rotation** on the top right of the current schedule. 1. In the **Add rotation** form, enter the following: @@ -80,7 +80,7 @@ Follow these steps to create a rotation: Follow these steps to edit a rotation: -1. Go to **Operations > On-call Schedules** and select the **Pencil** icon to the right of the title +1. Go to **Monitor > On-call Schedules** and select the **Pencil** icon to the right of the title of the rotation that you want to update. 1. In the **Edit rotation** form, make the changes that you want. 1. Select the **Edit rotation** button. @@ -89,7 +89,7 @@ Follow these steps to edit a rotation: Follow these steps to delete a rotation: -1. Go to **Operations > On-call Schedules** and select the **Trash Can** icon to the right of the +1. Go to **Monitor > On-call Schedules** and select the **Trash Can** icon to the right of the title of the rotation that you want to delete. 1. In the **Delete rotation** window, select the **Delete rotation** button. diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 1588cb96218..db419001343 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -27,9 +27,9 @@ Email notifications are available in projects for triggered alerts. Project members with the **Owner** or **Maintainer** roles have the option to receive a single email notification for new alerts. -1. Navigate to **Settings > Operations**. -1. Expand the **Incidents** section. -1. In the **Alert Integration** tab, select the checkbox +1. Navigate to **Settings > Monitor**. +1. Expand the **Alerts** section. +1. In the **Integration settings** tab, select the checkbox **Send a single email notification to Owners and Maintainers for new alerts**. 1. Select **Save changes**. diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index 1e11a9c62e0..d63d42e07c1 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -42,7 +42,7 @@ Only AWS S3 is supported as a deploy target. To provide GitLab with the AWS account information needed to push content to your Status Page: 1. Sign into GitLab as a user with Maintainer or greater [permissions](../../user/permissions.md). -1. Navigate to **{settings}** **Settings > Operations**. Next to **Status Page**, +1. Navigate to **{settings}** **Settings > Monitor**. Next to **Status Page**, click **Expand**. 1. Click **Active** to enable the Status Page feature. 1. In **Status Page URL**, provide the URL to your external status page. @@ -92,10 +92,9 @@ the issue can potentially [publish comments to your GitLab Status Page](#publish After creating the CI/CD variables, configure the Project you want to use for Incident issues: -1. To view the [Operations Settings](../../user/project/settings/#operations-settings) - page, navigate to **{settings}** **Settings > Operations > Status Page**. -1. Fill in your cloud provider's credentials and make sure the **Active** checkbox is checked. -1. Click **Save changes**. +1. To view the Status Page settings, navigate to **{settings}** **Settings > Monitor > Status Page**. +1. Fill in your cloud provider's credentials and make sure to select the **Active** checkbox. +1. Select **Save changes**. ## How to use your GitLab Status Page @@ -131,7 +130,7 @@ A background worker publishes the issue onto the Status Page using the credentia you provided during setup. As part of publication, GitLab: - Anonymizes user and group mentions with `Incident Responder`. -- Removes titles of non-public [GitLab references](../../user/markdown.md#special-gitlab-references). +- Removes titles of non-public [GitLab references](../../user/markdown.md#gitlab-specific-references). - Publishes any files attached to incident issue descriptions, up to 5000 per issue. ([Introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/205166).) diff --git a/doc/operations/index.md b/doc/operations/index.md index 934634562fc..d170e82dd7f 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -4,10 +4,10 @@ group: Monitor info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Project operations **(FREE)** +# Monitor application performance **(FREE)** GitLab provides a variety of tools to help operate and maintain -your applications: +your applications. ## Measure reliability and stability with metrics @@ -73,7 +73,7 @@ production services. GitLab provides centralized, aggregated log storage for you distributed application, enabling you to collect logs across multiple services and infrastructure. -- [View logs of pods or managed applications](../user/project/clusters/kubernetes_pod_logs.md) +- [View logs of pods](../user/project/clusters/kubernetes_pod_logs.md) in connected Kubernetes clusters. ## Manage your infrastructure in code diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 09cfea06198..16cfb05ad9a 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -25,7 +25,7 @@ For managed Prometheus instances using auto configuration, you can [configure alerts for metrics](index.md#adding-custom-metrics) directly in the [metrics dashboard](index.md). To set an alert: -1. In your project, navigate to **Operations > Metrics**, +1. In your project, navigate to **Monitor > Metrics**, 1. Identify the metric you want to create the alert for, and click the **ellipsis** **{ellipsis_v}** icon in the top right corner of the metric. 1. Choose **Alerts**. @@ -39,7 +39,15 @@ To remove the alert, click back on the alert icon for the desired metric, and cl ### Link runbooks to alerts -> Runbook URLs [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39315) in GitLab 13.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39315) in GitLab 13.3. +> - [Deprecated](https://gitlab.com/groups/gitlab-org/-/epics/5877) in GitLab 13.11. +> - [Removed](https://gitlab.com/groups/gitlab-org/-/epics/4280) in GitLab 14.0. + +WARNING: +Linking runbooks to alerts through the alerts UI is [deprecated](https://gitlab.com/groups/gitlab-org/-/epics/5877) +and scheduled for [removal in GitLab 14.0](https://gitlab.com/groups/gitlab-org/-/epics/4280). +However, you can still add runbooks to your alert payload. They show up in the alert UI when the +alert is triggered. When creating alerts from the metrics dashboard for [managed Prometheus instances](#managed-prometheus-instances), you can also link a runbook. When the alert triggers, the @@ -72,14 +80,16 @@ section of your Prometheus Alertmanager configuration: ```yaml receivers: - name: gitlab - webhook_configs: - - http_config: - bearer_token: 9e1cbfcd546896a9ea8be557caf13a76 - send_resolved: true - url: http://192.168.178.31:3001/root/manual_prometheus/prometheus/alerts/notify.json - # Rest of configuration omitted - # ... + - 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), @@ -100,7 +110,7 @@ Prometheus server to use the Alerts can be used to trigger actions, like opening an issue automatically (disabled by default since `13.1`). To configure the actions: -1. Navigate to your project's **Settings > Operations > Incidents**. +1. Navigate to your project's **Settings > Monitor > Alerts**. 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. diff --git a/doc/operations/metrics/dashboards/img/metrics_dashboard_template_selection_v13_3.png b/doc/operations/metrics/dashboards/img/metrics_dashboard_template_selection_v13_3.png Binary files differindex cad075ca421..1571ab9de90 100644 --- a/doc/operations/metrics/dashboards/img/metrics_dashboard_template_selection_v13_3.png +++ b/doc/operations/metrics/dashboards/img/metrics_dashboard_template_selection_v13_3.png diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index 7b056020a99..d7b748034d5 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -20,14 +20,14 @@ or [duplicate a GitLab-defined Prometheus dashboard](#duplicate-a-gitlab-defined You can configure a custom dashboard by adding a new YAML file into your project's `.gitlab/dashboards/` directory. For the dashboard to display on your project's -**Operations > Metrics** page, the files must have a `.yml` +**Monitor > Metrics** page, the files must have a `.yml` extension and be present in your project's **default** branch. 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. Navigate to your dashboard at **Monitor > Metrics**. 1. In the top-right corner of your dashboard, click the **{ellipsis_v}** **More actions** menu, and select **Create new**:  @@ -60,7 +60,7 @@ To create a new dashboard from the command line: ``` 1. Save the file, commit, and push to your repository. The file must be present in your **default** branch. -1. Navigate to your project's **Operations > Metrics** and choose the custom +1. Navigate to your project's **Monitor > Metrics** and choose the custom dashboard from the dropdown. Your custom dashboard is available at `https://example.com/project/-/metrics/custom_dashboard_name.yml`. @@ -217,8 +217,46 @@ links: ## Troubleshooting -When troubleshooting issues with a managed Prometheus app, it is often useful to -[view the Prometheus UI](../../../user/project/integrations/prometheus.md#access-the-ui-of-a-prometheus-managed-application-in-kubernetes). +### Accessing the UI of Prometheus in Kubernetes + +When troubleshooting issues with an in-cluster Prometheus, it can help to +view the Prometheus UI. In the example below, we assume the Prometheus +server to be the pod `prometheus-prometheus-server` in the `gitlab-managed-apps` +namespace: + +1. Find the name of the Prometheus pod in the user interface of your Kubernetes + provider, such as GKE, or by running the following `kubectl` command in your + terminal. For example: + + ```shell + kubectl get pods -n gitlab-managed-apps | grep 'prometheus-prometheus-server' + ``` + + The command should return a result like the following example, where + `prometheus-prometheus-server-55b4bd64c9-dpc6b` is the name of the Prometheus pod: + + ```plaintext + gitlab-managed-apps prometheus-prometheus-server-55b4bd64c9-dpc6b 2/2 Running 0 71d + ``` + +1. Run a `kubectl port-forward` command. In the following example, `9090` is the + Prometheus server's listening port: + + ```shell + kubectl port-forward prometheus-prometheus-server-55b4bd64c9-dpc6b 9090:9090 -n gitlab-managed-apps + ``` + + The `port-forward` command forwards all requests sent to your system's `9090` port + to the `9090` port of the Prometheus pod. If the `9090` port on your system is used + by another application, you can change the port number before the colon to your + desired port. For example, to forward port `8080` of your local system, change the + command to: + + ```shell + kubectl port-forward prometheus-prometheus-server-55b4bd64c9-dpc6b 8080:9090 -n gitlab-managed-apps + ``` + +1. Open `localhost:9090` in your browser to display the Prometheus user interface. ### "No data found" error on Metrics dashboard page diff --git a/doc/operations/metrics/dashboards/settings.md b/doc/operations/metrics/dashboards/settings.md index e998db6b51b..0e467623e05 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -21,7 +21,7 @@ time zone, but you can display dates and times in UTC format. To change the time zone: 1. Sign in as a user with Manage Project Operations [permissions](../../../user/permissions.md). -1. Navigate to **Settings > Operations**. +1. Navigate to **Settings > Monitor**. 1. Scroll to **Metrics Dashboard** and click **Expand**. 1. In the **Dashboard timezone** select box, select *User's local timezone* or *UTC*: @@ -37,7 +37,7 @@ You can add a button on your monitoring dashboard that links directly to your existing external dashboards: 1. Sign in as a user with Manage Project Operations [permissions](../../../user/permissions.md). -1. Navigate to **Settings > Operations**. +1. Navigate to **Settings > Monitor**. 1. Scroll to **Metrics Dashboard** and click **Expand**. 1. In **External dashboard URL**, provide the URL to your external dashboard: diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index ff92997e44b..473b335d4c5 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -47,7 +47,7 @@ format. To embed panels from a Grafana instance, the data source must be: To set up the Grafana API in Grafana: 1. In Grafana, [generate an Admin-level API Token](https://grafana.com/docs/grafana/latest/http_api/auth/#create-api-token). -1. In your GitLab project, go to **Settings > Operations** and expand the **Grafana authentication** +1. In your GitLab project, go to **Settings > Monitor** and expand the **Grafana authentication** section. 1. To enable the integration, check the **Active** checkbox. 1. For **Grafana URL**, enter the base URL of the Grafana instance. diff --git a/doc/operations/metrics/index.md b/doc/operations/metrics/index.md index 8ff45ac4015..09bc3237cb6 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -16,10 +16,10 @@ critical. For GitLab to display your information in charts, you must: For an overview, see [How to instrument Prometheus metrics in GitLab](https://www.youtube.com/watch?v=tuI2oJ3TTB4). 1. **Expose metrics for capture** - Make logs, metrics, and traces available for capture. 1. [**Configure Prometheus to gather metrics**](#configure-prometheus-to-gather-metrics) - - Deploy managed applications like Elasticsearch, Prometheus, and Jaeger to gather + Use applications like Elasticsearch, Prometheus, and Jaeger to gather the data you've exposed. 1. **GitLab collects metrics** - GitLab uses Prometheus to scrape the data you've - captured in your managed apps, and prepares the data for display. To learn more, read + captured in your applications, and prepares the data for display. To learn more, read [Collect and process metrics](#collect-and-process-metrics). 1. **Display charts in the GitLab user interface** - GitLab converts your metrics into easy-to-read charts on a default dashboard. You can create as many custom charts @@ -34,30 +34,10 @@ your Prometheus integration depends on where your apps are running: - **For manually-configured Prometheus** - [Specify your Prometheus server](../../user/project/integrations/prometheus.md#manual-configuration-of-prometheus), and define at least one environment. -- **For GitLab-managed Prometheus** - GitLab can - [deploy and manage Prometheus](../../user/project/integrations/prometheus.md#managed-prometheus-on-kubernetes) for you. - You must also complete a code deployment, as described in - [Deploy code with GitLab-managed Prometheus](#deploy-code-with-gitlab-managed-prometheus), - for the **Operations > Metrics** page to contain data. - -### Deploy code with GitLab-managed Prometheus - -For GitLab-managed Prometheus, you can set up [Auto DevOps](../../topics/autodevops/index.md) -to quickly create a deployment: - -1. Navigate to your project's **Operations > Kubernetes** page. -1. Ensure that, in addition to Prometheus, you also have GitLab Runner and Ingress - installed. -1. After installing Ingress, copy its endpoint. -1. Navigate to your project's **Settings > CI/CD** page. In the - **Auto DevOps** section, select a deployment strategy and save your changes. -1. On the same page, in the **Variables** section, add a variable named - `KUBE_INGRESS_BASE_DOMAIN` with the value of the Ingress endpoint you - copied previously. Leave the type as **Variable**. -1. Navigate to your project's **{rocket}** **CI/CD > Pipelines** page, and run a - pipeline on any branch. -1. When the pipeline has run successfully, graphs are available on the - **Operations > Metrics** page. +- **For a cluster integrated Prometheus** - GitLab can query + [an in-cluster Prometheus](../../user/clusters/integrations.md#prometheus-cluster-integration). + You must also complete a code deployment to your cluster for the **Monitor > Metrics** + page to contain data. You can do this using [Auto DevOps](../../topics/autodevops/quick_start_guide.md).  @@ -77,7 +57,7 @@ To view the [default metrics dashboard](dashboards/default.md) for an environmen 1. *If the metrics dashboard is only visible to project members,* sign in to GitLab as a member of a project. Learn more about [metrics dashboard visibility](#metrics-dashboard-visibility). -1. In your project, navigate to **Operations > Metrics**. +1. In your project, navigate to **Monitor > Metrics**. GitLab displays the [default metrics dashboard](dashboards/default.md) for the environment, like the following example: diff --git a/doc/operations/product_analytics.md b/doc/operations/product_analytics.md index db6dc13607b..c89500ab92c 100644 --- a/doc/operations/product_analytics.md +++ b/doc/operations/product_analytics.md @@ -52,7 +52,7 @@ user interface: 1. Sign in to GitLab as a user with Reporter or greater [permissions](../user/permissions.md). -1. Navigate to **Operations > Product Analytics** +1. Navigate to **Monitor > Product Analytics**. The user interface contains: diff --git a/doc/operations/tracing.md b/doc/operations/tracing.md index a6647641527..7435c0dd8a2 100644 --- a/doc/operations/tracing.md +++ b/doc/operations/tracing.md @@ -34,7 +34,7 @@ GitLab provides an easy way to open the Jaeger UI from within your project: 1. [Set up Jaeger](https://www.jaegertracing.io) and configure your application using one of the [client libraries](https://www.jaegertracing.io/docs/latest/client-libraries/). -1. Navigate to your project's **Settings > Operations** and provide the Jaeger URL. +1. Navigate to your project's **Settings > Monitor** and provide the Jaeger URL. 1. Click **Save changes** for the changes to take effect. -1. You can now visit **Operations > Tracing** in your project's sidebar and GitLab redirects you to +1. You can now visit **Monitor > Tracing** in your project's sidebar and GitLab redirects you to the configured Jaeger URL. |
