diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-13 21:06:45 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-11-13 21:06:45 +0000 |
commit | b42f312df5aee0f1b832b69171e9d1cf92eb7416 (patch) | |
tree | cf0f4e59d45688723d3d534ddf13564fa10d3050 /doc/user/incident_management/index.md | |
parent | 57e3d49fc0fb99f42ac178761fc6232715734020 (diff) | |
download | gitlab-ce-b42f312df5aee0f1b832b69171e9d1cf92eb7416.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/incident_management/index.md')
-rw-r--r-- | doc/user/incident_management/index.md | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/doc/user/incident_management/index.md b/doc/user/incident_management/index.md new file mode 100644 index 00000000000..36c3d29f911 --- /dev/null +++ b/doc/user/incident_management/index.md @@ -0,0 +1,131 @@ +--- +description: "GitLab - Incident Management. GitLab offers solutions for handling incidents in your applications and services" +--- + +# Incident Management + +GitLab offers solutions for handling incidents in your applications and services, +from setting up an alert with Prometheus, to receiving a notification via a +monitoring tool like Slack, and automatically setting up Zoom calls with your +support team. + +## Configuring incidents **(ULTIMATE)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4925) in GitLab Ultimate 11.11. + +The Incident Management features can be enabled and disabled via your project's +**Settings > Operations > Incidents**. + +![Incident Management Settings](img/incident_management_settings.png) + +### Automatically create issues from alerts + +GitLab issues can automatically be created as a result of an alert notification. +An issue created this way will contain the error information to help you further +debug it. + +### Issue templates + +You can create your own [issue templates](../project/description_templates.md#creating-issue-templates) +that can be [used within Incident Management](../project/integrations/prometheus.md#taking-action-on-incidents-ultimate). + +To select your issue template for use within Incident Management: + +1. Visit your project's **Settings > Operations > Incidents**. +1. Select the template from the **Issue Template** dropdown. + +## Alerting + +GitLab can react to the alerts that your applications and services may be +triggering by automatically creating issues, and alerting developers via email. + +### Prometheus alerts + +Prometheus alerts can be set up in both: + +- [GitLab-managed Prometheus](../project/integrations/prometheus.md#setting-up-alerts-for-prometheus-metrics-ultimate) and +- [Self-managed Prometheus](../project/integrations/prometheus.md#external-prometheus-instances) installations. + +### Alert endpoint + +GitLab can accept alerts from any source via a generic webhook receiver. When +you set up the generic alerts integration, a unique endpoint will +be created which can receive a payload in JSON format. + +[Read more on setting this up, including how to customize the payload](../project/integrations/generic_alerts.md). + +### Recovery alerts + +GitLab can [automatically close issues](../project/integrations/prometheus.md#taking-action-on-incidents-ultimate) +that have been automatically created when you receive notification that the +alert is resolved. + +## Embedded metrics + +Metrics can be embedded anywhere where GitLab Markdown is used, for example, +descriptions and comments on issues and merge requests. + +TIP: **Tip:** +Both GitLab-hosted and Grafana metrics can also be +[embedded in issue templates](../project/integrations/prometheus.md#embedding-metrics-in-issue-templates). + +### GitLab-hosted metrics + +Learn how to embed [GitLab hosted metric charts](../project/integrations/prometheus.md#embedding-metric-charts-within-gitlab-flavored-markdown). + +### Grafana metrics + +Learn how to embed [Grafana hosted metric charts](../project/integrations/prometheus.md#embedding-live-grafana-charts). + +## Slack integration + +Slack slash commands allow you to control GitLab and view content right inside +Slack, without having to leave it. + +Learn how to [set up Slack slash commands](../project/integrations/slack_slash_commands.md) +and how to [use them](../../integration/slash_commands.md). + +### Slash commands + +Please refer to a list of [available slash commands](../../integration/slash_commands.md) and associated descriptions. + +## Zoom in issues + +In order to communicate synchronously for incidents management, GitLab allows to +associate a Zoom meeting with an issue. Once you start a Zoom call for a fire-fight, +you need a way to associate the conference call with an issue, so that your team +members can join swiftly without requesting a link. + +Read more how to [add or remove a zoom meeting](../project/issues/associate_zoom_meeting.md). + +### Alerting + +You can let GitLab know of alerts that may be triggering in your applications and services. GitLab can react to these by automatically creating Issues, and alerting developers via Email. + +#### Prometheus Alerts + +Prometheus alerts can be setup in both GitLab-managed Prometheus installs and self-managed Prometheus installs. + +Documentation for each method can be found here: + +- [GitLab-managed Prometheus](../project/integrations/prometheus.md#setting-up-alerts-for-prometheus-metrics-ultimate) +- [Self-managed Prometheus](../project/integrations/prometheus.md#external-prometheus-instances) + +#### Alert Endpoint + +GitLab can accept alerts from any source via a generic webhook receiver. When you set up the generic alerts integration, a unique endpoint will +be created which can receive a payload in JSON format. + +More information on setting this up, including how to customize the payload [can be found here](../project/integrations/generic_alerts.md). + +#### Recovery Alerts + +Coming soon: GitLab can automatically close Issues that have been automatically created when we receive notification that the alert is resolved. + +### Configuring Incidents + +Incident Management features can be easily enabled & disabled via the Project settings page. Head to Project -> Settings -> Operations -> Incidents. + +#### Auto-creation + +GitLab Issues can automatically be created as a result of an Alert notification. An Issue created this way will contain error information to help you further debug the error. |