From 372813bdad6e76372e4618303f3d06b4fb3190fe Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Mon, 13 Jun 2022 12:52:17 -0600 Subject: [PATCH] getting started updated --- docs/sources/escalation-policies/_index.md | 6 +- docs/sources/getting-started.md | 133 ++++++++++----------- 2 files changed, 67 insertions(+), 72 deletions(-) diff --git a/docs/sources/escalation-policies/_index.md b/docs/sources/escalation-policies/_index.md index 36e90fe5..02605174 100644 --- a/docs/sources/escalation-policies/_index.md +++ b/docs/sources/escalation-policies/_index.md @@ -1,10 +1,12 @@ +++ -title = "Escalation Chains and Routes" +title = "Configure Escalation Chains and Routes for Grafana OnCall" keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"] weight = 500 +++ -# Escalation Chains and Routes for Grafana OnCall +# Configure Escalation Chains and Routes for Grafana OnCall + +Escalation Chains and Routes for Grafana OnCall Administrators can create escalation policies to automatically send alert group notifications to recipients. These policies define how, where, and when to send notifications. diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index 97aac06b..d3a5c9e6 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -1,121 +1,114 @@ +++ -title = "Getting started with Grafana OnCall" +title = "Get started with Grafana OnCall" keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call"] aliases = ["/docs/grafana-cloud/oncall/getting-started"] weight = 100 +++ -# Getting started with Grafana OnCall +# 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. + +These procedures introduce you to initial Grafana OnCall configuration steps, including monitoring system integration, how to set up escalation chains, and how to use your calendar service for on-call scheduling. -These procedures introduce you to the configuration of user settings, how to set up escalation policies, and how to use your calendar service for on-call scheduling. ## Before you begin -You must have a Grafana Cloud account. +Grafana OnCall is available for Grafana Cloud as well as Grafana open source users. You must have a Grafana Cloud account or [Open Source Grafana OnCall]({{< relref " open-source.md" >}}) -Each supported integration and the associated monitoring system has a slightly different configuration method. These methods will not be explained in this guide, however, you can follow the online instructions provided when adding an integration. + For more information, see [Grafana Pricing](https://grafana.com/pricing/) for details. -## Configure user notification policies -You can configure how each user will receive notifications when they are assigned in escalation policies. +## Install Open Source Grafana OnCall (OSS Only) -1. Find users. - - Select the **Users** tab and use the browser to search for a user in your organization. -1. Configure user settings. +For Open Source Grafana OnCall installation guidance, refer to [Open Source Grafana OnCall]({{< relref " open-source.md" >}}) - Add and verify a phone number and a Slack username if you want to deliver notifications using these mediums. -
+>**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” - >**NOTE:** To edit a user's username, email, or role, you must do so in the **Users** tab in the **Configuration** menu of your Grafana instance. -1. Configure notification settings. - - You can configure the notification medium and frequency for each user. **Important Notifications** are specified in escalation steps. -## Connect to integration data sources +## Get alerts into Grafana OnCall -You use Grafana OnCall to connect to the monitoring services of your alert sources listed in the Grafana OnCall **Integrations** section. +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. -1. Connect to a alert source with configured alerts. - - In Grafana OnCall, click on the **Integrations** tab and click **+ New integration for receiving alerts**. +### Integrate with a monitoring system -1. Select an integration from the provided options. - - If you want to use an integration that is not listed, you must use webhooks. +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. -1. Configure your integration. - - Each integration has a different method of connecting to Grafana OnCall. For example, if you want to connect to your Grafana alert source, select Grafana and follow the instructions. +#### Configure your first integration: +1. In Grafana OnCall, navigate to the **Integrations** tab and click **+ New integration for receiving 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. -## Configure escalation policies +#### Send a demo alert -You can use **escalation chains** to determine ordered escalation procedures. Configuring escalation chains allows you to set up a chain of incident notification actions that trigger if certain conditions that you specify are not met. +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. -1. Click on the integration tile for which you want to define escalation policies. - - The **Escalations** section for the notification is in the pane to the right of the list of notifications. - You can click **Change alert template and grouping** to customize the look of the alert. You can also do this by clicking the **Settings** (gear) icon in the integration tile. +For more information on Grafana OnCall integrations and further configuration guidance, refer to, [Connect to Grafana OnCall]({{< relref " ../integrations.md/" >}}) -1. Create an escalation chain. - - In the escalation pane, click the **escalate to** menu to choose from previously added escalation chains, or create a new one by clicking **Create a new**. This will be the name of the escalation policy you define. -1. Add escalation steps. +### Configure Escalation Chains - Click **Add escalation step** to choose from a set of actions and specify their triggering conditions. By default, the first step is to notify a slack channel or user. Specify users or channels or toggle the switch to turn this step off. +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. - To mark an escalation as **Important**, select the option from the step **Start** dropdown menu. User notification policies can be separately defined for **Important** and **Default** escalations. +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. -1. Add a route. +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. - To add a route, click **Add Route**. - - You can set up a single route and specify notification escalation steps, or you can add multiple routes, each with its own configuration. +Alerts from this integration will now follow the escalation steps configured in your Escalation Chain. - Each route added to an escalation policy follows an `IF`, `ELSE IF`, and `ELSE` path and depends on the type of alert you specify using a regular expression that matches content in the payload body of the alert. You can also specify where to send the notification for each route. - - For example, you can send notifications for alert incidents with `\"severity\": \"critical\"` in the payload to an escalation chain called `Bob_OnCall`. You can create a different route for alerts with the payload `\"namespace\" *: *\"synthetic-monitoring-dev-.*\"` and select a escalation chain called `NotifySecurity`. +For more information on Escalation Chains and more ways to customize them, refer to [Configure and manage Escalation Chains]({{< relref " ../escalation-policies.md/" >}}) - You can set up escalation steps for each route in a chain. +## Get notified of an alert - >**NOTE:** When you modify an escalation chain or a route, it will modify that escalation chain across all integrations that use it. - -## Use calendars to configure on-call schedules +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. -You can use any calendar with an iCal address to schedule on-call times for users. During these times, notifications configured in escalation chains with the **Notify users from an on-call schedule** setting will be sent to the the person scheduled. You can also schedule multiple users for overlapping times, and assign prioritization labels for the user that you would like to notify. +### Configure personal notification policies +Personal notification policies determine how a user is notified for a certain type of alert. 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 " ../configure-user-settings.md/" >}}) -1. In the **Scheduling** section of Grafana OnCall, click **+ Create schedule**. +To configure users personal notification policies: -1. Give the schedule a name. +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** -1. Create a new calendar in your calendar service and locate the secret iCal URL. For example, in a Google calendar, this URL can be found in **Settings > Settings for my calendars > Integrate calendar**. -1. Copy the secret iCal URL. In OnCall, paste it into the **Primary schedule for iCal URL** field. - The permissions you set for the calendar determine who can modify the calendar. +### Configure Slack for Grafana OnCall -1. Click **Create Schedule**. +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. -1. Schedule on-call times for team members. +To configure Slack for Grafana OnCall: - Use the usersname of team members as the event name to schedule their on-call times. You can take advantage of all of the features of your calendar service. +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. -1. (Optional) Create overlapping schedules. +For further instruction on connecting to your Slack workspace, refer to [Connect Slack to Grafana OnCall]({{< relref " ../configure-slack.md/" >}}) - When you create schedules that overlap, you can prioritize a schedule by adding a level marker. For example, if users AliceGrafana and BobGrafana have overlapping schedules, but BobGrafana is the primary contact, you would name his event `[L1] BobGrafana`, AliceGrafana maintains the default `[L0]` status, and would not receive notifications during the overlapping time. You can prioritize up to and including level 9, or `[L9]`. -### (Optional) Create an override calendar. +### Add your on-call schedule -You can use an override calendar to allow team members to schedule on-call duties that will override the primary schedule. An override option allows flexibility without modifying the primary schedule. Events scheduled on the override calendar will always override overlapping events on the primary calendar. +Grafana OnCall allows you to manage your on-call schedule in your preferred calendar app such as Google Calendar or Microsoft Outlook. -1. Create a new calendar using the same calendar service you used to create the primary calendar. +To integrate your on-call calendar with Grafana OnCall: - Be sure to set permissions that allow team members to edit the calendar. +1. In the **Schedules** tab of Grafana OnCall, click **+ Add team schedule for on-call rotation**. +2. Provide a schedule name. +3. Copy the iCal URL associated with your on-call calendar from your calendar integration settings. +4. Configure the rest of the schedule settings and click Create Schedule -1. In the scheduling section of Grafana OnCall, select the primary calendar you want to override. +For more information on on-call schedules, refer to [Configure and manage on-call schedules]({{< relref " ../calendar-schedules.md/" >}}) -1. Click **Edit**. - -1. Enter the secret iCal URL in the **Overrides schedule iCal URL** field and click **Update**.