diff options
Diffstat (limited to 'doc/operations')
-rw-r--r-- | doc/operations/feature_flags.md | 8 | ||||
-rw-r--r-- | doc/operations/incident_management/alert_integrations.md | 13 | ||||
-rw-r--r-- | doc/operations/incident_management/img/incident_metrics_tab_v13_8.png | bin | 0 -> 19907 bytes | |||
-rw-r--r-- | doc/operations/incident_management/img/metric_image_url_dialog_v13_8.png | bin | 0 -> 15876 bytes | |||
-rw-r--r-- | doc/operations/incident_management/incidents.md | 18 |
5 files changed, 28 insertions, 11 deletions
diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index e22a45fc18c..9ce7eb0ede2 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -226,9 +226,9 @@ To remove users from a user list: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/8240) in GitLab 12.2. > - [Made read-only](https://gitlab.com/gitlab-org/gitlab/-/issues/220228) in GitLab 13.4. -In GitLab 13.0 and earlier, the **Rollout strategy** setting affects which users will experience -the feature as enabled. Choose the percentage of users that the feature will be enabled -for. The rollout strategy will have no effect if the environment spec is disabled. +In GitLab 13.0 and earlier, the **Rollout strategy** setting affects which users experience +the feature as enabled. Choose the percentage of users that the feature is enabled +for. The rollout strategy has no effect if the environment spec is disabled. It can be set to: @@ -282,7 +282,7 @@ To get the access credentials that your application needs to communicate with Gi could be `production` or similar. This value is used for the environment spec evaluation. Note that the meaning of these fields might change over time. For example, we're not sure if -**Instance ID** will be single token or multiple tokens, assigned to the **Environment**. Also, +**Instance ID** is a single token or multiple tokens, assigned to the **Environment**. Also, **Application name** could describe the application version instead of the running environment. ### Choose a client library diff --git a/doc/operations/incident_management/alert_integrations.md b/doc/operations/incident_management/alert_integrations.md index 70c4e7f2f29..0f695e7a6c9 100644 --- a/doc/operations/incident_management/alert_integrations.md +++ b/doc/operations/incident_management/alert_integrations.md @@ -79,11 +79,11 @@ to configure alerts for this integration. ## Customize the alert payload outside of GitLab For all integration types, you can customize the payload by sending the following -parameters. All fields other than `title` are optional: +parameters. All fields are optional. If the incoming alert does not contain a value for the `Title` field, a default value of `New: Incident` will be applied. | Property | Type | Description | | ------------------------- | --------------- | ----------- | -| `title` | String | The title of the incident. Required. | +| `title` | String | The title of the incident. | | `description` | String | A high-level summary of the problem. | | `start_time` | DateTime | The time of the incident. If none is provided, a timestamp of the issue is used. | | `end_time` | DateTime | For existing alerts only. When provided, the alert is resolved and the associated incident is closed. | @@ -170,13 +170,14 @@ If the existing alert is already `resolved`, GitLab creates a new alert instead. ## Link to your Opsgenie Alerts +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3066) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.2. + WARNING: We are building deeper integration with Opsgenie and other alerting tools through -[HTTP endpoint integrations](#single-http-endpoint) so you can see alerts within +[HTTP endpoint integrations](#single-http-endpoint) so you can see alerts in the GitLab interface. As a result, the previous direct link to Opsgenie Alerts from -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. +the GitLab alerts list is deprecated in +GitLab versions [13.8 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/273657). You can monitor alerts using a GitLab integration with [Opsgenie](https://www.atlassian.com/software/opsgenie). diff --git a/doc/operations/incident_management/img/incident_metrics_tab_v13_8.png b/doc/operations/incident_management/img/incident_metrics_tab_v13_8.png Binary files differnew file mode 100644 index 00000000000..27345b09419 --- /dev/null +++ b/doc/operations/incident_management/img/incident_metrics_tab_v13_8.png diff --git a/doc/operations/incident_management/img/metric_image_url_dialog_v13_8.png b/doc/operations/incident_management/img/metric_image_url_dialog_v13_8.png Binary files differnew file mode 100644 index 00000000000..732921bbb9f --- /dev/null +++ b/doc/operations/incident_management/img/metric_image_url_dialog_v13_8.png diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index 074cacd2e30..3f6522b3f90 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -10,6 +10,9 @@ Incidents are critical entities in incident management workflows. They represent a service disruption or outage that needs to be restored urgently. GitLab provides tools for the triage, response, and remediation of incidents. +Users with at least Guest [permissions](../../user/permissions.md) can access +incidents [on public projects](../../user/permissions.md#project-members-permissions). + ## Incident Creation You can create an incident manually or automatically. @@ -126,7 +129,7 @@ For a live example of the incident list in action, visit this > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230847) in GitLab 13.4. -Users with at least Reporter [permissions](../../user/permissions.md) can view +Users with at least Guest [permissions](../../user/permissions.md) can view the Incident Details page. Navigate to **Operations > Incidents** in your project's sidebar, and select an incident from the list. @@ -160,6 +163,19 @@ Beneath the highlight bar, GitLab displays a summary that includes the following Comments are displayed in threads, but can be displayed chronologically [in a timeline view](#timeline-view). +### Metrics + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235994) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.8. + +In many cases, incidents are associated to metrics. You can upload screenshots of metric +charts in the **Metrics** tab: + +![Incident Metrics tab](img/incident_metrics_tab_v13_8.png) + +When you upload an image, you can associate it with a URL to the original graph. Users can access the original graph by clicking the image: + +![Metric image URL dialog](img/metric_image_url_dialog_v13_8.png) + ### Alert details Incidents show the details of linked alerts in a separate tab. To populate this |