diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-17 14:59:07 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-17 14:59:07 +0300 |
commit | 8b573c94895dc0ac0e1d9d59cf3e8745e8b539ca (patch) | |
tree | 544930fb309b30317ae9797a9683768705d664c4 /doc/operations/incident_management | |
parent | 4b1de649d0168371549608993deac953eb692019 (diff) |
Add latest changes from gitlab-org/gitlab@13-7-stable-eev13.7.0-rc42
Diffstat (limited to 'doc/operations/incident_management')
-rw-r--r-- | doc/operations/incident_management/alert_details.md | 3 | ||||
-rw-r--r-- | doc/operations/incident_management/alert_integrations.md | 22 | ||||
-rw-r--r-- | doc/operations/incident_management/alert_notifications.md | 2 | ||||
-rw-r--r-- | doc/operations/incident_management/alerts.md | 18 | ||||
-rw-r--r-- | doc/operations/incident_management/generic_alerts.md | 3 | ||||
-rw-r--r-- | doc/operations/incident_management/img/incident_management_settings_v13_3.png | bin | 21262 -> 0 bytes | |||
-rw-r--r-- | doc/operations/incident_management/incidents.md | 9 | ||||
-rw-r--r-- | doc/operations/incident_management/index.md | 2 | ||||
-rw-r--r-- | doc/operations/incident_management/integrations.md | 2 | ||||
-rw-r--r-- | doc/operations/incident_management/status_page.md | 16 |
10 files changed, 40 insertions, 37 deletions
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**: - - ![Incident Management Settings](img/incident_management_settings_v13_3.png) - +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. |