From 9dc93a4519d9d5d7be48ff274127136236a3adb3 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 20 Apr 2021 23:50:22 +0000 Subject: Add latest changes from gitlab-org/gitlab@13-11-stable-ee --- doc/operations/error_tracking.md | 8 +- doc/operations/feature_flags.md | 20 ++-- doc/operations/incident_management/alerts.md | 2 +- .../img/custom_alert_mapping_v13_10.png | Bin 100141 -> 0 bytes .../img/custom_alert_mapping_v13_11.png | Bin 0 -> 16700 bytes .../img/oncall_schedule_day_grid_v13_10.png | Bin 0 -> 15722 bytes .../img/oncall_schedule_empty_grid_v13_10.png | Bin 0 -> 31139 bytes doc/operations/incident_management/incidents.md | 4 +- doc/operations/incident_management/index.md | 5 +- doc/operations/incident_management/integrations.md | 32 +++--- .../incident_management/oncall_schedules.md | 109 +++++++++++++++++++++ doc/operations/incident_management/paging.md | 8 +- doc/operations/incident_management/status_page.md | 2 +- doc/operations/index.md | 6 +- doc/operations/metrics/alerts.md | 6 +- doc/operations/metrics/dashboards/default.md | 2 +- doc/operations/metrics/dashboards/develop.md | 2 +- doc/operations/metrics/dashboards/index.md | 2 +- doc/operations/metrics/dashboards/panel_types.md | 2 +- doc/operations/metrics/dashboards/settings.md | 2 +- .../metrics/dashboards/templating_variables.md | 2 +- doc/operations/metrics/dashboards/variables.md | 2 +- doc/operations/metrics/dashboards/yaml.md | 2 +- .../metrics/dashboards/yaml_number_format.md | 2 +- doc/operations/metrics/embed.md | 2 +- doc/operations/metrics/embed_grafana.md | 4 +- doc/operations/metrics/index.md | 2 +- doc/operations/tracing.md | 37 ++++--- 28 files changed, 194 insertions(+), 71 deletions(-) delete mode 100644 doc/operations/incident_management/img/custom_alert_mapping_v13_10.png create mode 100644 doc/operations/incident_management/img/custom_alert_mapping_v13_11.png create mode 100644 doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png create mode 100644 doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png create mode 100644 doc/operations/incident_management/oncall_schedules.md (limited to 'doc/operations') diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index 8bf0e56c989..18e5eaeef43 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -27,9 +27,9 @@ 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 **Operations > 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 > Operations**. 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. @@ -77,7 +77,7 @@ You can take action on Sentry Errors from within the GitLab UI. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/39665) in GitLab 12.7. -From within the [Error Details](#error-details) page you can ignore a Sentry error by simply clicking the **Ignore** button near the top of the page. +From within the [Error Details](#error-details) page you can ignore a Sentry error by clicking the **Ignore** button near the top of the page. Ignoring an error prevents it from appearing in the [Error Tracking List](#error-tracking-list), and silences notifications that were set up within Sentry. diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index 216e6adcdaf..dc0d5d77d27 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -62,11 +62,11 @@ next to any feature flag in the list. The maximum number of feature flags per project on self-managed GitLab instances is 200. For GitLab SaaS, the maximum number is determined by [tier](https://about.gitlab.com/pricing/): -| Tier | Number of feature flags per project | -|----------|-------------------------------------| -| Free | 50 | -| Premium | 150 | -| Ultimate | 200 | +| Tier | Feature flags per project (SaaS) | Feature flags per project (self-managed) | +|----------|----------------------------------|------------------------------------------| +| Free | 50 | 200 | +| Premium | 150 | 200 | +| Ultimate | 200 | 200 | ## Feature flag strategies @@ -104,7 +104,7 @@ Unleash activation strategy. Enables the feature for a percentage of page views, with configurable consistency of behavior. This consistency is also known as stickiness. It uses the -[`flexibleRollout`](https://unleash.github.io/docs/activation_strategy#flexiblerollout) +[`flexibleRollout`](https://docs.getunleash.io/docs/activation_strategy#flexiblerollout) Unleash activation strategy. You can configure the consistency to be based on: @@ -133,7 +133,7 @@ Selecting **Random** provides inconsistent application behavior for individual u ### Percent of Users Enables the feature for a percentage of authenticated users. It uses the Unleash activation strategy -[`gradualRolloutUserId`](https://unleash.github.io/docs/activation_strategy#gradualrolloutuserid). +[`gradualRolloutUserId`](https://docs.getunleash.io/docs/activation_strategy#gradualrolloutuserid). For example, set a value of 15% to enable the feature for 15% of authenticated users. @@ -155,7 +155,7 @@ ID for the feature to be enabled. See the [Ruby example](#ruby-application-examp > - [Updated](https://gitlab.com/gitlab-org/gitlab/-/issues/34363) to be defined per environment in GitLab 12.6. Enables the feature for a list of target users. It is implemented -using the Unleash [`userWithId`](https://unleash.github.io/docs/activation_strategy#userwithid) +using the Unleash [`userWithId`](https://docs.getunleash.io/docs/activation_strategy#userwithid) activation strategy. Enter user IDs as a comma-separated list of values (for example, @@ -171,7 +171,7 @@ target users. See the [Ruby example](#ruby-application-example) below. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/35930) in GitLab 13.1. Enables the feature for lists of users created [in the Feature Flags UI](#create-a-user-list), or with the [Feature Flag User List API](../api/feature_flag_user_lists.md). -Similar to [User IDs](#user-ids), it uses the Unleash [`userWithId`](https://unleash.github.io/docs/activation_strategy#userwithid) +Similar to [User IDs](#user-ids), it uses the Unleash [`userWithId`](https://docs.getunleash.io/docs/activation_strategy#userwithid) activation strategy. It's not possible to *disable* a feature for members of a user list, but you can achieve the same @@ -394,4 +394,4 @@ end You can link related issues to a feature flag. In the **Linked issues** section, click the `+` button and input the issue reference number or the full URL of the issue. -This feature is similar to the [related issues](../user/project/issues/related_issues.md) feature. +This feature is similar to the [linked issues](../user/project/issues/related_issues.md) feature. diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 3c60c737309..276009ac200 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png b/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png deleted file mode 100644 index b2527d3a298..00000000000 Binary files a/doc/operations/incident_management/img/custom_alert_mapping_v13_10.png and /dev/null differ diff --git a/doc/operations/incident_management/img/custom_alert_mapping_v13_11.png b/doc/operations/incident_management/img/custom_alert_mapping_v13_11.png new file mode 100644 index 00000000000..ea097af878f Binary files /dev/null and b/doc/operations/incident_management/img/custom_alert_mapping_v13_11.png differ diff --git a/doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png b/doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png new file mode 100644 index 00000000000..b51b7faf2d6 Binary files /dev/null and b/doc/operations/incident_management/img/oncall_schedule_day_grid_v13_10.png differ diff --git a/doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png b/doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png new file mode 100644 index 00000000000..154d1b57d28 Binary files /dev/null and b/doc/operations/incident_management/img/oncall_schedule_empty_grid_v13_10.png differ diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 317797376fc..078a1a0be08 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -39,7 +39,7 @@ Incident, you have two options to do this manually. 1. Go to **Issues > List**, and select **New issue**. 1. In the **Type** dropdown, select **Incident**. Only fields relevant to incidents are displayed on the page. -1. Create the incident as needed, and select **Submit issue** to save the +1. Create the incident as needed, and select **Create issue** to save the incident. ![Incident List Create](img/new_incident_create_v13_4.png) diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md index 6e285300b12..ff5f41e59e9 100644 --- a/doc/operations/incident_management/index.md +++ b/doc/operations/incident_management/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -13,6 +13,7 @@ generated by their application. By surfacing alerts and incidents where the code being developed, efficiency and awareness can be increased. Check out the following sections for more information: - [Integrate your monitoring tools](integrations.md). -- Receive [notifications](paging.md) for triggered alerts. +- Manage [on-call schedules](oncall_schedules.md) and receive [notifications](paging.md) for + triggered alerts. - Triage [Alerts](alerts.md) and [Incidents](incidents.md). - Inform stakeholders with [Status Page](status_page.md). diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 62a50255dd8..c675d995444 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -18,10 +18,10 @@ 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 **Alerts** section. -The list displays the integration name, type, and status (enabled or disabled): +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 +the integration name, type, and status (enabled or disabled): ![Current Integrations](img/integrations_list_v13_5.png) @@ -39,9 +39,11 @@ 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 **Alerts** section, and in the **Integration** dropdown menu, select **Generic**. -1. Toggle the **Active** alert setting to display the **URL** and **Authorization Key** - for the webhook configuration. +1. Expand the **Alert integrations** 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 + the URL and Authorization Key in your external service. ### HTTP Endpoints **(PREMIUM)** @@ -54,11 +56,11 @@ 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 **Alerts** section. +1. Expand the **Alert integrations** section. 1. For each endpoint you want to create: 1. Click the **Add new integration** button. - 1. In the **Integration** dropdown menu, select **HTTP Endpoint**. + 1. In the **Select integration type** dropdown menu, select **HTTP Endpoint**. 1. Name the integration. 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. @@ -85,7 +87,7 @@ correct information in the [Alert list](alerts.md) and the [Alert Details page](alerts.md#alert-details-page), map your alert's fields to GitLab fields when you [create an HTTP endpoint](#http-endpoints): -![Alert Management List](img/custom_alert_mapping_v13_10.png) +![Alert Management List](img/custom_alert_mapping_v13_11.png) ### External Prometheus integration @@ -165,9 +167,11 @@ 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 **Alerts endpoint** to expand the section. -1. Enter a sample payload in **Alert test payload** (valid JSON is required). -1. Click **Test alert payload**. +1. Click **Alert integrations** 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). +1. Click **Send**. GitLab displays an error or success message, depending on the outcome of your test. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md new file mode 100644 index 00000000000..87745639c69 --- /dev/null +++ b/doc/operations/incident_management/oncall_schedules.md @@ -0,0 +1,109 @@ +--- +stage: Monitor +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 +--- + +# On-call Schedule Management **(PREMIUM)** + +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4544) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.11. + +Use on-call schedule management to create schedules for responders to rotate on-call +responsibilities. Maintain the availability of your software services by putting your teams on-call. +With an on-call schedule, your team is notified immediately when things go wrong so they can quickly +respond to service outages and disruptions. + +To use on-call schedules, users with Maintainer [permissions](../../user/permissions.md) +must do the following: + +1. [Create a schedule](#schedules). +1. [Add a rotation to the schedule](#rotations). + +If you have at least Maintainer [permissions](../../user/permissions.md) +to create a schedule, you can do this manually. + +## Schedules + +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. In the **Add schedule** form, enter the schedule's name and description, and select a timezone. +1. Click **Add schedule**. + +You now have an empty schedule with no rotations. This renders as an empty state, prompting you to +create [rotations](#rotations) for your schedule. + +![Schedule Empty Grid](img/oncall_schedule_empty_grid_v13_10.png) + +### Edit a 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 + 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. + +If you change the schedule's time zone, GitLab automatically updates the rotation's restricted time +interval (if one is set) to the corresponding times in the new time zone. + +### Delete a schedule + +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 + schedule card. +1. In the **Delete schedule** window, click the **Delete schedule** button. + +## Rotations + +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 + current schedule. +1. In the **Add rotation** form, enter the following: + + - **Name:** Your rotation's name. + - **Participants:** The people you want in the rotation. + - **Rotation length:** The rotation's duration. + - **Starts on:** The date and time the rotation begins. + - **Enable end date:** With the toggle set to on, you can select the date and time your rotation + ends. + - **Restrict to time intervals:** With the toggle set to on, you can restrict your rotation to the + time period you select. + +### Edit 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 + 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. + +### Delete 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 + title of the rotation that you want to delete. +1. In the **Delete rotation** window, select the **Delete rotation** button. + +## View schedule rotations + +You can view the on-call schedules of a single day or two weeks. To switch between these time +periods, select the **1 day** or **2 weeks** buttons on the schedule. Two weeks is the default view. + +Hover over any rotation shift participants in the schedule to view their individual shift details. + +![1 Day Grid View](img/oncall_schedule_day_grid_v13_10.png) + +## Page an on-call responder + +When an alert is created in a project, GitLab sends an email to the on-call responder(s) in the +on-call schedule for that project. If there is no schedule or no one on-call in that schedule at the +time the alert is triggered, no email is sent. diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 4801f94d494..1588cb96218 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -32,3 +32,9 @@ a single email notification for new alerts. 1. In the **Alert Integration** tab, select the checkbox **Send a single email notification to Owners and Maintainers for new alerts**. 1. Select **Save changes**. + +## Paging **(PREMIUM)** + +In projects that have an [on-call schedule](oncall_schedules.md) configured, on-call responders are +paged through email for triggered alerts. The on-call responder(s) receive one email for triggered +alerts. diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index 46f0a6f278c..1e11a9c62e0 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/index.md b/doc/operations/index.md index 4427dd66f3d..934634562fc 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -51,7 +51,7 @@ and the work required to fix them - all without leaving GitLab. - Discover and view errors generated by your applications with [Error Tracking](error_tracking.md). -## Trace application health and performance **(ULTIMATE)** +## Trace application health and performance Application tracing in GitLab is a way to measure an application's performance and health while it's running. After configuring your application to enable tracing, you @@ -63,7 +63,7 @@ GitLab integrates with [Jaeger](https://www.jaegertracing.io/) - an open-source, end-to-end distributed tracing system tool used for monitoring and troubleshooting microservices-based distributed systems - and displays results within GitLab. -- [Trace the performance and health](tracing.md) of a deployed application. **(ULTIMATE)** +- [Trace the performance and health](tracing.md) of a deployed application. ## Aggregate and store logs diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 98beb8d6773..7763224d21e 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -17,6 +17,10 @@ your team when environment performance falls outside of the boundaries you set. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6590) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.2 for [custom metrics](index.md#adding-custom-metrics), and GitLab 11.3 for [library metrics](../../user/project/integrations/prometheus_library/index.md). +WARNING: +Managed Prometheus on Kubernetes is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/327796) +and scheduled for [removal in GitLab 14.0](https://gitlab.com/groups/gitlab-org/-/epics/4280). + 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: diff --git a/doc/operations/metrics/dashboards/default.md b/doc/operations/metrics/dashboards/default.md index 3c151586f12..2ba7a4e0d87 100644 --- a/doc/operations/metrics/dashboards/default.md +++ b/doc/operations/metrics/dashboards/default.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/develop.md b/doc/operations/metrics/dashboards/develop.md index 76ad609870c..28a4488014a 100644 --- a/doc/operations/metrics/dashboards/develop.md +++ b/doc/operations/metrics/dashboards/develop.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index a0ac4fe6226..7b056020a99 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/panel_types.md b/doc/operations/metrics/dashboards/panel_types.md index 4b942ffcf4f..dc96e2556ac 100644 --- a/doc/operations/metrics/dashboards/panel_types.md +++ b/doc/operations/metrics/dashboards/panel_types.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/settings.md b/doc/operations/metrics/dashboards/settings.md index 18cfd6c53b8..e998db6b51b 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/templating_variables.md b/doc/operations/metrics/dashboards/templating_variables.md index 72541f7ced5..20071300dec 100644 --- a/doc/operations/metrics/dashboards/templating_variables.md +++ b/doc/operations/metrics/dashboards/templating_variables.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/variables.md b/doc/operations/metrics/dashboards/variables.md index df2dd0939bb..31782b5c95f 100644 --- a/doc/operations/metrics/dashboards/variables.md +++ b/doc/operations/metrics/dashboards/variables.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/yaml.md b/doc/operations/metrics/dashboards/yaml.md index 138d9b28c76..45803598a40 100644 --- a/doc/operations/metrics/dashboards/yaml.md +++ b/doc/operations/metrics/dashboards/yaml.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/dashboards/yaml_number_format.md b/doc/operations/metrics/dashboards/yaml_number_format.md index dd652a0cc2b..3b6e10e647e 100644 --- a/doc/operations/metrics/dashboards/yaml_number_format.md +++ b/doc/operations/metrics/dashboards/yaml_number_format.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md index 87d84bfdfc0..d773d04f1cc 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 2548e81813b..ff92997e44b 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -19,7 +19,7 @@ You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.ht Your Grafana instance must: - Be available to the target user, either as a public dashboard or on the same network. -- Have [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer) installed. +- Have [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer/) installed. To use Grafana-rendered images: diff --git a/doc/operations/metrics/index.md b/doc/operations/metrics/index.md index ca7bce347d3..8ff45ac4015 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- diff --git a/doc/operations/tracing.md b/doc/operations/tracing.md index a4aae05c46d..a6647641527 100644 --- a/doc/operations/tracing.md +++ b/doc/operations/tracing.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Health +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 --- @@ -9,27 +9,26 @@ info: To determine the technical writer assigned to the Stage/Group associated w > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/7903) in GitLab Ultimate 11.5. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42645) to GitLab Free in 13.5. -Tracing provides insight into the performance and health of a deployed application, -tracking each function or microservice which handles a given request. +Tracing provides insight into the performance and health of a deployed application, tracking each +function or microservice that handles a given request. Tracing makes it easy to understand the +end-to-end flow of a request, regardless of whether you are using a monolithic or distributed +system. -This makes it easy to -understand the end-to-end flow of a request, regardless of whether you are using a monolithic or distributed system. +## Install Jaeger -## Jaeger tracing - -[Jaeger](https://www.jaegertracing.io/) is an open source, end-to-end distributed -tracing system used for monitoring and troubleshooting microservices-based distributed -systems. +[Jaeger](https://www.jaegertracing.io/) is an open source, end-to-end distributed tracing system +used for monitoring and troubleshooting microservices-based distributed systems. To learn more about +installing Jaeger, read the official +[Getting Started documentation](https://www.jaegertracing.io/docs/latest/getting-started/). -### Deploying Jaeger +See also: -To learn more about deploying Jaeger, read the official -[Getting Started documentation](https://www.jaegertracing.io/docs/latest/getting-started/). -There is an easy to use [all-in-one Docker image](https://www.jaegertracing.io/docs/latest/getting-started/#AllinoneDockerimage), -as well as deployment options for [Kubernetes](https://github.com/jaegertracing/jaeger-kubernetes) -and [OpenShift](https://github.com/jaegertracing/jaeger-openshift). +- An [all-in-one Docker image](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one). +- Deployment options for: + - [Kubernetes](https://github.com/jaegertracing/jaeger-kubernetes). + - [OpenShift](https://github.com/jaegertracing/jaeger-openshift). -### Enabling Jaeger +## Link to Jaeger GitLab provides an easy way to open the Jaeger UI from within your project: @@ -37,5 +36,5 @@ GitLab provides an easy way to open the Jaeger UI from within your project: [client libraries](https://www.jaegertracing.io/docs/latest/client-libraries/). 1. Navigate to your project's **Settings > Operations** 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 the configured Jaeger URL. +1. You can now visit **Operations > Tracing** in your project's sidebar and GitLab redirects you to + the configured Jaeger URL. -- cgit v1.2.3