diff options
Diffstat (limited to 'doc/operations')
32 files changed, 119 insertions, 124 deletions
diff --git a/doc/operations/cleaning_up_redis_sessions.md b/doc/operations/cleaning_up_redis_sessions.md index bde7fffd090..96f72099f8f 100644 --- a/doc/operations/cleaning_up_redis_sessions.md +++ b/doc/operations/cleaning_up_redis_sessions.md @@ -3,3 +3,6 @@ redirect_to: '../administration/operations/cleaning_up_redis_sessions.md' --- This document was moved to [another location](../administration/operations/cleaning_up_redis_sessions.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index fad2c0e39be..6fa67c375c9 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Error Tracking @@ -20,7 +20,7 @@ You can sign up to the cloud hosted [Sentry](https://sentry.io), deploy your own ### Enabling Sentry -GitLab provides an easy way to connect Sentry to your project. You will need at +GitLab provides an easy way to connect Sentry to your project. You need at least Maintainer [permissions](../user/permissions.md) to enable the Sentry integration. 1. Sign up to Sentry.io or [deploy your own](#deploying-sentry) Sentry instance. @@ -31,7 +31,7 @@ least Maintainer [permissions](../user/permissions.md) to enable the Sentry inte click **Enable Error Tracking**. 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 will be `https://sentry.io`. +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. @@ -65,7 +65,7 @@ By default, a **Create issue** button is displayed:  -If you create a GitLab issue from the error, the **Create issue** button will change to a **View issue** button and a link to the GitLab issue will surface within the error detail section: +If you create a GitLab issue from the error, the **Create issue** button changes to a **View issue** button and a link to the GitLab issue displays within the error detail section:  @@ -79,7 +79,7 @@ You can take action on Sentry Errors from within the GitLab UI. 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. -Ignoring an error will prevent it from appearing in the [Error Tracking List](#error-tracking-list), and will silence notifications that were set up within Sentry. +Ignoring an error prevents it from appearing in the [Error Tracking List](#error-tracking-list), and silences notifications that were set up within Sentry. ### Resolving errors @@ -88,6 +88,6 @@ Ignoring an error will prevent it from appearing in the [Error Tracking List](#e From within the [Error Details](#error-details) page you can resolve a Sentry error by clicking the **Resolve** button near the top of the page. -Marking an error as resolved indicates that the error has stopped firing events. If a GitLab issue is linked to the error, then the issue will be closed. +Marking an error as resolved indicates that the error has stopped firing events. If a GitLab issue is linked to the error, then the issue closes. If another event occurs, the error reverts to unresolved. diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index cac243edded..e22a45fc18c 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -1,7 +1,7 @@ --- stage: Release -group: Progressive Delivery -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/#designated-technical-writers +group: Release +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 --- # Feature Flags **(CORE)** @@ -18,7 +18,7 @@ delivery from customer launch. <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For an example of feature flags in action, see [GitLab for Deploys, Feature Flags, and Error Tracking](https://www.youtube.com/embed/5tw2p6lwXxo). -NOTE: **Note:** +NOTE: The Feature Flags GitLab offer as a feature (described in this document) is not the same method used for the [development of GitLab](../development/feature_flags/index.md). @@ -77,7 +77,6 @@ is 200. On GitLab.com, the maximum number is determined by [GitLab.com tier](htt > - It became [enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/214684) in GitLab 13.2. > - It's recommended for production use. > - It's enabled on GitLab.com. -> - For GitLab self-managed instances, a GitLab administrator can choose to [disable it](#enable-or-disable-feature-flag-strategies). **(CORE ONLY)** You can apply a feature flag strategy across multiple environments, without defining the strategy multiple times. @@ -130,7 +129,7 @@ The rollout percentage can be from 0% to 100%. Selecting a consistency based on User IDs functions the same as the [percent of Users](#percent-of-users) rollout. -CAUTION: **Caution:** +WARNING: Selecting **Random** provides inconsistent application behavior for individual users. ### Percent of Users @@ -148,7 +147,7 @@ but not anonymous users. Note that [percent rollout](#percent-rollout) with a consistency based on **User IDs** has the same behavior. We recommend using percent rollout because it's more flexible than percent of users -CAUTION: **Caution:** +WARNING: If the percent of users strategy is selected, then the Unleash client **must** be given a user ID for the feature to be enabled. See the [Ruby example](#ruby-application-example) below. @@ -165,7 +164,7 @@ Enter user IDs as a comma-separated list of values (for example, `user@example.com, user2@example.com`, or `username1,username2,username3`, and so on). Note that user IDs are identifiers for your application users. They do not need to be GitLab users. -CAUTION: **Caution:** +WARNING: The Unleash client **must** be given a user ID for the feature to be enabled for target users. See the [Ruby example](#ruby-application-example) below. @@ -222,25 +221,6 @@ To remove users from a user list: 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. -### Enable or disable feature flag strategies - -This feature is under development, but is ready for production use. It's -deployed behind a feature flag that is **enabled by default**. -[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) -can disable it for your instance. - -To disable it: - -```ruby -Feature.disable(:feature_flags_new_version) -``` - -To enable it: - -```ruby -Feature.enable(:feature_flags_new_version) -``` - ## Rollout strategy (legacy) > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8240) in GitLab 12.2. diff --git a/doc/operations/incident_management/alert_details.md b/doc/operations/incident_management/alert_details.md index 459331ea0a5..cd73e9e7e1f 100644 --- a/doc/operations/incident_management/alert_details.md +++ b/doc/operations/incident_management/alert_details.md @@ -3,3 +3,6 @@ redirect_to: alerts.md --- This document was moved to [another location](alerts.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/operations/incident_management/alert_integrations.md b/doc/operations/incident_management/alert_integrations.md index 7850841d380..70c4e7f2f29 100644 --- a/doc/operations/incident_management/alert_integrations.md +++ b/doc/operations/incident_management/alert_integrations.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Alert integrations @@ -27,12 +27,12 @@ The list displays the integration name, type, and status (enabled or disabled): ## Configuration -GitLab can receive alerts via a [HTTP endpoint](#generic-http-endpoint) that you configure, +GitLab can receive alerts via a HTTP endpoint that you configure, or the [Prometheus integration](#external-prometheus-integration). -### Generic HTTP Endpoint **CORE** +### Single HTTP Endpoint **CORE** -Enabling the Generic HTTP Endpoint activates a unique HTTP endpoint that can +Enabling the HTTP Endpoint in a GitLab projects activates it to receive alert payloads in JSON format. You can always [customize the payload](#customize-the-alert-payload-outside-of-gitlab) to your liking. @@ -60,10 +60,10 @@ and you can [customize the payload](#customize-the-alert-payload-outside-of-gitl 1. In the **Integration** dropdown menu, select **HTTP Endpoint**. 1. Name the integration. 1. Toggle the **Active** alert setting to display the **URL** and **Authorization Key** - for the webhook configuration. You will input the URL and Authorization Key + for the webhook configuration. You must also input the URL and Authorization Key in your external service. 1. _(Optional)_ To generate a test alert to test the new integration, enter a - sample payload, then click **Save and test alert payload**.Valid JSON is required. + sample payload, then click **Save and test alert payload**. Valid JSON is required. 1. Click **Save Integration**. The new HTTP Endpoint displays in the [integrations list](#integrations-list). @@ -102,7 +102,7 @@ can be a nested JSON object. For example: { "foo": { "bar": { "baz": 42 } } } ``` -TIP: **Tip:** +NOTE: Ensure your requests are smaller than the [payload application limits](../../administration/instance_limits.md#generic-alert-json-payloads). @@ -170,18 +170,18 @@ If the existing alert is already `resolved`, GitLab creates a new alert instead. ## Link to your Opsgenie Alerts -DANGER: **Deprecated:** +WARNING: We are building deeper integration with Opsgenie and other alerting tools through -[HTTP endpoint integrations](#generic-http-endpoint) so you can see alerts within +[HTTP endpoint integrations](#single-http-endpoint) so you can see alerts within the GitLab interface. As a result, the previous direct link to Opsgenie Alerts from -the GitLab alerts list will be deprecated following the 13.7 release on December 22, 2020. +the GitLab alerts list is scheduled for deprecation following the 13.7 release on December 22, 2020. > [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.2. You can monitor alerts using a GitLab integration with [Opsgenie](https://www.atlassian.com/software/opsgenie). If you enable the Opsgenie integration, you can't have other GitLab alert -services, such as [Generic Alerts](generic_alerts.md) or Prometheus alerts, +services active at the same time. To enable Opsgenie integration: diff --git a/doc/operations/incident_management/alert_notifications.md b/doc/operations/incident_management/alert_notifications.md index 130c4e82088..eaf606105d6 100644 --- a/doc/operations/incident_management/alert_notifications.md +++ b/doc/operations/incident_management/alert_notifications.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Paging and notifications diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 37836f4ab50..a8852a02f2b 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -1,12 +1,12 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Alerts -Alerts are a critical entity in your incident managment workflow. They represent a notable event that might indicate a service outage or disruption. GitLab provides a list view for triage and detail view for deeper investigation of what happened. +Alerts are a critical entity in your incident management workflow. They represent a notable event that might indicate a service outage or disruption. GitLab provides a list view for triage and detail view for deeper investigation of what happened. ## Alert List @@ -37,7 +37,7 @@ The alert list displays the following information: - **Acknowledged**: Someone is actively investigating the problem. - **Resolved**: No further work is required. -TIP: **Tip:** +NOTE: Check out a live example available from the [`tanuki-inc` project page](https://gitlab-examples-ops-incident-setup-everyone-tanuki-inc.34.69.64.147.nip.io/) in GitLab to examine alerts in action. @@ -67,7 +67,7 @@ Navigate to the Alert details view by visiting the [Alert list](alerts.md) and selecting an alert from the list. You need least Developer [permissions](../../user/permissions.md) to access alerts. -TIP: **Tip:** +NOTE: To review live examples of GitLab alerts, visit the [alert list](https://gitlab.com/gitlab-examples/ops/incident-setup/everyone/tanuki-inc/-/alert_management) for this demo project. Select any alert in the list to examine its alert details @@ -78,13 +78,13 @@ amount of information you need. ### Alert details tab -The **Alert details** tab has two sections. The top section provides a short list of critical details such as the severity, start time, number of events, and originating monitorting tool. The second section displays the full alert payload. +The **Alert details** tab has two sections. The top section provides a short list of critical details such as the severity, start time, number of events, and originating monitoring tool. The second section displays the full alert payload. ### Metrics tab > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.2. -The **Metrics** tab will display a metrics chart for alerts coming from Prometheus. If the alert originated from any other tool, the **Metrics** tab will be empty. To set up alerts for GitLab-managed Prometheus instances, see [Managed Prometheus instances](../metrics/alerts.md#managed-prometheus-instances). For externally-managed Prometheus instances, you will need to configure your alerting +The **Metrics** tab displays a metrics chart for alerts coming from Prometheus. If the alert originated from any other tool, the **Metrics** tab is empty. To set up alerts for GitLab-managed Prometheus instances, see [Managed Prometheus instances](../metrics/alerts.md#managed-prometheus-instances). For externally-managed Prometheus instances, you must configure your alerting rules to display a chart in the alert. For information about how to configure your alerting rules, see [Embedding metrics based on alerts in incident issues](../metrics/embed.md#embedding-metrics-based-on-alerts-in-incident-issues). See [External Prometheus instances](../metrics/alerts.md#external-prometheus-instances) @@ -127,7 +127,7 @@ To view the logs for an alert: The **Activity feed** tab is a log of activity on the alert. When you take action on an alert, this is logged as a system note. This gives you a linear timeline of the alert's investigation and assignment history. -The following actions will result in a system note: +The following actions result in a system note: - [Updating the status of an alert](#update-an-alerts-status) - [Creating an incident based on an alert](#create-an-incident-from-an-alert) @@ -137,7 +137,7 @@ The following actions will result in a system note: ## Alert actions -There are different actions avilable in GitLab to help triage and respond to alerts. +There are different actions available in GitLab to help triage and respond to alerts. ### Update an alert's status @@ -222,7 +222,7 @@ the correct runbook: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232492) in GitLab 13.5 behind a feature flag, disabled by default. > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/232492) in GitLab 13.6. -CAUTION: **Warning:** +WARNING: This feature might not be available to you. Check the **version history** note above for details. The environment information and the link are displayed in the [Alert Details tab](#alert-details-tab). diff --git a/doc/operations/incident_management/generic_alerts.md b/doc/operations/incident_management/generic_alerts.md index 29d609f1811..44b1f4b088a 100644 --- a/doc/operations/incident_management/generic_alerts.md +++ b/doc/operations/incident_management/generic_alerts.md @@ -3,3 +3,6 @@ redirect_to: alert_integrations.md --- This document was moved to [another location](alert_integrations.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/operations/incident_management/img/incident_management_settings_v13_3.png b/doc/operations/incident_management/img/incident_management_settings_v13_3.png Binary files differdeleted file mode 100644 index c9520860414..00000000000 --- a/doc/operations/incident_management/img/incident_management_settings_v13_3.png +++ /dev/null diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 13a755bbb6f..074cacd2e30 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Incidents @@ -46,10 +46,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 > Operations > 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#creating-issue-templates). @@ -121,7 +118,7 @@ display an arrow next to the column name. Incidents share the [Issues API](../../user/project/issues/index.md). -TIP: **Tip:** +NOTE: For a live example of the incident list in action, visit this [demo project](https://gitlab.com/gitlab-examples/ops/incident-setup/everyone/tanuki-inc/-/incidents). diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md index 60571c03d74..b0274537941 100644 --- a/doc/operations/incident_management/index.md +++ b/doc/operations/incident_management/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Incident management diff --git a/doc/operations/incident_management/integrations.md b/doc/operations/incident_management/integrations.md index 9d4f32ab2bf..8c2159c130b 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Integrations diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index 4230091866e..6514a80a32b 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Status Page @@ -83,7 +83,7 @@ the necessary CI/CD variables to deploy the Status Page to AWS S3: 1. Navigate to **CI / CD > Pipelines > Run Pipeline**, and run the pipeline to deploy the Status Page to S3. -CAUTION: **Caution:** +WARNING: Consider limiting who can access issues in this project, as any user who can view the issue can potentially [publish comments to your GitLab Status Page](#publish-comments-on-incidents). @@ -128,11 +128,11 @@ To publish an incident: issue to the GitLab Status Page. Confidential issues can't be published. A background worker publishes the issue onto the Status Page using the credentials -you provided during setup. As part of publication, GitLab will: +you provided during setup. As part of publication, GitLab: -- Anonymize user and group mentions with `Incident Responder`. -- Remove titles of non-public [GitLab references](../../user/markdown.md#special-gitlab-references). -- Publish any files attached to incident issue descriptions, up to 5000 per issue. +- Anonymizes user and group mentions with `Incident Responder`. +- Removes titles of non-public [GitLab references](../../user/markdown.md#special-gitlab-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).) After publication, you can access the incident's details page by clicking the @@ -144,7 +144,7 @@ After publication, you can access the incident's details page by clicking the To publish an update to the Incident, update the incident issue's description. -CAUTION: **Caution:** +WARNING: When referenced issues are changed (such as title or confidentiality) the incident they were referenced in is not updated. @@ -159,7 +159,7 @@ To publish comments to the Status Page Incident: - Any files attached to the comment (up to 5000 per issue) are also published. ([Introduced in GitLab 13.1](https://gitlab.com/gitlab-org/gitlab/-/issues/205166).) -CAUTION: **Caution:** +WARNING: Anyone with access to view the Issue can add an emoji award to a comment, so consider limiting access to issues to team members only. diff --git a/doc/operations/index.md b/doc/operations/index.md index 8488f939893..1d738768531 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 **(CORE)** @@ -81,7 +81,7 @@ infrastructure. GitLab stores and executes your infrastructure as code, whether it's defined in Ansible, Puppet or Chef. We also offer native integration with [Terraform](https://www.terraform.io/), uniting your GitOps and -Infrastructure-as-Code (IaC) workflows with GitLab's authentication, authorization, +Infrastructure-as-Code (IaC) workflows with the GitLab authentication, authorization, and user interface. By lowering the barrier to entry for adopting Terraform, you can manage and provision infrastructure through machine-readable definition files, rather than physical hardware configuration or interactive configuration tools. diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 79e3bdbd69c..36a73d66609 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Set up alerts for Prometheus metrics **(CORE)** @@ -53,8 +53,8 @@ as soon as the alert fires: 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 **URL** and **Authorization Key** you will need. The -**Reset Key** button will invalidate the key and generate a new one. +This section contains the needed **URL** and **Authorization Key**. The +**Reset Key** button invalidates the key and generates a new one.  @@ -80,12 +80,12 @@ Prometheus. The value of this should match the name of your environment in GitLa In GitLab versions 13.1 and greater, you can configure your manually configured Prometheus server to use the -[Generic alerts integration](../incident_management/generic_alerts.md). +[Generic alerts integration](../incident_management/alert_integrations.md). ## Trigger actions from alerts **(ULTIMATE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4925) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.11. -> - [From GitLab Ultimate 12.5](https://gitlab.com/gitlab-org/gitlab/-/issues/13401), when GitLab receives a recovery alert, it will automatically close the associated issue. +> - [From GitLab Ultimate 12.5](https://gitlab.com/gitlab-org/gitlab/-/issues/13401), when GitLab receives a recovery alert, it automatically closes the associated issue. Alerts can be used to trigger actions, like opening an issue automatically (disabled by default since `13.1`). To configure the actions: diff --git a/doc/operations/metrics/dashboards/default.md b/doc/operations/metrics/dashboards/default.md index 11e96114f38..5c6187565dd 100644 --- a/doc/operations/metrics/dashboards/default.md +++ b/doc/operations/metrics/dashboards/default.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # GitLab-defined metrics dashboards **(CORE)** diff --git a/doc/operations/metrics/dashboards/develop.md b/doc/operations/metrics/dashboards/develop.md index 9254bfe075f..800ed401efb 100644 --- a/doc/operations/metrics/dashboards/develop.md +++ b/doc/operations/metrics/dashboards/develop.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Developing templates for custom dashboards **(CORE)** diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index c11da2926bb..f875c4a87c5 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Custom dashboards **(CORE)** @@ -65,9 +65,9 @@ To create a new dashboard from the command line: Your custom dashboard is available at `https://example.com/project/-/metrics/custom_dashboard_name.yml`. -NOTE: **Note:** -Configuration files nested under subdirectories of `.gitlab/dashboards` are not -supported and won't be available in the UI. +NOTE: +Configuration files nested under subdirectories of `.gitlab/dashboards` aren't +supported or available in the UI. ## Add a new metrics panel to a dashboard @@ -81,7 +81,7 @@ with the **Add Panel** page: [permissions](../../../user/permissions.md#project-members-permissions). 1. Click **Add panel** in the **{ellipsis_v}** **More actions** menu. - NOTE: **Note:** + NOTE: You can only add panels to custom dashboards.  @@ -156,7 +156,7 @@ and end times to the URL, enabling you to share specific timeframes more easily. You can use **Metrics Dashboard Annotations** to mark any important events on every metrics dashboard by adding annotations to it. While viewing a dashboard, -annotation entries assigned to the selected time range will be automatically +annotation entries assigned to the selected time range are automatically fetched and displayed on every chart within that dashboard. On mouse hover, each annotation presents additional details, including the exact time of an event and its description. diff --git a/doc/operations/metrics/dashboards/panel_types.md b/doc/operations/metrics/dashboards/panel_types.md index fd9d2bf7899..86f6776e273 100644 --- a/doc/operations/metrics/dashboards/panel_types.md +++ b/doc/operations/metrics/dashboards/panel_types.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Panel types for dashboards **(CORE)** @@ -39,7 +39,7 @@ Note the following properties:  -Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696), the y-axis values will automatically scale according to the data. Previously, it always started from 0. +Starting in [version 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/202696), the y-axis values scale according to the data. Previously, it always started from 0. ## Anomaly chart @@ -229,7 +229,7 @@ For example, if you have a query value of `53.6`, adding `%` as the unit results ## Gauge -CAUTION: **Warning:** +WARNING: This panel type is an _alpha_ feature, and is subject to change at any time without prior notice! @@ -307,7 +307,7 @@ Note the following properties:  -CAUTION: **Warning:** +WARNING: When a query returns too many data points, the heatmap data bucket dimensions tend downwards to 0, making the chart's data invisible, as shown in the image below. To fix this problem, limit the amount of data returned by changing the time range filter on the metrics dashboard UI, or adding the **step** property to your dashboard's YAML file.  diff --git a/doc/operations/metrics/dashboards/settings.md b/doc/operations/metrics/dashboards/settings.md index 6052b0778da..92f3a14aab9 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Dashboard settings diff --git a/doc/operations/metrics/dashboards/templating_variables.md b/doc/operations/metrics/dashboards/templating_variables.md index 1c0b05b0e53..db02cc3bf98 100644 --- a/doc/operations/metrics/dashboards/templating_variables.md +++ b/doc/operations/metrics/dashboards/templating_variables.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Templating variables for metrics dashboards **(CORE)** @@ -21,12 +21,12 @@ described [in Using Variables](variables.md). ## `text` variable type -CAUTION: **Warning:** +WARNING: This variable type is an _alpha_ feature, and is subject to change at any time without prior notice! -For each `text` variable defined in the dashboard YAML, there will be a free text -box on the dashboard UI, allowing you to enter a value for each variable. +For each `text` variable defined in the dashboard YAML, a free text field displays +on the dashboard UI, allowing you to enter a value for each variable. The `text` variable type supports a simple and a full syntax. @@ -44,7 +44,7 @@ templating: ### Full syntax This example creates a variable called `variable1`, with a default value of `default`. -The label for the text box on the UI will be the value of the `label` key: +The label for the text box on the UI is the value of the `label` key: ```yaml templating: @@ -58,7 +58,7 @@ templating: ## `custom` variable type -CAUTION: **Warning:** +WARNING: This variable type is an _alpha_ feature, and is subject to change at any time without prior notice! @@ -70,7 +70,7 @@ The `custom` variable type supports a simple and a full syntax. ### Simple syntax This example creates a variable called `variable1`, with a default value of `value1`. -The dashboard UI will display a dropdown with `value1`, `value2` and `value3` +The dashboard UI displays a dropdown with `value1`, `value2` and `value3` as the choices. ```yaml @@ -82,12 +82,12 @@ templating: ### Full syntax This example creates a variable called `variable1`, with a default value of `value_option_2`. -The label for the text box on the UI will be the value of the `label` key. -The dashboard UI will display a dropdown with `Option 1` and `Option 2` +The label for the text box on the UI is the value of the `label` key. +The dashboard UI displays a dropdown with `Option 1` and `Option 2` as the choices. -If you select `Option 1` from the dropdown, the variable will be replaced with `value option 1`. -Similarly, if you select `Option 2`, the variable will be replaced with `value_option_2`: +If you select `Option 1` from the dropdown, the variable is replaced with `value option 1`. +Similarly, if you select `Option 2`, the variable is replaced with `value_option_2`: ```yaml templating: @@ -106,14 +106,14 @@ templating: ## `metric_label_values` variable type -CAUTION: **Warning:** +WARNING: This variable type is an _alpha_ feature, and is subject to change at any time without prior notice! ### Full syntax -This example creates a variable called `variable2`. The values of the dropdown will -be all the different values of the `backend` label in the Prometheus series described by +This example creates a variable called `variable2`. The values of the dropdown are +all the different values of the `backend` label in the Prometheus series described by `up{env="production"}`. ```yaml diff --git a/doc/operations/metrics/dashboards/variables.md b/doc/operations/metrics/dashboards/variables.md index e1f5f0ce6f4..9c5ff3bd13b 100644 --- a/doc/operations/metrics/dashboards/variables.md +++ b/doc/operations/metrics/dashboards/variables.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Using variables **(CORE)** @@ -12,7 +12,7 @@ Variables can be specified using double curly braces, such as `"{{ci_environment Support for the `"%{ci_environment_slug}"` format was [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31581) in GitLab 13.0. -Queries that continue to use the old format will show no data. +Queries that continue to use the old format display no data. ## Predefined variables diff --git a/doc/operations/metrics/dashboards/yaml.md b/doc/operations/metrics/dashboards/yaml.md index 13397eb702a..db49de7e800 100644 --- a/doc/operations/metrics/dashboards/yaml.md +++ b/doc/operations/metrics/dashboards/yaml.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Dashboard YAML properties **(CORE)** @@ -53,7 +53,7 @@ is no longer used. | `group` | string | required | Heading for the panel group. | | `panels` | array | required | The panels which should be in the panel group. | -Panels in a panel group are laid out in rows consisting of two panels per row. An exception to this rule are single panels on a row: these panels will take the full width of their containing row. +Panels in a panel group are laid out in rows consisting of two panels per row. An exception to this rule are single panels on a row: these panels take the full width of their containing row. ## **Panel (`panels`) properties** @@ -87,15 +87,15 @@ is no longer used. | `id` | string | no | Used for associating dashboard metrics with database records. Must be unique across dashboard configuration files. Required for [alerting](../alerts.md) (support not yet enabled, see [relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/27980)). | | `unit` | string | yes | Defines the unit of the query's return data. | | `label` | string | no, but highly encouraged | Defines the legend-label for the query. Should be unique within the panel's metrics. Can contain time series labels as interpolated variables. | -| `query` | string/number | yes if `query_range` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) will be used. | -| `query_range` | string/number | yes if `query` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query_range` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) will be used. | +| `query` | string/number | yes if `query_range` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) is used. | +| `query_range` | string/number | yes if `query` is not defined | Defines the Prometheus query to be used to populate the chart/panel. If defined, the `query_range` endpoint of the [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/) is used. | | `step` | number | no, value is calculated if not defined | Defines query resolution step width in float number of seconds. Metrics on the same panel should use the same `step` value. | ## Dynamic labels Dynamic labels are useful when multiple time series are returned from a Prometheus query. -When a static label is used and a query returns multiple time series, then all the legend items will be labeled the same, which makes identifying each time series difficult: +When a static label is used and a query returns multiple time series, then all the legend items are labeled the same, which makes identifying each time series difficult: ```yaml metrics: @@ -109,7 +109,7 @@ This may render a legend like this:  -For labels to be more explicit, using variables that reflect time series labels is a good practice. The variables will be replaced by the values of the time series labels when the legend is rendered: +For labels to be more explicit, using variables that reflect time series labels is a good practice. The variables are replaced by the values of the time series labels when the legend is rendered: ```yaml metrics: @@ -119,7 +119,7 @@ metrics: unit: 'count' ``` -The resulting rendered legend will look like this: +The resulting rendered legend looks like this:  @@ -133,7 +133,7 @@ metrics: unit: 'count' ``` -This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value will be used and rendered in the legend like this: +This works by lowercasing the value of `label` and, if there are more words separated by spaces, replacing those spaces with an underscore (`_`). The transformed value is then checked against the labels of the time series returned by the Prometheus query. If a time series label is found that is equal to the transformed value, then the label value renders in the legend like this:  diff --git a/doc/operations/metrics/dashboards/yaml_number_format.md b/doc/operations/metrics/dashboards/yaml_number_format.md index db1606faf8d..27e4b905597 100644 --- a/doc/operations/metrics/dashboards/yaml_number_format.md +++ b/doc/operations/metrics/dashboards/yaml_number_format.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Unit formats reference **(CORE)** diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md index c0b30f18156..9a9a0b4cff2 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Embedding metric charts within GitLab-flavored Markdown **(CORE)** @@ -19,7 +19,7 @@ metrics to others, and you want to have relevant information directly available. This feature requires [Kubernetes](../../user/project/integrations/prometheus_library/kubernetes.md) metrics. -Note: **Note:** +NOTE: In GitLab versions 13.3 and earlier, metrics dashboard links were in the form `https://<root_url>/<project>/-/environments/<environment_id>/metrics`. These links are still supported, and can be used to embed metric charts. diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 532bf150777..21950354ae9 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Embedding Grafana charts **(CORE)** @@ -23,7 +23,7 @@ For this embed to display correctly, the Copy the link and add an image tag as [inline HTML](../../user/markdown.md#inline-html) in your Markdown. You can tweak the query parameters to meet your needs, such as removing the `&from=` and `&to=` parameters to display a live chart. Here is example -markup for a live chart from GitLab's public dashboard: +markup for a live chart from a GitLab public dashboard: ```html <img src="https://dashboards.gitlab.com/d/RZmbBr7mk/gitlab-triage?orgId=1&refresh=30s&var-env=gprd&var-environment=gprd&var-prometheus=prometheus-01-inf-gprd&var-prometheus_app=prometheus-app-01-inf-gprd&var-backend=All&var-type=All&var-stage=main&from=1580444107655&to=1580465707655"/> diff --git a/doc/operations/metrics/index.md b/doc/operations/metrics/index.md index 6ce0bd42d3c..7cd18e5606b 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Monitor your environment's metrics **(CORE)** @@ -147,7 +147,7 @@ After saving them, they display on the environment metrics dashboard provided th A few fields are required: - **Name**: Chart title -- **Type**: Type of metric. Metrics of the same type will be shown together. +- **Type**: Type of metric. Metrics of the same type are shown together. - **Query**: Valid [PromQL query](https://prometheus.io/docs/prometheus/latest/querying/basics/). - **Y-axis label**: Y axis title to display on the dashboard. - **Unit label**: Query units, for example `req / sec`. Shown next to the value. diff --git a/doc/operations/moving_repositories.md b/doc/operations/moving_repositories.md index 57d47e3e9ea..07df1607d37 100644 --- a/doc/operations/moving_repositories.md +++ b/doc/operations/moving_repositories.md @@ -3,3 +3,6 @@ redirect_to: '../administration/operations/moving_repositories.md' --- This document was moved to [another location](../administration/operations/moving_repositories.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/operations/product_analytics.md b/doc/operations/product_analytics.md index 65dced97002..e6e887b9738 100644 --- a/doc/operations/product_analytics.md +++ b/doc/operations/product_analytics.md @@ -1,7 +1,7 @@ --- stage: Growth group: Product Analytics -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/#designated-technical-writers +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 --- # Product Analytics **(CORE)** @@ -70,7 +70,7 @@ database from growing too quickly. Product Analytics stores events are stored in GitLab database. -CAUTION: **Caution:** +WARNING: This data storage is experimental, and GitLab is likely to remove this data during future development. diff --git a/doc/operations/sidekiq_memory_killer.md b/doc/operations/sidekiq_memory_killer.md index 2df4a6e5648..b98e4abb4d0 100644 --- a/doc/operations/sidekiq_memory_killer.md +++ b/doc/operations/sidekiq_memory_killer.md @@ -3,3 +3,6 @@ redirect_to: '../administration/operations/sidekiq_memory_killer.md' --- This document was moved to [another location](../administration/operations/sidekiq_memory_killer.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/operations/tracing.md b/doc/operations/tracing.md index b6ef552772e..c08651560e0 100644 --- a/doc/operations/tracing.md +++ b/doc/operations/tracing.md @@ -1,7 +1,7 @@ --- stage: Monitor group: Health -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/#designated-technical-writers +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 --- # Tracing @@ -38,4 +38,4 @@ GitLab provides an easy way to open the Jaeger UI from within your project: 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 will redirect you to the configured Jaeger URL. + GitLab redirects you to the configured Jaeger URL. diff --git a/doc/operations/unicorn.md b/doc/operations/unicorn.md index 949f4a66c9d..d10b7f8bbb9 100644 --- a/doc/operations/unicorn.md +++ b/doc/operations/unicorn.md @@ -3,3 +3,6 @@ redirect_to: '../administration/operations/unicorn.md' --- This document was moved to [another location](../administration/operations/unicorn.md). + +<!-- This redirect file can be deleted after February 1, 2021. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> |
