diff options
Diffstat (limited to 'doc/operations')
20 files changed, 53 insertions, 39 deletions
diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index 0ad2b5ecf3b..5eb0624be31 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -86,26 +86,22 @@ The **Alert details** tab has two sections. The top section provides a short lis ### Metrics tab -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/217768) in GitLab 13.2. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/340852) in GitLab 14.10. In GitLab 14.9 and earlier, this tab shows a metrics chart for alerts coming from Prometheus. -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. -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) for information about setting up alerts for your self-managed Prometheus -instance. +In many cases, alerts are associated to metrics. You can upload screenshots of metric +charts in the **Metrics** tab. -Prerequisite: +To do so, either: -- You must have at least the Developer role. +- Select **upload** and then select an image from your file browser. +- Drag a file from your file browser and drop it in the drop zone. -To view the metrics for an alert: +When you upload an image, you can add text to the image and link it to the original graph. -1. On the top bar, select **Menu > Projects** and find your project. -1. On the left sidebar, select **Monitor > Alerts**. -1. Select the alert you want to view. -1. Below the title of the alert, select the **Metrics** tab. + - +If you add a link, it is shown above the uploaded image. #### View an alert's logs diff --git a/doc/operations/incident_management/img/alert_detail_metrics_v13_2.png b/doc/operations/incident_management/img/alert_detail_metrics_v13_2.png Binary files differdeleted file mode 100644 index 84d83365ea8..00000000000 --- a/doc/operations/incident_management/img/alert_detail_metrics_v13_2.png +++ /dev/null diff --git a/doc/operations/incident_management/img/incident_list_v13_5.png b/doc/operations/incident_management/img/incident_list_v13_5.png Binary files differdeleted file mode 100644 index 88942a70e88..00000000000 --- a/doc/operations/incident_management/img/incident_list_v13_5.png +++ /dev/null diff --git a/doc/operations/incident_management/img/incident_metrics_tab_text_link_modal_v14_9.png b/doc/operations/incident_management/img/incident_metrics_tab_text_link_modal_v14_9.png Binary files differindex 1b045a13fc5..bae1e5ad1b4 100644 --- a/doc/operations/incident_management/img/incident_metrics_tab_text_link_modal_v14_9.png +++ b/doc/operations/incident_management/img/incident_metrics_tab_text_link_modal_v14_9.png diff --git a/doc/operations/incident_management/img/timeline_view_toggle_v13_5.png b/doc/operations/incident_management/img/timeline_view_toggle_v13_5.png Binary files differdeleted file mode 100644 index 542ca139f7e..00000000000 --- a/doc/operations/incident_management/img/timeline_view_toggle_v13_5.png +++ /dev/null diff --git a/doc/operations/incident_management/img/timeline_view_toggle_v14_10.png b/doc/operations/incident_management/img/timeline_view_toggle_v14_10.png Binary files differnew file mode 100644 index 00000000000..90f1d205fed --- /dev/null +++ b/doc/operations/incident_management/img/timeline_view_toggle_v14_10.png diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index c7ed386f505..66d04fce14c 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -169,7 +169,7 @@ Beneath the highlight bar, GitLab displays a summary that includes the following - Monitoring tool Comments are displayed in threads, but can be displayed chronologically -[in a timeline view](#timeline-view). +[by toggling on the recent updates view](#recent-updates-view). ### Metrics **(PREMIUM)** @@ -195,15 +195,15 @@ field populated.  -### Timeline view **(PREMIUM)** +### Recent updates view **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in GitLab 13.5. To quickly see the latest updates on an incident, click -**{comments}** **Turn timeline view on** in the comment bar to display comments +**{history}** **Turn recent updates view on** in the comment bar to display comments un-threaded and ordered chronologically, newest to oldest: - + ### Service Level Agreement countdown timer **(PREMIUM)** @@ -255,7 +255,13 @@ Add a to-do for incidents that you want to track in your to-do list. Click the ### Change incident status -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5716) in GitLab 14.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5716) in GitLab 14.9 [with a flag](../../administration/feature_flags.md) named `incident_escalations`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/345769) in GitLab 14.10. + +FLAG: +This feature is available by default. To disable it per project or for your entire +instance, ask an administrator to [disable the feature flag](../../administration/feature_flags.md) +named `incident_escalations`. For users with the Developer role or higher, select **Edit** in the **Status** section of the right-hand side bar of an incident, then select a status. **Triggered** is the default status for @@ -271,9 +277,15 @@ by changing the status. Setting the status to: For [incidents created from alerts](alerts.md#create-an-incident-from-an-alert), updating the incident status also updates the alert status. -## Change escalation policy **(PREMIUM)** +### Change escalation policy **(PREMIUM)** + +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5716) in GitLab 14.9 [with a flag](../../administration/feature_flags.md) named `incident_escalations`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/345769) in GitLab 14.10. -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5716) in GitLab 14.9. +FLAG: +This feature is available by default. To disable it per project or for your entire +instance, ask an administrator to [disable the feature flag](../../administration/feature_flags.md) +named `incident_escalations`. For users with the Developer role or higher, select **Edit** in the **Escalation policy** section of the right-hand side bar of an incident, then select a policy. By default, new incidents do not have diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 27854a9e201..d0c14ab6e59 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -50,7 +50,13 @@ or stop alert escalations by [updating the alert's status](alerts.md#update-an-a ### Escalating an incident -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5716) in GitLab 14.9. +> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/5716) in GitLab 14.9 [with a flag](../../administration/feature_flags.md) named `incident_escalations`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/345769) in GitLab 14.10. + +FLAG: +This feature is available by default. To disable it per project or for your entire +instance, ask an administrator to [disable the feature flag](../../administration/feature_flags.md) +named `incident_escalations`. For incidents, paging on-call responders is optional for each individual incident. To begin escalating the incident, [set the incident's escalation policy](incidents.md#change-escalation-policy). diff --git a/doc/operations/index.md b/doc/operations/index.md index 9b988ff561d..61d38c3d6a9 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -15,7 +15,7 @@ your applications. WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 15.0. Metrics help you understand the health and performance of your infrastructure, applications, and systems by providing insights into your application's reliability, @@ -63,7 +63,7 @@ and the work required to fix them - all without leaving GitLab. WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 15.0. Application tracing in GitLab is a way to measure an application's performance and health while it's running. After configuring your application to enable tracing, you @@ -83,7 +83,7 @@ microservices-based distributed systems - and displays results within GitLab. WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 15.0. Developers need to troubleshoot application changes in development, and incident responders need aggregated, real-time logs when troubleshooting problems with diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 702ff944fc5..0e446f04b9b 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -79,7 +79,7 @@ values extracted from the [`alerts` field in webhook payload](https://prometheus - `starts_at`: Alert start time from the payload's `startsAt` field - `full_query`: Alert query extracted from the payload's `generatorURL` field - Optional list of attached annotations extracted from `annotations/*` -- Alert [GFM](../../user/markdown.md): GitLab Flavored Markdown from the payload's `annotations/gitlab_incident_markdown` field. +- Alert [GLFM](../../user/markdown.md): GitLab Flavored Markdown from the payload's `annotations/gitlab_incident_markdown` field. - Alert Severity ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50871) in GitLab version 13.9): Extracted from the alert payload field `labels/severity`. Maps case-insensitive value to [Alert's severity](../incident_management/alerts.md#alert-severity): diff --git a/doc/operations/metrics/dashboards/default.md b/doc/operations/metrics/dashboards/default.md index 3e14917209a..5c7d6440a7e 100644 --- a/doc/operations/metrics/dashboards/default.md +++ b/doc/operations/metrics/dashboards/default.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. GitLab provides some dashboards out-of-the-box for any project with [Prometheus available](../../../user/project/integrations/prometheus.md). You can diff --git a/doc/operations/metrics/dashboards/develop.md b/doc/operations/metrics/dashboards/develop.md index fc7686c8f86..513e5532bee 100644 --- a/doc/operations/metrics/dashboards/develop.md +++ b/doc/operations/metrics/dashboards/develop.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. GitLab provides a template to make it easier for you to create templates for [custom dashboards](index.md). Templates provide helpful guidance and diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index a8ca23b7002..052f678f1b7 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. By default, all projects include a [GitLab-defined Prometheus dashboard](default.md), which includes a few key metrics, but you can also define your own custom dashboards. diff --git a/doc/operations/metrics/dashboards/panel_types.md b/doc/operations/metrics/dashboards/panel_types.md index 734b560bf13..a4cdfc5b9a0 100644 --- a/doc/operations/metrics/dashboards/panel_types.md +++ b/doc/operations/metrics/dashboards/panel_types.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. The below panel types are supported in monitoring dashboards. diff --git a/doc/operations/metrics/dashboards/settings.md b/doc/operations/metrics/dashboards/settings.md index 14da5cf4a04..aae5a623420 100644 --- a/doc/operations/metrics/dashboards/settings.md +++ b/doc/operations/metrics/dashboards/settings.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. You can configure your [Monitoring dashboard](../index.md) to display the time zone of your choice, and the links of your choice. diff --git a/doc/operations/metrics/dashboards/templating_variables.md b/doc/operations/metrics/dashboards/templating_variables.md index d751a96f379..7d1754f79f5 100644 --- a/doc/operations/metrics/dashboards/templating_variables.md +++ b/doc/operations/metrics/dashboards/templating_variables.md @@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. Templating variables can be used to make your metrics dashboard more versatile. diff --git a/doc/operations/metrics/dashboards/variables.md b/doc/operations/metrics/dashboards/variables.md index 369bcd1ddeb..b796cf4cef5 100644 --- a/doc/operations/metrics/dashboards/variables.md +++ b/doc/operations/metrics/dashboards/variables.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. ## Query variables diff --git a/doc/operations/metrics/dashboards/yaml.md b/doc/operations/metrics/dashboards/yaml.md index 81f1354d3c0..62389fa01ee 100644 --- a/doc/operations/metrics/dashboards/yaml.md +++ b/doc/operations/metrics/dashboards/yaml.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346541) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 16.0. Dashboards have several components: diff --git a/doc/operations/metrics/embed.md b/doc/operations/metrics/embed.md index 6a3712d8377..26ea7aa07eb 100644 --- a/doc/operations/metrics/embed.md +++ b/doc/operations/metrics/embed.md @@ -7,7 +7,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Embedding metric charts within GitLab Flavored Markdown **(FREE)** You can display metrics charts within -[GitLab Flavored Markdown](../../user/markdown.md#gitlab-flavored-markdown) +[GitLab Flavored Markdown (GLFM)](../../user/markdown.md) fields such as issue or merge request descriptions. The maximum number of embedded charts allowed in a GitLab Flavored Markdown field is 100. Embedding charts is useful when sharing an application incident or performance @@ -26,7 +26,7 @@ are still supported, and can be used to embed metric charts. To display metric charts, include a link of the form `https://<root_url>/<project>/-/metrics?environment=<environment_id>` in a field -that supports GitLab-flavored Markdown: +that supports GitLab Flavored Markdown: ```markdown ### Summary @@ -100,11 +100,11 @@ a chart corresponding to the query can be included if these requirements are met > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/208224) from GitLab Ultimate to GitLab Free in 13.2. [Cluster Health Metrics](../../user/infrastructure/clusters/manage/clusters_health.md) -can also be embedded in [GitLab-flavored Markdown](../../user/markdown.md). +can also be embedded in [GitLab Flavored Markdown](../../user/markdown.md). To embed a metric chart, include a link to that chart in the form `https://<root_url>/<project>/-/cluster/<cluster_id>?<query_params>` anywhere that -GitLab-flavored Markdown is supported. To generate and copy a link to the chart, +GitLab Flavored Markdown is supported. To generate and copy a link to the chart, follow the instructions in the [Cluster Health Metric documentation](../../user/infrastructure/clusters/manage/clusters_health.md). diff --git a/doc/operations/tracing.md b/doc/operations/tracing.md index 044f6800e73..bbc05bb0f9a 100644 --- a/doc/operations/tracing.md +++ b/doc/operations/tracing.md @@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w WARNING: This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346540) -for use in GitLab 14.7, and is planned for removal in GitLab 15.0. +in GitLab 14.7, and is planned for removal in GitLab 15.0. Tracing provides insight into the performance and health of a deployed application, tracking each function or microservice that handles a given request. Tracing makes it easy to understand the |
