diff options
Diffstat (limited to 'doc/operations')
-rw-r--r-- | doc/operations/error_tracking.md | 7 | ||||
-rw-r--r-- | doc/operations/feature_flags.md | 16 | ||||
-rw-r--r-- | doc/operations/incident_management/alerts.md | 6 | ||||
-rw-r--r-- | doc/operations/incident_management/escalation_policies.md | 6 | ||||
-rw-r--r-- | doc/operations/incident_management/incident_timeline_events.md | 94 | ||||
-rw-r--r-- | doc/operations/incident_management/incidents.md | 88 | ||||
-rw-r--r-- | doc/operations/incident_management/linked_resources.md | 24 | ||||
-rw-r--r-- | doc/operations/incident_management/oncall_schedules.md | 12 | ||||
-rw-r--r-- | doc/operations/incident_management/paging.md | 2 | ||||
-rw-r--r-- | doc/operations/incident_management/status_page.md | 4 | ||||
-rw-r--r-- | doc/operations/metrics/alerts.md | 10 | ||||
-rw-r--r-- | doc/operations/metrics/embed_grafana.md | 2 | ||||
-rw-r--r-- | doc/operations/product_analytics.md | 80 |
13 files changed, 177 insertions, 174 deletions
diff --git a/doc/operations/error_tracking.md b/doc/operations/error_tracking.md index 08acf77b6c7..22e21c01fbd 100644 --- a/doc/operations/error_tracking.md +++ b/doc/operations/error_tracking.md @@ -46,7 +46,7 @@ least Maintainer [permissions](../user/permissions.md) to enable the Sentry inte Make sure to give the token at least the following scopes: `project:read`, `event:read`, and `event:write` (for resolving events). 1. In GitLab, enable error tracking: - 1. On the top bar, select **Menu > Projects** and find your project. + 1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Error Tracking**. 1. Select **Enable error tracking**. 1. In GitLab, ensure error tracking is active. @@ -136,10 +136,7 @@ FLAG: By default this feature is not available. To make it available on self-managed GitLab, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `integrated_error_tracking`. The feature is not ready for production use. -On GitLab.com, this feature is not available. - -WARNING: -Turning on integrated error tracking may impact performance, depending on your error rates. +On GitLab.com, please follow [our user guide](https://gitlab.com/gitlab-org/opstrace/opstrace/-/blob/main/docs/guides/user/error_tracking.md) to get started. Integrated error tracking is a lightweight alternative to Sentry backend. You still use Sentry SDK with your application. But you don't need to deploy Sentry diff --git a/doc/operations/feature_flags.md b/doc/operations/feature_flags.md index 9e7d452c259..0dccaa6bfe9 100644 --- a/doc/operations/feature_flags.md +++ b/doc/operations/feature_flags.md @@ -37,7 +37,7 @@ with GitLab, so it's up to developers to use a compatible client library and To create and enable a feature flag: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. Select **New feature flag**. 1. Enter a name that starts with a letter and contains only lowercase letters, digits, underscores (`_`), @@ -180,7 +180,7 @@ For example: To create a user list: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. Select **View user lists** 1. Select **New user list**. @@ -196,7 +196,7 @@ When viewing a list, you can rename it by selecting **Edit** (**{pencil}**). To add users to a user list: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. Select **Edit** (**{pencil}**) next to the list you want to add users to. 1. Select **Add Users**. @@ -210,7 +210,7 @@ To add users to a user list: To remove users from a user list: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. Select **Edit** (**{pencil}**) next to the list you want to change. 1. Select **Remove** (**{remove}**) next to the ID you want to remove. @@ -224,7 +224,7 @@ 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: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. Edit the feature flag you want to remove. 1. Select **More actions** (**{ellipsis_v}**). @@ -235,7 +235,7 @@ To search for code references of a feature flag: In [GitLab 13.0 and earlier](https://gitlab.com/gitlab-org/gitlab/-/issues/8621), to disable a feature flag for a specific environment: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. For the feature flag you want to disable, select **Edit** (**{pencil}**). 1. To disable the flag: @@ -250,7 +250,7 @@ to disable a feature flag for a specific environment: To disable a feature flag for all environments: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. For the feature flag you want to disable, slide the Status toggle to **Disabled**. @@ -265,7 +265,7 @@ Then prepare your application with a client library. To get the access credentials that your application needs to communicate with GitLab: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Deployments > Feature Flags**. 1. Select **Configure** to view the following: - **API URL**: URL where the client (application) connects to get a list of feature flags. diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index a4b34807094..7e4223c0820 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -120,7 +120,7 @@ Prerequisite: To view the logs for an alert: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main 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. @@ -198,7 +198,7 @@ To assign an alert: 1. Display the list of current alerts: - 1. On the top bar, select **Menu > Projects** and find your project. + 1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Alerts**. 1. Select your desired alert to display its details. @@ -226,7 +226,7 @@ add a to-do item: 1. Display the list of current alerts: - 1. On the top bar, select **Menu > Projects** and find your project. + 1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Alerts**. 1. Select your desired alert to display its **Alert Management Details View**. diff --git a/doc/operations/incident_management/escalation_policies.md b/doc/operations/incident_management/escalation_policies.md index c24824e55f8..56ff733e395 100644 --- a/doc/operations/incident_management/escalation_policies.md +++ b/doc/operations/incident_management/escalation_policies.md @@ -22,7 +22,7 @@ Prerequisite: To create an escalation policy: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Escalation Policies**. 1. Select **Add an escalation policy**. 1. Enter the policy's name and description, and @@ -46,7 +46,7 @@ the paged users is created on the alert. To update an escalation policy: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Escalation Policies**. 1. Select **Edit escalation policy** (**{pencil}**). 1. Edit the information. @@ -56,7 +56,7 @@ To update an escalation policy: To delete an escalation policy: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Escalation Policies**. 1. Select **Delete escalation policy** (**{remove}**). 1. On the confirmation dialog, select **Delete escalation policy**. diff --git a/doc/operations/incident_management/incident_timeline_events.md b/doc/operations/incident_management/incident_timeline_events.md new file mode 100644 index 00000000000..743f9b429d6 --- /dev/null +++ b/doc/operations/incident_management/incident_timeline_events.md @@ -0,0 +1,94 @@ +--- +stage: 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 +--- + +# 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 by default. + +FLAG: +On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable 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. +Timelines can show executives and external viewers what happened during an incident, +and which steps were taken for it to be resolved. + +## View the 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 occurred: + +![Incident timeline events list](img/timeline_events_v15_1.png) + +To view the event timeline of an incident: + +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Incidents**. +1. Select an incident. +1. Select the **Timeline** tab. + +## Create an event + +You can create a timeline event in many ways in GitLab. + +### Using the form + +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 **Main 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**. + +### Using a quick action + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368721) in GitLab 15.4. + +You can create a timeline event using the `/timeline` [quick action](../../user/project/quick_actions.md). + +### From a comment on the incident + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/344058) in GitLab 15.4. + +Prerequisites: + +- You must have at least the Developer role for the project. + +To create a timeline event from a comment on the incident: + +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Incidents**. +1. Select an incident. +1. Create a comment or choose an existing comment. +1. On the comment you want to add, select **Add comment to incident timeline** (**{clock}**). + +The comment is shown on the incident timeline as a timeline event. + +## Delete an 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 **Main 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**. diff --git a/doc/operations/incident_management/incidents.md b/doc/operations/incident_management/incidents.md index c1a4c1eb93e..2cb2e5f8045 100644 --- a/doc/operations/incident_management/incidents.md +++ b/doc/operations/incident_management/incidents.md @@ -205,64 +205,10 @@ 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 by default. +Incident timelines give a high-level overview of what happened +during an incident, and the steps that were taken for it to be resolved. -FLAG: -On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable 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: - -![Incident timeline events list](img/timeline_events_v15_1.png) - -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**. +Read more about [timeline events](incident_timeline_events.md) and how to enable this feature. ### Recent updates view **(PREMIUM)** @@ -297,32 +243,28 @@ as a column in the Incidents List, and as a field on newly created Incidents. If the incident isn't closed before the SLA period ends, GitLab adds a `missed::SLA` label to the incident. -## Incident actions - -There are different actions available to help triage and respond to incidents. - -### Assign incidents +## Assign incidents Assign incidents to users that are actively responding. Select **Edit** in the right-hand side bar to select or clear assignees. -### Associate a milestone +## Associate a milestone Associate an incident to a milestone by selecting **Edit** next to the milestone feature in the right-hand side bar. -### Change severity +## Change severity See [Incident List](#incident-list) for a full description of the severity levels available. Select **Edit** in the right-hand side bar to change the severity of an incident. You can also change the severity using the [`/severity` quick action](../../user/project/quick_actions.md). -### Add a to-do item +## Add a to-do item Add a to-do for incidents that you want to track in your to-do list. Select **Add a to do** at the top of the right-hand side bar to add a to-do item. -### Change incident status +## Change incident status > - [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. @@ -343,7 +285,7 @@ In GitLab 15.1 and earlier, updating the status of an [incident created from an 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)** +## 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. @@ -362,30 +304,30 @@ In GitLab 15.1 and earlier, the escalation policy for [incidents created from al 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 +## Manage incidents from Slack Slack slash commands allow you to control GitLab and view GitLab content without leaving Slack. Learn how to [set up Slack slash commands](../../user/project/integrations/slack_slash_commands.md) and how to [use the available slash commands](../../integration/slash_commands.md). -### Associate Zoom calls +## Associate Zoom calls GitLab enables you to [associate a Zoom meeting with an issue](../../user/project/issues/associate_zoom_meeting.md) for synchronous communication during incident management. After starting a Zoom call for an incident, you can associate the conference call with an issue. Your team members can join the Zoom call without requesting a link. -### Linked resources +## Linked resources -In an incident, you can [links to various resources](linked_resources.md), +In an incident, you can add [links to various resources](linked_resources.md), for example: - The incident Slack channel - Zoom meeting - Resources for resolving the incidents -### Embed metrics in incidents +## Embed metrics in incidents You can embed metrics anywhere [GitLab Markdown](../../user/markdown.md) is used, such as descriptions, comments on issues, and merge requests. Embedding @@ -398,7 +340,7 @@ You can embed both [GitLab-hosted metrics](../metrics/embed.md) and [Grafana metrics](../metrics/embed_grafana.md) in incidents and issue templates. -### Automatically close incidents via recovery alerts +## Automatically close incidents via recovery alerts > - [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. diff --git a/doc/operations/incident_management/linked_resources.md b/doc/operations/incident_management/linked_resources.md index d2254a30f91..3fe4a325cdb 100644 --- a/doc/operations/incident_management/linked_resources.md +++ b/doc/operations/incident_management/linked_resources.md @@ -29,7 +29,7 @@ Linked resources for an incident are listed under the **Summary** tab. To view the linked resources of an incident: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Incidents**. 1. Select an incident. @@ -43,24 +43,40 @@ Prerequisites: To add a linked resource: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Incidents**. 1. Select an incident. 1. In the **Linked resources** section, select the plus icon (**{plus-square}**). 1. Complete the required fields. 1. Select **Add**. +### Link Zoom meetings from an incident **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/230853) in GitLab 15.4. + +Use the `/zoom` [quick action](../../user/project/quick_actions.md) to add multiple Zoom links to an incident: + +```plaintext +/zoom https://example.zoom.us/j/123456789 +``` + +You can also submit a short optional description with the link. The description shows instead of the URL in the **Linked resources** section of the incident issue: + +```plaintext +/zoom https://example.zoom.us/j/123456789, Low on memory incident +``` + ## Remove a linked resource You can also remove a linked resource. -Prerequisities: +Prerequisites: - You must have at least the Reporter role for the project. To remove a linked resource: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > Incidents**. 1. Select an incident. 1. In the **Linked resources** section, select **Remove** (**{close}**). diff --git a/doc/operations/incident_management/oncall_schedules.md b/doc/operations/incident_management/oncall_schedules.md index 9b2e9159429..f1fb3503195 100644 --- a/doc/operations/incident_management/oncall_schedules.md +++ b/doc/operations/incident_management/oncall_schedules.md @@ -28,7 +28,7 @@ Prerequisite: To create an on-call schedule: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > On-call Schedules**. 1. Select **Add a schedule**. 1. Enter the schedule's name and description and select a time zone. @@ -43,7 +43,7 @@ create [rotations](#rotations) for your schedule. To update a schedule: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > On-call Schedules**. 1. Select **Edit schedule** (**{pencil}**). 1. Edit the information. @@ -56,7 +56,7 @@ interval (if one is set) to the corresponding times in the new time zone. To delete a schedule: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > On-call Schedules**. 1. Select **Delete escalation policy** (**{remove}**). 1. On the confirmation dialog, select **Delete schedule**. @@ -67,7 +67,7 @@ Add rotations to an existing schedule to put your team members on-call. To create a rotation: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > On-call Schedules**. 1. Select the **Add a rotation** link. 1. Enter the following information: @@ -85,7 +85,7 @@ To create a rotation: To edit a rotation: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > On-call Schedules**. 1. In the **Rotations** section, select **Edit rotation** (**{pencil}**). 1. Edit the information. @@ -95,7 +95,7 @@ To edit a rotation: To delete a rotation: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Monitor > On-call Schedules**. 1. In the **Rotations** section, select **Delete rotation** (**{remove}**). 1. On the confirmation dialog, select **Delete rotation**. diff --git a/doc/operations/incident_management/paging.md b/doc/operations/incident_management/paging.md index 3eeeb67bf51..837fc9c72f5 100644 --- a/doc/operations/incident_management/paging.md +++ b/doc/operations/incident_management/paging.md @@ -27,7 +27,7 @@ Email notifications are available in projects for triggered alerts. Project members with the **Owner** or **Maintainer** roles have the option to receive a single email notification for new alerts. -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Settings > Monitor**. 1. Expand **Alerts**. 1. On the **Alert settings** tab, select the diff --git a/doc/operations/incident_management/status_page.md b/doc/operations/incident_management/status_page.md index fe75c1812c8..ae4d75396ae 100644 --- a/doc/operations/incident_management/status_page.md +++ b/doc/operations/incident_management/status_page.md @@ -45,7 +45,7 @@ Prerequisite: To provide GitLab with the AWS account information needed to push content to your Status Page: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Settings > Monitor**. 1. Expand **Status Page**. 1. Select the **Active** checkbox. @@ -96,7 +96,7 @@ the issue can potentially [publish comments to your GitLab Status Page](#publish After creating the CI/CD variables, configure the Project you want to use for Incident issues: -1. On the top bar, select **Menu > Projects** and find your project. +1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Settings > Monitor**. 1. Expand **Status page**. 1. Fill in your cloud provider's credentials and make sure to select the **Active** checkbox. diff --git a/doc/operations/metrics/alerts.md b/doc/operations/metrics/alerts.md index 12bd975db5d..6017e2ee16c 100644 --- a/doc/operations/metrics/alerts.md +++ b/doc/operations/metrics/alerts.md @@ -17,16 +17,6 @@ your team when environment performance falls outside of the boundaries you set. Alerts are not currently supported for [Prometheus cluster integrations](../../user/clusters/integrations.md). -<!--- start_remove The following content will be removed on remove_date: '2022-09-22' --> - -## External Prometheus instances (removed) - -This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/219142) in GitLab 13.2 and [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/338834) in 15.0. -To manually configure a Prometheus server, we recommend -you use the [generic alerts integration](../incident_management/integrations.md). - -<!--- end_remove --> - ## Trigger actions from alerts **(ULTIMATE)** Alerts can be used to trigger actions, like opening an issue automatically diff --git a/doc/operations/metrics/embed_grafana.md b/doc/operations/metrics/embed_grafana.md index 17ff0ff01a3..1a1ac77ce23 100644 --- a/doc/operations/metrics/embed_grafana.md +++ b/doc/operations/metrics/embed_grafana.md @@ -14,7 +14,7 @@ embed Grafana panels using either: ## Use Grafana-rendered images -You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html) panels as +You can embed live [Grafana](https://docs.gitlab.com/omnibus/settings/grafana.html) panels as [a direct link](https://grafana.com/docs/grafana/v7.5/sharing/share-panel/#use-direct-link). Your Grafana instance must: diff --git a/doc/operations/product_analytics.md b/doc/operations/product_analytics.md index 98ba6a9203c..e21770bc579 100644 --- a/doc/operations/product_analytics.md +++ b/doc/operations/product_analytics.md @@ -1,81 +1,45 @@ --- stage: Analytics -group: Product Intelligence +group: Product Analytics 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 --- # Product Analytics **(FREE)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225167) in GitLab 13.3. -> - It's deployed behind a feature flag, disabled by default. -> - It's disabled on GitLab.com. -> - It's able to be enabled or disabled per-project. -> - It's not recommended for production use. -> - To use it in GitLab self-managed instances, ask a GitLab administrator to enable it. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225167) in GitLab 13.3 [with a flag](../administration/feature_flags.md) named `product_analytics`. Disabled by default. -GitLab allows you to go from planning an application to getting feedback. Feedback -is not just observability, but also knowing how people use your product. -Product Analytics uses events sent from your application to know how they are using it. -It's based on [Snowplow](https://github.com/snowplow/snowplow), the best open-source -event tracker. With Product Analytics, you can receive and analyze the Snowplow data -inside GitLab. +FLAG: +On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `product_analytics`. On GitLab.com, this feature is not available. The feature is not ready for production use. -## Enable or disable Product Analytics +GitLab enables you to go from planning an application to getting feedback. You can use +Product Analytics to receive and analyze events sent from your application. This analysis +provides observability information and feedback on how people use your product. -Product Analytics is under development and not ready for production use. It's -deployed behind a feature flag that's **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) -can enable it for your instance. Product Analytics can be enabled or disabled per-project. +Events are collected by a [Rails collector](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36443) and +then processed with [Snowplow](https://github.com/snowplow/snowplow). Events are stored in a GitLab database. -To enable it: +## View Product Analytics -```ruby -# Instance-wide -Feature.enable(:product_analytics) -# or by project -Feature.enable(:product_analytics, Project.find(<project ID>)) -``` +You can view the event data collected about your applications. -To disable it: +Prerequisite: -```ruby -# Instance-wide -Feature.disable(:product_analytics) -# or by project -Feature.disable(:product_analytics, Project.find(<project ID>)) -``` +- You must have at least the Reporter role. -## Access Product Analytics +To access Product Analytics: -After enabling the feature flag for Product Analytics, you can access the -user interface: +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, select **Monitor > Product Analytics**. -1. Sign in to GitLab as a user with at least the Reporter role. -1. Navigate to **Monitor > Product Analytics**. +The Product Analytics interface contains: -The user interface contains: +- An Events tab that shows the recent events and a total count. +- A Graph tab that shows graphs based on events of the last 30 days. +- A Test tab that sends a sample event payload. +- A Setup page containing the code to implement in your application. -- An Events page that shows the recent events and a total count. -- A test page that sends a sample event. -- A setup page containing the code to implement in your application. - -## Rate limits for Product Analytics +## Rate limits While Product Analytics is under development, it's rate-limited to **100 events per minute** per project. This limit prevents the events table in the database from growing too quickly. - -## Data storage for Product Analytics - -Product Analytics stores events are stored in GitLab database. - -WARNING: -This data storage is experimental, and GitLab is likely to remove this data during -future development. - -## Event collection - -Events are collected by [Rails collector](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36443), -allowing GitLab to ship the feature fast. Due to scalability issue, GitLab plans -to switch to a separate application, such as -[snowplow-go-collector](https://gitlab.com/gitlab-org/snowplow-go-collector), for event collection. |