diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-20 15:40:28 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-20 15:40:28 +0000 |
commit | b595cb0c1dec83de5bdee18284abe86614bed33b (patch) | |
tree | 8c3d4540f193c5ff98019352f554e921b3a41a72 /doc/operations | |
parent | 2f9104a328fc8a4bddeaa4627b595166d24671d0 (diff) | |
download | gitlab-ce-b595cb0c1dec83de5bdee18284abe86614bed33b.tar.gz |
Add latest changes from gitlab-org/gitlab@15-2-stable-eev15.2.0-rc42
Diffstat (limited to 'doc/operations')
-rw-r--r-- | doc/operations/feature_flags.md | 1 | ||||
-rw-r--r-- | doc/operations/incident_management/alerts.md | 5 | ||||
-rw-r--r-- | doc/operations/incident_management/img/timeline_events_v15_1.png | bin | 0 -> 36994 bytes | |||
-rw-r--r-- | doc/operations/incident_management/incidents.md | 87 | ||||
-rw-r--r-- | doc/operations/incident_management/paging.md | 5 | ||||
-rw-r--r-- | doc/operations/index.md | 27 | ||||
-rw-r--r-- | doc/operations/metrics/dashboards/index.md | 3 | ||||
-rw-r--r-- | doc/operations/metrics/embed_grafana.md | 5 | ||||
-rw-r--r-- | doc/operations/metrics/img/prometheus_integration_alerts.png | bin | 16084 -> 0 bytes | |||
-rw-r--r-- | doc/operations/metrics/index.md | 2 | ||||
-rw-r--r-- | doc/operations/product_analytics.md | 2 |
11 files changed, 98 insertions, 39 deletions
diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index 71248adc777..9e7d452c259 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -297,7 +297,6 @@ For API content, see: - [Feature Flags API](../api/feature_flags.md) - [Feature Flag Specs API](../api/feature_flag_specs.md) (Deprecated and [scheduled for removal](https://gitlab.com/gitlab-org/gitlab/-/issues/213369) in GitLab 14.0.) - [Feature Flag User Lists API](../api/feature_flag_user_lists.md) -- [Legacy Feature Flags API](../api/feature_flags_legacy.md) ### Golang application example diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index af42571f82f..a4b34807094 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -168,8 +168,9 @@ by changing the status. Setting the status to: - **Acknowledged** limits on-call pages based on the project's [escalation policy](escalation_policies.md). - **Triggered** from **Resolved** restarts the alert escalating from the beginning. -For [alerts with an associated incident](alerts.md#create-an-incident-from-an-alert), -updating the alert status also updates the incident status. +In GitLab 15.1 and earlier, updating the status of an [alert with an associated incident](alerts.md#create-an-incident-from-an-alert) +also updates the incident status. In [GitLab 15.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/356057), +the incident status is independent and does not update when the alert status changes. ### Create an incident from an alert diff --git a/doc/operations/incident_management/img/timeline_events_v15_1.png b/doc/operations/incident_management/img/timeline_events_v15_1.png Binary files differnew file mode 100644 index 00000000000..3241f35764c --- /dev/null +++ b/doc/operations/incident_management/img/timeline_events_v15_1.png diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index e48127b3415..f1628cb64ca 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -53,7 +53,8 @@ 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). + [issue template](../../user/project/description_templates.md#create-an-issue-template), + to include in the [incident summary](#summary). 1. To send [an email notification](paging.md#email-notifications-for-alerts) to users with the Developer role, select **Send a separate email notification to Developers**. Email notifications are @@ -153,9 +154,9 @@ Select any incident in the list to display its incident details page. ### Summary -The summary section for incidents provides both critical details about and the -contents of the issue template (if one was used). The highlighted bar at the top -of the incident displays from left to right: +The summary section for incidents provides both critical details about the +incident and the contents of the issue template (if applicable). The highlighted +bar at the top of the incident displays from left to right: - The link to the original alert. - The alert start time. @@ -168,6 +169,13 @@ Beneath the highlight bar, GitLab displays a summary that includes the following - `full_query` - Monitoring tool +The incident summary can be further customized using +[GitLab Flavored Markdown](../../user/markdown.md). If the corresponding alert +[provided Markdown for the incident](../metrics/alerts.md#trigger-actions-from-alerts), +then the Markdown is appended to the summary after the above alert fields. If an +[incident template](#create-incidents-automatically) is configured for the +project, then the template content is appended at the end. + Comments are displayed in threads, but can be displayed chronologically [by toggling on the recent updates view](#recent-updates-view). @@ -195,6 +203,67 @@ field populated.  +### Timeline events + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344059) in GitLab 15.2 [with a flag](../../administration/feature_flags.md) named `incident_timeline`. Enabled on GitLab.com. Disabled on self-managed. + +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `incident_timeline`. +On GitLab.com, this feature is available. + +Incident timelines are an important part of record keeping for incidents. +They give a high-level overview, to executives and external viewers, of what happened during the incident, +and the steps that were taken for it to be resolved. + +#### View the event timeline + +Incident timeline events are listed in ascending order of the date and time. +They are grouped with dates and are listed in ascending order of the time when they occured: + + + +To view the event timeline of an incident: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Incidents**. +1. Select an incident. +1. Select the **Timeline** tab. + +#### Create a timeline event + +Create a timeline event manually using the form. + +Prerequisites: + +- You must have at least the Developer role for the project. + +To create a timeline event: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Incidents**. +1. Select an incident. +1. Select the **Timeline** tab. +1. Select **Add new timeline event**. +1. Complete the required fields. +1. Select **Save** or **Save and add another event**. + +#### Delete a timeline event + +You can also delete timeline events. + +Prerequisites: + +- You must have at least the Developer role for the project. + +To delete a timeline event: + +1. On the top bar, select **Menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Incidents**. +1. Select an incident. +1. Select the **Timeline** tab. +1. On the right of a timeline event, select **More actions** (**{ellipsis_v}**) and then select **Delete**. +1. To confirm, select **Delete Event**. + ### Recent updates view **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227836) in GitLab 13.5. @@ -270,8 +339,9 @@ by changing the status. Setting the status to: - **Acknowledged** limits on-call pages based on the selected [escalation policy](#change-escalation-policy). - **Triggered** from **Resolved** restarts the incident escalating from the beginning. -For [incidents created from alerts](alerts.md#create-an-incident-from-an-alert), -updating the incident status also updates the alert status. +In GitLab 15.1 and earlier, updating the status of an [incident created from an alert](alerts.md#create-an-incident-from-an-alert) +also updates the alert status. In [GitLab 15.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/356057), +the alert status is independent and does not update when the incident status changes. ### Change escalation policy **(PREMIUM)** @@ -288,8 +358,9 @@ Selecting an escalation policy updates the incident status to **Triggered** and Deselecting an escalation policy halts escalation. Refer to the [incident status](#change-incident-status) to manage on-call paging once escalation has begun. -For [incidents created from alerts](alerts.md#create-an-incident-from-an-alert), -the incident's escalation policy reflects the alert's escalation policy and cannot be changed. +In GitLab 15.1 and earlier, the escalation policy for [incidents created from alerts](alerts.md#create-an-incident-from-an-alert) +reflects the alert's escalation policy and cannot be changed. In [GitLab 15.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/356057), +the incident escalation policy is independent and can be changed. ### Manage incidents from Slack diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 936c297e555..3eeeb67bf51 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -61,5 +61,6 @@ the rule fires. You can respond to a page or stop incident escalations by [updating the incident's status](incidents.md#change-incident-status) or, if applicable, [unsetting the incident's escalation policy](incidents.md#change-escalation-policy). -To avoid duplicate pages, [incidents created from alerts](alerts.md#create-an-incident-from-an-alert) do not support independent escalation. -Instead, the status and escalation policy fields are synced between the alert and the incident. +In GitLab 15.1 and earlier, [incidents created from alerts](alerts.md#create-an-incident-from-an-alert) +do not support independent escalation. In [GitLab 15.2 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/356057), +all incidents can be escalated independently. diff --git a/doc/operations/index.md b/doc/operations/index.md index 88687c2faf1..05ce1c5d876 100644 --- a/doc/operations/index.md +++ b/doc/operations/index.md @@ -77,29 +77,14 @@ microservices-based distributed systems - and displays results within GitLab. - [Trace the performance and health](tracing.md) of a deployed application. -## Aggregate and store logs (DEPRECATED) **(FREE SELF)** +<!--- start_remove The following content will be removed on remove_date: '2022-10-18'---> -> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) in GitLab 14.7. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/360182) behind a [feature flag](../administration/feature_flags.md) named `monitor_logging` in GitLab 15.0. Disabled by default. +## Aggregate and store logs (removed) **(FREE SELF)** -WARNING: -This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) -in GitLab 14.7. -It will be removed completely in GitLab 15.2. - -FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `monitor_logging`. -On GitLab.com, this feature is not available. -This feature is not recommended for production use. - -Developers need to troubleshoot application changes in development, and incident -responders need aggregated, real-time logs when troubleshooting problems with -production services. GitLab provides centralized, aggregated log storage for your -distributed application, enabling you to collect logs across multiple services and -infrastructure. - -- [View logs of pods](../user/project/clusters/kubernetes_pod_logs.md) - in connected Kubernetes clusters. +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/346485) in GitLab 14.7 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/360193) in GitLab 15.2. + +<!--- end_remove --> ## Manage your infrastructure in code diff --git a/doc/operations/metrics/dashboards/index.md b/doc/operations/metrics/dashboards/index.md index 152e3dca27d..bd1f75b7b42 100644 --- a/doc/operations/metrics/dashboards/index.md +++ b/doc/operations/metrics/dashboards/index.md @@ -135,9 +135,6 @@ The options are: - **Expand panel** - Displays a larger version of a visualization. To return to the dashboard, select the **Back** button in your browser, or press the <kbd>Escape</kbd> key. ([Introduced](https://gitlab.com/groups/gitlab-org/-/epics/3100) in GitLab 13.0.) -- **View logs** **(ULTIMATE)** - Displays [Logs](../../../user/project/clusters/kubernetes_pod_logs.md), - if they are enabled. If used in conjunction with the [timeline zoom](#timeline-zoom-and-url-sharing) - feature, logs narrow down to the selected time range. ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/122013) in GitLab 12.8.) - **Download CSV** - Data from Prometheus charts on the metrics dashboard can be downloaded as CSV. - [Copy link to chart](../embed.md#embedding-gitlab-managed-kubernetes-metrics) diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 700bf821a49..2229ba22be7 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -54,6 +54,11 @@ To set up the Grafana API in Grafana: 1. For **API Token**, enter the Administrator API token you just generated. 1. Select **Save Changes**. +NOTE: +If the Grafana integration is enabled, any user with read access to the GitLab +project can query metrics from the Prometheus instance. All requests proxied +through GitLab are authenticated with the same Grafana Administrator API token. + ### Generate a link to a panel To generate a link to a panel: diff --git a/doc/operations/metrics/img/prometheus_integration_alerts.png b/doc/operations/metrics/img/prometheus_integration_alerts.png Binary files differdeleted file mode 100644 index 609c5e5196c..00000000000 --- a/doc/operations/metrics/img/prometheus_integration_alerts.png +++ /dev/null diff --git a/doc/operations/metrics/index.md b/doc/operations/metrics/index.md index 916fe6b0ea9..82f093cf432 100644 --- a/doc/operations/metrics/index.md +++ b/doc/operations/metrics/index.md @@ -117,7 +117,7 @@ dashboard is visible to authenticated and non-authenticated users. ## Adding custom metrics -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28527) from GitLab Premium to GitLab Free in 12.10. +> [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28527) from GitLab Premium to GitLab Free in 12.10. Custom metrics can be monitored by adding them on the monitoring dashboard page. After saving them, they display on the environment metrics dashboard provided that either: diff --git a/doc/operations/product_analytics.md b/doc/operations/product_analytics.md index a55cbe906a0..98ba6a9203c 100644 --- a/doc/operations/product_analytics.md +++ b/doc/operations/product_analytics.md @@ -1,5 +1,5 @@ --- -stage: Growth +stage: Analytics group: Product Intelligence 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 --- |