Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com> Co-authored-by: GitHub Actions <actions@github.com> Co-authored-by: Michael Derynck <michael.derynck@grafana.com> Co-authored-by: eldin <33036213+nikoalch@users.noreply.github.com> Co-authored-by: Matias Bordese <mbordese@gmail.com> Co-authored-by: chrisharbro <102977229+chrisharbro@users.noreply.github.com> Co-authored-by: Joey Orlando <joey.orlando@grafana.com> Co-authored-by: Ildar Iskhakov <Ildar.iskhakov@grafana.com>
165 lines
7.6 KiB
Markdown
165 lines
7.6 KiB
Markdown
---
|
||
aliases:
|
||
- /getting-started/
|
||
canonical: https://grafana.com/docs/oncall/latest/get-started/
|
||
keywords:
|
||
- Get started
|
||
- On call
|
||
- Grafana Cloud
|
||
title: Get started with Grafana OnCall
|
||
weight: 300
|
||
---
|
||
|
||
# Get started with Grafana OnCall
|
||
|
||
Grafana OnCall is an incident response tool built to help DevOps and SRE teams improve their collaboration and resolve
|
||
incidents faster.
|
||
|
||
With a centralized view of all your alerts, automated alert escalation and grouping, and on-call scheduling, Grafana
|
||
OnCall helps ensure that alert notifications reach the right people, at the right time using the right notification method.
|
||
|
||
The following diagram details an example alert workflow with Grafana OnCall:
|
||
|
||
<img src="/static/img/docs/oncall/oncall-alert-workflow.png" class="no-shadow" width="700px">
|
||
|
||
These procedures introduce you to initial Grafana OnCall configuration steps, including monitoring system integration,
|
||
how to set up escalation chains, and how to set up calendar for on-call scheduling.
|
||
|
||
## Before you begin
|
||
|
||
Grafana OnCall is available for Grafana Cloud as well as Grafana open source users. You must have a Grafana Cloud account
|
||
or use [Open Source Grafana OnCall]({{< relref "../open-source" >}})
|
||
|
||
## Install Open Source Grafana OnCall
|
||
|
||
For Open Source Grafana OnCall installation guidance, refer to
|
||
[Open Source Grafana OnCall]({{< relref "../open-source" >}})
|
||
|
||
> **Note:** If you are using Grafana OnCall with your Grafana Cloud instance there are no install steps. Access Grafana
|
||
> OnCall from your Grafana Cloud account and skip ahead to “Get alerts into Grafana OnCall”
|
||
|
||
## Get alerts into Grafana OnCall
|
||
|
||
Once you’ve installed Grafana OnCall or accessed it from your Grafana Cloud instance, you can begin integrating with
|
||
monitoring systems, configuring escalation chains, and get alerts into Grafana OnCall.
|
||
|
||
### Integrate with a monitoring system
|
||
|
||
Regardless of where your alerts originate, you can send them to Grafana OnCall via available integrations or customizable
|
||
webhooks. To start receiving alerts in Grafana OnCall, use the following steps to configure your first integration and
|
||
send a demo alert.
|
||
|
||
#### Configure your first integration
|
||
|
||
1. In Grafana OnCall, navigate to the **Integrations** tab and click **+ New integration to receive alerts**.
|
||
2. Select an integration from the provided options, if the integration you’re looking for isn’t listed, then select Webhook.
|
||
3. Follow the configuration steps on the integration settings page.
|
||
4. Complete any necessary configurations in your monitoring system to send alerts to Grafana OnCall.
|
||
|
||
#### Send a demo alert
|
||
|
||
1. In the integration tab, click **Send demo alert** then navigate to the **Alert Groups** tab to see your test alert firing.
|
||
2. Explore the alert by clicking on the title of the alert.
|
||
3. Acknowledge and resolve the test alert.
|
||
|
||
For more information on Grafana OnCall integrations and further configuration guidance, refer to
|
||
[Grafana OnCall integrations]({{< relref "../integrations" >}})
|
||
|
||
### Learn Alert Flow
|
||
|
||
All Alerts in OnCall are grouped to Alert Groups ([read more about Grouping ID]({{< relref "../jinja2-templating" >}})). Alert Group could have mutually
|
||
exclusive states:
|
||
|
||
- **Firing:** Once Alert Group is registered, Escalation Policy associated with it is getting started. Escalation policy will work while Alert Group is in this status.
|
||
- **Acknowledged:** Ongoing Escalation Chain will be interrupted. Unacknowledge will move Alert Group to the "Firing" state and will re-launch Escalation Chain.
|
||
- **Silenced:** Similar to "Acknowledged" but designed to be temporary with a timeout. Once time is out, will re-launch Escalation Chain and move Alert Group
|
||
to the "Firing" state.
|
||
- **Resolved:** Similar to "Acknowledged".
|
||
|
||
Possible transitions:
|
||
|
||
- Firing -> Acknowledged
|
||
- Firing -> Silenced
|
||
- Firing -> Resolved
|
||
- Silenced -> Firing
|
||
- Silenced -> Acknowledged
|
||
- Silenced -> Resolved
|
||
- Acknowledged -> Silenced
|
||
- Acknowledged -> Firing
|
||
- Acknowledged -> Resolved
|
||
- Resolved -> Firing
|
||
|
||
Transitions change trigger Escalation Chain launch with a few-seconds delay to avoid unexpected notifications.
|
||
|
||
### Configure Escalation Chains
|
||
|
||
Escalation Chains are customizable automated alert routing steps that enable you to specify who is notified for a certain
|
||
alert. In addition to escalation chains, you can configure Routes to send alerts to different escalation chains depending
|
||
on the alert details.
|
||
|
||
Once your integration is configured, you can set up an escalation chain to determine how alerts from your integration
|
||
are handled. Multi-step escalation chains help ensure thorough alert escalation to prevent alerts from being missed.
|
||
|
||
To configure Escalation Chains:
|
||
|
||
1. Navigate to the **Escalation Chains** tab and click **+ New Escalation Chain**
|
||
2. Give your Escalation Chain a useful name and click **Create**
|
||
3. Add a series of escalation steps from the available dropdown options.
|
||
4. To link your Escalation Chain to your integration, navigate back to the **Integrations tab**, Select your newly
|
||
created Escalation Chain from the “**Escalate to**” dropdown.
|
||
|
||
Alerts from this integration will now follow the escalation steps configured in your Escalation Chain.
|
||
|
||
For more information on Escalation Chains and more ways to customize them, refer to
|
||
[Configure and manage Escalation Chains]({{< relref "escalation-chains-and-routes" >}})
|
||
|
||
## Get notified of an alert
|
||
|
||
In order for Grafana OnCall to notify you of an alert, you must configure how you want to be notified. Personal notification
|
||
policies, chatops integrations, and on-call schedules allow you to automate how users are notified of alerts.
|
||
|
||
### Configure personal notification policies
|
||
|
||
Personal notification policies determine how a user is notified for a certain type of alert. Get notified by SMS,
|
||
phone call, Slack mentions, or mobile push notification. Administrators can configure how users receive notification for certain types of alerts.
|
||
For more information on personal notification policies, refer to
|
||
[Manage users and teams for Grafana OnCall]({{< relref "user-and-team-management" >}})
|
||
|
||
To configure users personal notification policies:
|
||
|
||
1. Navigate to the **Users** tab in Grafana OnCall
|
||
2. Select a user from the user list and click **Edit**
|
||
3. Configure **Default Notifications** and **Important Notification**
|
||
|
||
### Configure Slack for Grafana OnCall
|
||
|
||
Grafana OnCall integrates closely with your Slack workspace to deliver alert notifications to individuals, user groups,
|
||
and channels. Slack notifications can be triggered by steps in an escalation chain or as a step in users personal
|
||
notification policies.
|
||
|
||
To configure Slack for Grafana OnCall:
|
||
|
||
1. In OnCall, click on the ChatOps tab and select Slack in the side menu.
|
||
2. Click Install Slack integration.
|
||
3. Read the notice and confirm to proceed to the Slack website.
|
||
4. Sign in to your organization's Slack workspace.
|
||
5. Click Allow to allow Grafana OnCall to access Slack.
|
||
6. Ensure users verify their Slack accounts in their user profile in Grafana OnCall.
|
||
|
||
For further instruction on connecting to your Slack workspace, refer to
|
||
[Slack integration for Grafana OnCall]({{< relref "../notify/slack/" >}})
|
||
|
||
Grafana OnCall also supports other ChatOps integration like [Microsoft Teams and Telegram]({{< relref "../notify" >}}).
|
||
|
||
### Add your on-call schedule
|
||
|
||
Grafana OnCall allows you to manage your on-call schedule in your preferred calendar app such as Google Calendar or
|
||
Microsoft Outlook.
|
||
|
||
To integrate your on-call calendar with Grafana OnCall:
|
||
|
||
1. In the **Schedules** tab of Grafana OnCall, click **+ Add team schedule for on-call rotation**.
|
||
2. Provide a schedule name.
|
||
3. Configure the rest of the schedule settings and click Create Schedule
|
||
|
||
[More information on on-call schedules.]({{< relref "on-call-schedules" >}})
|