diff options
Diffstat (limited to 'doc/operations')
26 files changed, 50 insertions, 51 deletions
diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index 7533646aa34..6f97f002a32 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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/feature_flags.md b/doc/operations/feature_flags.md index b0a180b5635..8903e99ab3b 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -168,7 +168,7 @@ target users. See the [Ruby example](#ruby-application-example) below. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/300299) in GitLab 14.4. Search your project and find any references of a feature flag in your -code so that you and clean it up when it's time to remove the feature flag. +code so that you can clean it up when it's time to remove the feature flag. To search for code references of a feature flag: @@ -345,7 +345,7 @@ import ( "log" "net/http" - "github.com/Unleash/unleash-client-go" + "github.com/Unleash/unleash-client-go/v3" ) type metricsInterface struct { diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index cdf7ca5c8bc..b03955edf87 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -10,7 +10,7 @@ Alerts are a critical entity in your incident management workflow. They represen ## Alert List -Users with at least the Developer [role](../../user/permissions.md) can +Users with at least the Developer role can 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. @@ -68,7 +68,7 @@ Alerts contain one of the following icons: ## Alert details page Navigate to the Alert details view by visiting the [Alert list](alerts.md) -and selecting an alert from the list. You need at least the Developer [role](../../user/permissions.md) +and selecting an alert from the list. You need at least the Developer role to access alerts. NOTE: @@ -96,7 +96,7 @@ instance. Prerequisite: -- You must have at least the Developer [role](../../user/permissions.md). +- You must have at least the Developer role. To view the metrics for an alert: @@ -120,7 +120,7 @@ your application's performance and how to resolve any problems. Prerequisite: -- You must have at least the Developer [role](../../user/permissions.md). +- You must have at least the Developer role. To view the logs for an alert: diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index 5f132720000..c24824e55f8 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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,7 +17,7 @@ where you manage [On-call schedules](oncall_schedules.md). Prerequisite: -- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have at least the Maintainer role. - You must have an [on-call schedule](oncall_schedules.md). To create an escalation policy: diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index ada1f426dd8..e142d060d87 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -21,15 +21,15 @@ You can create an incident manually or automatically. > - [Moved](https://gitlab.com/gitlab-org/monitor/monitor/-/issues/24) to GitLab Free in 13.3. > - [Permission changed](https://gitlab.com/gitlab-org/gitlab/-/issues/336624) from Guest to Reporter in GitLab 14.5. +> - Automatic application of the `incident` label [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/290964) in GitLab 14.8. If you have at least Reporter [permissions](../../user/permissions.md), you can create an incident manually from the Incidents List or the Issues List. To create an incident from the Incidents List: -1. Navigate to **Monitor > Incidents** and click **Create Incident**. -1. Create a new issue using the `incident` template available when creating it. -1. Create a new issue and assign the `incident` label to it. +1. Navigate to **Monitor > Incidents** and select **Create Incident**. +1. Create a new issue using the `incident` template.  @@ -47,15 +47,15 @@ To create an incident from the Issues List: ### Create incidents automatically **(ULTIMATE)** -With at least the Maintainer [role](../../user/permissions.md), you can enable - GitLab to create incident automatically whenever an alert is triggered: +With at least the Maintainer role, you can enable +GitLab to create incident automatically whenever an alert is triggered: 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). 1. To send [an email notification](paging.md#email-notifications) to users - with the Developer [role](../../user/permissions.md), select + with the Developer role, select **Send a separate email notification to Developers**. Email notifications are also sent to users with the **Maintainer** and **Owner** roles. 1. Click **Save changes**. @@ -68,7 +68,7 @@ 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 the Maintainer [role](../../user/permissions.md). +1. Sign in as a user with the Maintainer role. 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. 1. Select the **PagerDuty integration** tab: @@ -276,7 +276,7 @@ templates. > - [Introduced for Prometheus Integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13401) in GitLab 12.5. > - [Introduced for HTTP Integrations](https://gitlab.com/gitlab-org/gitlab/-/issues/13402) in GitLab 13.4. -With at least the Maintainer [role](../../user/permissions.md), you can enable +With at least the Maintainer role, you can enable GitLab to close an incident automatically when a **Recovery Alert** is received: 1. Navigate to **Settings > Monitor > Incidents** and expand **Incidents**. diff --git a/doc/operations/incident_management/index.md b/doc/operations/incident_management/index.md index ff5f41e59e9..3b38d4ab427 100644 --- a/doc/operations/incident_management/index.md +++ b/doc/operations/incident_management/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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/integrations.md b/doc/operations/incident_management/integrations.md index a8b455e05a0..fe05cb9fda0 100644 --- a/doc/operations/incident_management/integrations.md +++ b/doc/operations/incident_management/integrations.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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,7 +18,7 @@ to use this endpoint. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/245331) in GitLab 13.5. -With at least the Maintainer [role](../../user/permissions.md), you can view the list of configured +With at least the Maintainer role, 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): @@ -36,7 +36,7 @@ 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. -1. Sign in to GitLab as a user with the Maintainer [role](../../user/permissions.md) +1. Sign in to GitLab as a user with the Maintainer role for a project. 1. Navigate to **Settings > Monitor** in your project. 1. Expand the **Alerts** section, and in the **Select integration type** dropdown menu, @@ -53,7 +53,7 @@ In [GitLab Premium](https://about.gitlab.com/pricing/), you can create multiple unique HTTP endpoints to receive alerts from any external source in JSON format, and you can [customize the payload](#customize-the-alert-payload-outside-of-gitlab). -1. Sign in to GitLab as a user with the Maintainer [role](../../user/permissions.md) +1. Sign in to GitLab as a user with the Maintainer role for a project. 1. Navigate to **Settings > Monitor** in your project. 1. Expand the **Alerts** section. @@ -225,7 +225,7 @@ After a [project maintainer or owner](../../user/permissions.md) configures an integration, you can trigger a test alert to confirm your integration works properly. -1. Sign in as a user with at least the Developer [role](../../user/permissions.md). +1. Sign in as a user with at least the Developer role. 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). @@ -279,7 +279,7 @@ active at the same time. To enable Opsgenie integration: -1. Sign in as a user with the Maintainer or Owner [role](../../user/permissions.md). +1. Sign in as a user with the Maintainer or Owner role. 1. Navigate to **Monitor > Alerts**. 1. In the **Integrations** select box, select **Opsgenie**. 1. Select the **Active** toggle. diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 2a8f0eac59c..84ab5da77df 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -24,7 +24,7 @@ Set up an on-call schedule for your team to add rotations to. Prerequisite: -- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have at least the Maintainer role. To create an on-call schedule: diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 6fdf880783a..b6f77de3b4f 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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/status_page.md b/doc/operations/incident_management/status_page.md index 241112df521..fe75c1812c8 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -41,7 +41,7 @@ Only AWS S3 is supported as a deploy target. Prerequisite: -- You must have at least the Maintainer [role](../../user/permissions.md). +- You must have at least the Maintainer role. To provide GitLab with the AWS account information needed to push content to your Status Page: @@ -175,5 +175,5 @@ within GitLab. Closing the issue triggers a background worker to update the GitLab Status Page website. If you -[make a published issue confidential](../../user/project/issues/confidential_issues.md#making-an-issue-confidential), +[make a published issue confidential](../../user/project/issues/confidential_issues.md#make-an-issue-confidential), GitLab unpublishes it from your GitLab Status Page website. diff --git a/doc/operations/index.md b/doc/operations/index.md index 5a83e47b556..9b988ff561d 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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/alerts.md b/doc/operations/metrics/alerts.md index 712ee04e916..702ff944fc5 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -99,8 +99,7 @@ GitLab tags each incident issue with the `incident` label automatically. If the does not yet exist, it is also created automatically. If the metric exceeds the threshold of the alert for over 5 minutes, GitLab sends -an email to all [Maintainers and Owners](../../user/permissions.md#project-members-permissions) -of the project. +an email to all Maintainers and Owners of the project. ### Recovery alerts diff --git a/doc/operations/metrics/dashboards/default.md b/doc/operations/metrics/dashboards/default.md index 295c146f0d5..3e14917209a 100644 --- a/doc/operations/metrics/dashboards/default.md +++ b/doc/operations/metrics/dashboards/default.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 38f375c40a6..fc7686c8f86 100644 --- a/doc/operations/metrics/dashboards/develop.md +++ b/doc/operations/metrics/dashboards/develop.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 9a75703a2f1..a8ca23b7002 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 9b015760fe9..09e969e8af6 100644 --- a/doc/operations/metrics/dashboards/panel_types.md +++ b/doc/operations/metrics/dashboards/panel_types.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 f4c37718c52..14da5cf4a04 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 8ccd334dac3..531693d032f 100644 --- a/doc/operations/metrics/dashboards/templating_variables.md +++ b/doc/operations/metrics/dashboards/templating_variables.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 0008706df40..369bcd1ddeb 100644 --- a/doc/operations/metrics/dashboards/variables.md +++ b/doc/operations/metrics/dashboards/variables.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 9d1c270388e..81f1354d3c0 100644 --- a/doc/operations/metrics/dashboards/yaml.md +++ b/doc/operations/metrics/dashboards/yaml.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 ce9e359a587..fd83bff3c08 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: Monitor +group: Respond 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 e84c190e08d..6a3712d8377 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- @@ -53,7 +53,7 @@ The following requirements must be met for the metric to unfurl: - The `<environment_id>` must correspond to a real environment. - Prometheus must be monitoring the environment. - The GitLab instance must be configured to receive data from the environment. -- The user must be allowed access to the monitoring dashboard for the environment ([Reporter or higher](../../user/permissions.md)). +- The user must have at least the Reporter role for the monitoring dashboard for the environment. - The dashboard must have data within the last 8 hours. If all of the above are true, then the metric unfurls as seen below: diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 81b1f8a3bc6..5bfb097619d 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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/index.md b/doc/operations/metrics/index.md index f09b9f35d88..b04e19807f8 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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/product_analytics.md b/doc/operations/product_analytics.md index 3ff33027042..a55cbe906a0 100644 --- a/doc/operations/product_analytics.md +++ b/doc/operations/product_analytics.md @@ -50,7 +50,7 @@ Feature.disable(:product_analytics, Project.find(<project ID>)) After enabling the feature flag for Product Analytics, you can access the user interface: -1. Sign in to GitLab as a user with at least the Reporter [role](../user/permissions.md). +1. Sign in to GitLab as a user with at least the Reporter role. 1. Navigate to **Monitor > Product Analytics**. The user interface contains: diff --git a/doc/operations/tracing.md b/doc/operations/tracing.md index 09a31c12bf4..044f6800e73 100644 --- a/doc/operations/tracing.md +++ b/doc/operations/tracing.md @@ -1,6 +1,6 @@ --- stage: Monitor -group: Monitor +group: Respond 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 --- |