From 372813bdad6e76372e4618303f3d06b4fb3190fe Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Mon, 13 Jun 2022 12:52:17 -0600 Subject: [PATCH 01/13] 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**. From ba2cf5ee7b4fea807663f76c9dd10e9508b42724 Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Mon, 13 Jun 2022 14:02:31 -0700 Subject: [PATCH 02/13] Add canonical url --- docs/sources/_index.md | 1 + docs/sources/calendar-schedules/_index.md | 1 + docs/sources/chat-options/_index.md | 1 + docs/sources/chat-options/configure-slack.md | 1 + .../chat-options/configure-telegram.md | 1 + docs/sources/configure-user-settings.md | 1 + docs/sources/escalation-policies/_index.md | 16 +++---- .../configure-escalation-chains.md | 1 + .../escalation-policies/configure-routes.md | 5 ++- docs/sources/getting-started.md | 15 ++++--- docs/sources/integrations/_index.md | 1 + .../integrations/add-webhook-integration.md | 1 + .../available-integrations /_index.md | 3 +- .../add-alertmanager.md | 1 + .../add-grafana-alerting.md | 1 + .../available-integrations /add-zabbix.md | 1 + .../configure-outgoing-webhooks.md | 1 + .../integrations/create-custom-templates.md | 1 + docs/sources/oncall-api-reference/_index.md | 1 + .../oncall-api-reference/alertgroups.md | 1 + docs/sources/oncall-api-reference/alerts.md | 1 + .../oncall-api-reference/escalation_chains.md | 1 + .../escalation_policies.md | 1 + .../oncall-api-reference/integrations.md | 1 + .../oncall-api-reference/on_call_shifts.md | 1 + .../oncall-api-reference/outgoing_webhooks.md | 1 + .../personal_notification_rules.md | 1 + .../postmortem_messages.md | 1 + .../oncall-api-reference/postmortems.md | 1 + docs/sources/oncall-api-reference/routes.md | 1 + .../sources/oncall-api-reference/schedules.md | 1 + .../oncall-api-reference/slack_channels.md | 1 + .../oncall-api-reference/user_groups.md | 1 + docs/sources/oncall-api-reference/users.md | 1 + docs/sources/open-source.md | 42 +++++++++---------- 35 files changed, 74 insertions(+), 37 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index e2b19d95..a7962831 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -11,6 +11,7 @@ keywords: - OnCall - irm title: Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/" weight: 1000 --- diff --git a/docs/sources/calendar-schedules/_index.md b/docs/sources/calendar-schedules/_index.md index 7dff67a0..607f5d72 100644 --- a/docs/sources/calendar-schedules/_index.md +++ b/docs/sources/calendar-schedules/_index.md @@ -8,6 +8,7 @@ keywords: - on-call - calendar title: Configure and manage on-call schedules +canonical: "https://grafana.com/docs/oncall/latest/calendar-schedules/" weight: 900 --- diff --git a/docs/sources/chat-options/_index.md b/docs/sources/chat-options/_index.md index 324356d3..a69cf32d 100644 --- a/docs/sources/chat-options/_index.md +++ b/docs/sources/chat-options/_index.md @@ -10,6 +10,7 @@ keywords: - oncall - slack title: Connect ChatOps to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/" weight: 700 --- diff --git a/docs/sources/chat-options/configure-slack.md b/docs/sources/chat-options/configure-slack.md index 5b330838..9d42934f 100644 --- a/docs/sources/chat-options/configure-slack.md +++ b/docs/sources/chat-options/configure-slack.md @@ -10,6 +10,7 @@ keywords: - oncall - slack title: Connect Slack to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-slack/" weight: 100 --- diff --git a/docs/sources/chat-options/configure-telegram.md b/docs/sources/chat-options/configure-telegram.md index ec6128eb..0d52e861 100644 --- a/docs/sources/chat-options/configure-telegram.md +++ b/docs/sources/chat-options/configure-telegram.md @@ -10,6 +10,7 @@ keywords: - oncall - telegram title: Connect Telegram to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-telegram/ weight: 300 --- diff --git a/docs/sources/configure-user-settings.md b/docs/sources/configure-user-settings.md index 7654c795..64529000 100644 --- a/docs/sources/configure-user-settings.md +++ b/docs/sources/configure-user-settings.md @@ -10,6 +10,7 @@ keywords: - oncall - integrations title: Manage users and teams for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/configure-user-setting/" weight: 1100 --- diff --git a/docs/sources/escalation-policies/_index.md b/docs/sources/escalation-policies/_index.md index def9d900..4e8f832d 100644 --- a/docs/sources/escalation-policies/_index.md +++ b/docs/sources/escalation-policies/_index.md @@ -1,13 +1,15 @@ -+++ -title = "Configure Escalation Chains and Routes for Grafana OnCall" -keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"] -weight = 500 -+++ +--- +title: Configure escalation chains and routes for Grafana OnCall +weight: 500 +canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/" +aliases: + - /docs/oncall/latest/chat-options/escalation-policies/ +--- -# Configure Escalation Chains and Routes for Grafana OnCall +# Configure escalation chains and routes for Grafana OnCall -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/escalation-policies/configure-escalation-chains.md b/docs/sources/escalation-policies/configure-escalation-chains.md index 9430dd24..f1ce2607 100644 --- a/docs/sources/escalation-policies/configure-escalation-chains.md +++ b/docs/sources/escalation-policies/configure-escalation-chains.md @@ -10,6 +10,7 @@ keywords: - oncall - integrations title: Configure and manage Escalation Chains +canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/configure-escalation-chains/" weight: 100 --- diff --git a/docs/sources/escalation-policies/configure-routes.md b/docs/sources/escalation-policies/configure-routes.md index 18666e4c..becaa109 100644 --- a/docs/sources/escalation-policies/configure-routes.md +++ b/docs/sources/escalation-policies/configure-routes.md @@ -9,11 +9,12 @@ keywords: - amixr - oncall - integrations -title: Configure and manage Routes +title: Configure and manage routes +canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/configure-routes/" weight: 300 --- -# Configure and manage Routes +# Configure and manage routes Set up escalation chains and routes to configure escalation behavior for alert group notifications. diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index 1e762b2b..c2fe2569 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -1,10 +1,13 @@ -+++ -title = "Get started with Grafana OnCall" -keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call"] -aliases = ["/docs/grafana-cloud/oncall/getting-started"] -weight = 100 -+++ +--- +title: +- Get started with Grafana OnCall +aliases: +- /docs/grafana-cloud/oncall/getting-started +canonical: "https://grafana.com/docs/oncall/latest/getting-started/" +weight: 100 +--- +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/ # Get started with Grafana OnCall diff --git a/docs/sources/integrations/_index.md b/docs/sources/integrations/_index.md index cfbed723..debce6e8 100644 --- a/docs/sources/integrations/_index.md +++ b/docs/sources/integrations/_index.md @@ -11,6 +11,7 @@ keywords: - oncall - integrations title: Connect to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/" weight: 300 --- diff --git a/docs/sources/integrations/add-webhook-integration.md b/docs/sources/integrations/add-webhook-integration.md index e0579381..09ad3705 100644 --- a/docs/sources/integrations/add-webhook-integration.md +++ b/docs/sources/integrations/add-webhook-integration.md @@ -9,6 +9,7 @@ keywords: - Alertmanager - Prometheus title: Webhook integration for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/add-webhook-integration/" weight: 700 --- diff --git a/docs/sources/integrations/available-integrations /_index.md b/docs/sources/integrations/available-integrations /_index.md index 6e30a415..1d785f3c 100644 --- a/docs/sources/integrations/available-integrations /_index.md +++ b/docs/sources/integrations/available-integrations /_index.md @@ -1,7 +1,7 @@ --- aliases: - /docs/grafana-cloud/oncall/integrations/add-integration/ - - /docs/oncall/latest/integrations/available-integrations / + - /docs/oncall/latest/integrations/available-integrations/ keywords: - Grafana Cloud - Alerts @@ -10,6 +10,7 @@ keywords: - Alertmanager - Prometheus title: Currently available integrations for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/" weight: 100 --- diff --git a/docs/sources/integrations/available-integrations /add-alertmanager.md b/docs/sources/integrations/available-integrations /add-alertmanager.md index f5604f4e..e3a80c1c 100644 --- a/docs/sources/integrations/available-integrations /add-alertmanager.md +++ b/docs/sources/integrations/available-integrations /add-alertmanager.md @@ -10,6 +10,7 @@ keywords: - Alertmanager - Prometheus title: Connect Alert Manager to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/add-alertmanager/" weight: 300 --- diff --git a/docs/sources/integrations/available-integrations /add-grafana-alerting.md b/docs/sources/integrations/available-integrations /add-grafana-alerting.md index 0e8519dd..e3af0a90 100644 --- a/docs/sources/integrations/available-integrations /add-grafana-alerting.md +++ b/docs/sources/integrations/available-integrations /add-grafana-alerting.md @@ -9,6 +9,7 @@ keywords: - on-call - Prometheus title: Connect Grafana Alerting to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/add-grafana-alerting/" weight: 100 --- diff --git a/docs/sources/integrations/available-integrations /add-zabbix.md b/docs/sources/integrations/available-integrations /add-zabbix.md index a85e2477..cfe663a1 100644 --- a/docs/sources/integrations/available-integrations /add-zabbix.md +++ b/docs/sources/integrations/available-integrations /add-zabbix.md @@ -8,6 +8,7 @@ keywords: - on-call - Zabbix title: Connect Zabbix to Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/available-integrations/add-zabbix/" weight: 500 --- diff --git a/docs/sources/integrations/configure-outgoing-webhooks.md b/docs/sources/integrations/configure-outgoing-webhooks.md index dda09988..c35b0b24 100644 --- a/docs/sources/integrations/configure-outgoing-webhooks.md +++ b/docs/sources/integrations/configure-outgoing-webhooks.md @@ -9,6 +9,7 @@ keywords: - amixr - webhooks title: Configure outgoing webhooks for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/configure-outgoing-webhooks/" weight: 500 --- diff --git a/docs/sources/integrations/create-custom-templates.md b/docs/sources/integrations/create-custom-templates.md index 676278db..440bfe28 100644 --- a/docs/sources/integrations/create-custom-templates.md +++ b/docs/sources/integrations/create-custom-templates.md @@ -8,6 +8,7 @@ keywords: - on-call - Jinja title: Configure alerts in Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/integrations/create-custom-templates/" weight: 300 --- diff --git a/docs/sources/oncall-api-reference/_index.md b/docs/sources/oncall-api-reference/_index.md index b696b0fc..708be1a7 100644 --- a/docs/sources/oncall-api-reference/_index.md +++ b/docs/sources/oncall-api-reference/_index.md @@ -2,6 +2,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/ title: Grafana OnCall HTTP API reference +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/" weight: 1300 --- diff --git a/docs/sources/oncall-api-reference/alertgroups.md b/docs/sources/oncall-api-reference/alertgroups.md index 9ebec034..59b27ead 100644 --- a/docs/sources/oncall-api-reference/alertgroups.md +++ b/docs/sources/oncall-api-reference/alertgroups.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/alertgroups/ - /docs/oncall/latest/oncall-api-reference/alertgroups/ title: Alert groups HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/alertgroups/" weight: 400 --- diff --git a/docs/sources/oncall-api-reference/alerts.md b/docs/sources/oncall-api-reference/alerts.md index ca67add1..8a062581 100644 --- a/docs/sources/oncall-api-reference/alerts.md +++ b/docs/sources/oncall-api-reference/alerts.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/alerts/ - /docs/oncall/latest/oncall-api-reference/alerts/ title: Alerts HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/alerts/" weight: 100 --- diff --git a/docs/sources/oncall-api-reference/escalation_chains.md b/docs/sources/oncall-api-reference/escalation_chains.md index 24a7eb50..8723b6a6 100644 --- a/docs/sources/oncall-api-reference/escalation_chains.md +++ b/docs/sources/oncall-api-reference/escalation_chains.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/escalation_chains/ - /docs/oncall/latest/oncall-api-reference/escalation_chains/ title: Escalation Chains HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_chains/" weight: 200 --- diff --git a/docs/sources/oncall-api-reference/escalation_policies.md b/docs/sources/oncall-api-reference/escalation_policies.md index bc1262e4..76d253f3 100644 --- a/docs/sources/oncall-api-reference/escalation_policies.md +++ b/docs/sources/oncall-api-reference/escalation_policies.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/escalation_policies/ - /docs/oncall/latest/oncall-api-reference/escalation_policies/ title: Escalation Policies HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_policies/" weight: 300 --- diff --git a/docs/sources/oncall-api-reference/integrations.md b/docs/sources/oncall-api-reference/integrations.md index d6d7e729..ff8a7cc9 100644 --- a/docs/sources/oncall-api-reference/integrations.md +++ b/docs/sources/oncall-api-reference/integrations.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/integrations/ - /docs/oncall/latest/oncall-api-reference/integrations/ title: Integrations HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/integrations/" weight: 500 --- diff --git a/docs/sources/oncall-api-reference/on_call_shifts.md b/docs/sources/oncall-api-reference/on_call_shifts.md index c3f3a5d0..31eee871 100644 --- a/docs/sources/oncall-api-reference/on_call_shifts.md +++ b/docs/sources/oncall-api-reference/on_call_shifts.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/on_call_shifts/ - /docs/oncall/latest/oncall-api-reference/on_call_shifts/ title: OnCall shifts HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/on_call_shifts/" weight: 600 --- diff --git a/docs/sources/oncall-api-reference/outgoing_webhooks.md b/docs/sources/oncall-api-reference/outgoing_webhooks.md index f42d1c07..0e26f012 100644 --- a/docs/sources/oncall-api-reference/outgoing_webhooks.md +++ b/docs/sources/oncall-api-reference/outgoing_webhooks.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/outgoing_webhooks/ - /docs/oncall/latest/oncall-api-reference/outgoing_webhooks/ title: Outgoing webhooks HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/" weight: 700 --- diff --git a/docs/sources/oncall-api-reference/personal_notification_rules.md b/docs/sources/oncall-api-reference/personal_notification_rules.md index 2b22ec07..dc6e8562 100644 --- a/docs/sources/oncall-api-reference/personal_notification_rules.md +++ b/docs/sources/oncall-api-reference/personal_notification_rules.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/personal_notification_rules/ - /docs/oncall/latest/oncall-api-reference/personal_notification_rules/ title: Personal Notification Rules HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/personal_notification_rules/" weight: 800 --- diff --git a/docs/sources/oncall-api-reference/postmortem_messages.md b/docs/sources/oncall-api-reference/postmortem_messages.md index ba3e9252..b2fefa19 100644 --- a/docs/sources/oncall-api-reference/postmortem_messages.md +++ b/docs/sources/oncall-api-reference/postmortem_messages.md @@ -4,6 +4,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/postmortem_messages/ draft: true title: Postmortem Messages HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/postmortem_messages/" weight: 900 --- diff --git a/docs/sources/oncall-api-reference/postmortems.md b/docs/sources/oncall-api-reference/postmortems.md index 95197687..c98026ae 100644 --- a/docs/sources/oncall-api-reference/postmortems.md +++ b/docs/sources/oncall-api-reference/postmortems.md @@ -4,6 +4,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/postmortems/ draft: true title: Postmortem HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/postmortems/" weight: 1000 --- diff --git a/docs/sources/oncall-api-reference/routes.md b/docs/sources/oncall-api-reference/routes.md index 11a1a460..78eb387f 100644 --- a/docs/sources/oncall-api-reference/routes.md +++ b/docs/sources/oncall-api-reference/routes.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/routes/ - /docs/oncall/latest/oncall-api-reference/routes/ title: Routes HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/routes/" weight: 1100 --- diff --git a/docs/sources/oncall-api-reference/schedules.md b/docs/sources/oncall-api-reference/schedules.md index f8de9cb9..d7ec9273 100644 --- a/docs/sources/oncall-api-reference/schedules.md +++ b/docs/sources/oncall-api-reference/schedules.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/schedules/ - /docs/oncall/latest/oncall-api-reference/schedules/ title: Schedule HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/schedules/" weight: 1200 --- diff --git a/docs/sources/oncall-api-reference/slack_channels.md b/docs/sources/oncall-api-reference/slack_channels.md index 6dda924b..6c7d09c3 100644 --- a/docs/sources/oncall-api-reference/slack_channels.md +++ b/docs/sources/oncall-api-reference/slack_channels.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/slack_channels/ - /docs/oncall/latest/oncall-api-reference/slack_channels/ title: Slack Channels HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/slack_channels/" weight: 1300 --- diff --git a/docs/sources/oncall-api-reference/user_groups.md b/docs/sources/oncall-api-reference/user_groups.md index 7fdef887..e2021770 100644 --- a/docs/sources/oncall-api-reference/user_groups.md +++ b/docs/sources/oncall-api-reference/user_groups.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/user_groups/ - /docs/oncall/latest/oncall-api-reference/user_groups/ title: OnCall User Groups HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/user_groups/" weight: 1400 --- diff --git a/docs/sources/oncall-api-reference/users.md b/docs/sources/oncall-api-reference/users.md index a64514dc..ca6d01df 100644 --- a/docs/sources/oncall-api-reference/users.md +++ b/docs/sources/oncall-api-reference/users.md @@ -3,6 +3,7 @@ aliases: - /docs/grafana-cloud/oncall/oncall-api-reference/users/ - /docs/oncall/latest/oncall-api-reference/users/ title: Grafana OnCall Users HTTP API +canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/users/" weight: 1500 --- diff --git a/docs/sources/open-source.md b/docs/sources/open-source.md index 8d77b0d0..15da9bb1 100644 --- a/docs/sources/open-source.md +++ b/docs/sources/open-source.md @@ -5,6 +5,7 @@ aliases: keywords: - Open Source title: Open Source +canonical: "https://grafana.com/docs/oncall/latest/open-source/" weight: 100 --- @@ -27,23 +28,23 @@ Grafana OnCall Slack integration use a lot of Slack API features: 1. Make sure your OnCall is up and running. -2. You need OnCall to be accessible through https. For development purposes we suggest using [localtunnel](https://github.com/localtunnel/localtunnel). For production purposes please consider setting up proper web server with HTTPS termination. For localtunnel: -```bash -# Choose the unique prefix instead of pretty-turkey-83 -# Localtunnel will generate an url, e.g. https://pretty-turkey-83.loca.lt -# it is referred as below -lt --port 8000 -s pretty-turkey-83 --print-requests -``` +1. You need OnCall to be accessible through https. For development purposes we suggest using [localtunnel](https://github.com/localtunnel/localtunnel). For production purposes please consider setting up proper web server with HTTPS termination. For localtunnel: + ```bash + # Choose the unique prefix instead of pretty-turkey-83 + # Localtunnel will generate an url, e.g. https://pretty-turkey-83.loca.lt + # it is referred as below + lt --port 8000 -s pretty-turkey-83 --print-requests + ``` -3. If you use localtunnel, open your external URL and click "Continue" to allow requests to bypass the warning page. +1. If you use localtunnel, open your external URL and click "Continue" to allow requests to bypass the warning page. -4. [Create a Slack Workspace](https://slack.com/create) for development, or use your company workspace. +1. [Create a Slack Workspace](https://slack.com/create) for development, or use your company workspace. -5. Go to https://api.slack.com/apps and click Create New App button +1. Go to https://api.slack.com/apps and click Create New App button -6. Select `From an app manifest` option and choose the right workspace +1. Select `From an app manifest` option and choose the right workspace -7. Copy and paste the following block with the correct and fields +1. Copy and paste the following block with the correct and fields ```yaml _metadata: @@ -133,17 +134,16 @@ lt --port 8000 -s pretty-turkey-83 --print-requests socket_mode_enabled: false ``` -6. Go to your "OnCall" -> "Env Variables" and set: - ``` +1. Go to your "OnCall" -> "Env Variables" and set: + + ```bash SLACK_CLIENT_OAUTH_ID = Basic Information -> App Credentials -> Client ID SLACK_CLIENT_OAUTH_SECRET = Basic Information -> App Credentials -> Client Secret SLACK_SIGNING_SECRET = Basic Information -> App Credentials -> Signing Secret SLACK_INSTALL_RETURN_REDIRECT_HOST = << OnCall external URL >> ``` -7. Go to "OnCall" -> "ChatOps" -> "Slack" and install Slack Integration - -8. All set! +1. Go to "OnCall" -> "ChatOps" -> "Slack" and install Slack Integration ## Telegram Setup @@ -152,11 +152,11 @@ lt --port 8000 -s pretty-turkey-83 --print-requests 1. Make sure your OnCall is up and running. -2. Respectfully ask [BotFather](https://t.me/BotFather) for a key, put it in `TELEGRAM_TOKEN` in "OnCall" -> "Env Variables". +1. Respectfully ask [BotFather](https://t.me/BotFather) for a key, put it in `TELEGRAM_TOKEN` in "OnCall" -> "Env Variables". -3. Set `TELEGRAM_WEBHOOK_HOST` with your external url for OnCall. +1. Set `TELEGRAM_WEBHOOK_HOST` with your external url for OnCall. -4. Go to "OnCall" -> "ChatOps" -> Telegram and enjoy! +1. Go to "OnCall" -> "ChatOps" -> Telegram and enjoy! ## Grafana OSS-Cloud Setup @@ -167,4 +167,4 @@ Please note that it's possible either to use Grafana Cloud either Twilio for SMS ## Twilio Setup 1. Make sure Grafana OSS <-> Cloud connector is disabled. Set `GRAFANA_CLOUD_NOTIFICATIONS_ENABLED` as False. -2. Check "OnCall" -> "Env Variables" and set all variables starting with `TWILIO_` +1. Check "OnCall" -> "Env Variables" and set all variables starting with `TWILIO_` From bd858732a6342731b3c9d9e82b36c9e0ca260eef Mon Sep 17 00:00:00 2001 From: Eve Meelan <81647476+Eve832@users.noreply.github.com> Date: Mon, 13 Jun 2022 14:11:27 -0700 Subject: [PATCH 03/13] typo --- docs/sources/chat-options/configure-telegram.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/chat-options/configure-telegram.md b/docs/sources/chat-options/configure-telegram.md index 0d52e861..056e2dff 100644 --- a/docs/sources/chat-options/configure-telegram.md +++ b/docs/sources/chat-options/configure-telegram.md @@ -10,7 +10,7 @@ keywords: - oncall - telegram title: Connect Telegram to Grafana OnCall -canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-telegram/ +canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-telegram/" weight: 300 --- From 05e6772f094f19bbbaa6950dc7304bf9904b5f9c Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Mon, 13 Jun 2022 17:39:50 -0600 Subject: [PATCH 04/13] intro doc update --- docs/sources/_index.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index a7962831..f42bcbd1 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -15,12 +15,19 @@ canonical: "https://grafana.com/docs/oncall/latest/" weight: 1000 --- -# Grafana OnCall +# Grafana OnCall documentation -You can use Grafana OnCall to connect to the monitoring systems of your Grafana Cloud integrations so that you can ensure alert notifications reach the right people, at the right time, using the right medium. Team members can review and manage alert group notifications directly in OnCall, or in supported platforms, like Telegram and Slack. -When you integrate an alert monitoring system with Grafana OnCall, the alerts will create an alert group. This group will fire notifications that are sent according to escalation policies that you define in routes and escalation chains. You can configure escalation actions, and automatically notify users and groups through services like Slack, by text message, and by phone call. You can also use popular calendar services like Google Calendar and Outlook to schedule on-call shifts for team members. +Grafana OnCall is an open source incident response management tool built to help teams improve their collaboration and resolve incidents faster. Some of the core strengths of Grafana OnCall include: -Follow these links to learn more: +- **Support for a broad set of monitoring systems:** Grafana OnCall supports integrations with many monitoring systems, including Grafana, Prometheus, AlertManager, Zabbix, and more. +- **Reduce alert noise:** Automatic alert grouping helps avoid alert storms and reduce noise during incidents. Auto-resolve settings can resolve without human intervention when the resolve conditions are met, enabling you to control alert noise and reduce alert fatigue. +- **Automatic escalation to on-call rotations:** Grafana OnCall’s flexible calendar integration allows you to define your on-call rotations while managing on-call schedules in your preferred calendar application with iCal format. Configurable alert escalation automatically escalates alerts to on-call team members, notifies slack channels, and more. +- **ChatOps focused:** Grafana OnCall integrates closely with your slack workspace to deliver alert notifications to individuals and groups, making daily alerts more visible and easier to manage. +- **Highly customizable**: With customizable alert grouping and routing, you can decide which alerts you want to be notified of and how, ensuring the right people are notified for the right issues. +- **Massive scalability:** Grafana OnCall is equipped with a full API and Terraform capabilities. Ready for GitOps and large organization configuration. + + +> **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/?plcmt=nav-products-cta1&cta=cloud) to avoid installing, maintaining, and scaling your own instance of Grafana OnCall. The free forever plan includes 30 Grafana OnCall notification. [Create an account to get started](https://grafana.com/auth/sign-up/create-user?pg=oncall&plcmt=hero-btn-1). {{< section >}} From f1cc392ceb45e83acdf03890f92f84dc0c2f1ce9 Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Mon, 13 Jun 2022 21:21:58 -0600 Subject: [PATCH 05/13] oncall doc updates --- docs/sources/_index.md | 2 + docs/sources/calendar-schedules/_index.md | 2 +- docs/sources/chat-options/_index.md | 5 +- docs/sources/chat-options/configure-slack.md | 63 +++++++++++++------ .../chat-options/configure-telegram.md | 4 +- docs/sources/configure-user-settings.md | 2 +- docs/sources/escalation-policies/_index.md | 2 +- docs/sources/getting-started.md | 20 +++--- docs/sources/integrations/_index.md | 2 +- docs/sources/oncall-api-reference/_index.md | 2 +- docs/sources/open-source.md | 2 +- 11 files changed, 69 insertions(+), 37 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index f42bcbd1..29928422 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -17,6 +17,8 @@ weight: 1000 # Grafana OnCall documentation + + Grafana OnCall is an open source incident response management tool built to help teams improve their collaboration and resolve incidents faster. Some of the core strengths of Grafana OnCall include: diff --git a/docs/sources/calendar-schedules/_index.md b/docs/sources/calendar-schedules/_index.md index 607f5d72..ca3bf92b 100644 --- a/docs/sources/calendar-schedules/_index.md +++ b/docs/sources/calendar-schedules/_index.md @@ -9,7 +9,7 @@ keywords: - calendar title: Configure and manage on-call schedules canonical: "https://grafana.com/docs/oncall/latest/calendar-schedules/" -weight: 900 +weight: 1100 --- # Configure and manage on-call schedules diff --git a/docs/sources/chat-options/_index.md b/docs/sources/chat-options/_index.md index a69cf32d..aa137a0e 100644 --- a/docs/sources/chat-options/_index.md +++ b/docs/sources/chat-options/_index.md @@ -11,7 +11,7 @@ keywords: - slack title: Connect ChatOps to Grafana OnCall canonical: "https://grafana.com/docs/oncall/latest/chat-options/" -weight: 700 +weight: 900 --- # Connect ChatOps to Grafana OnCall @@ -20,4 +20,5 @@ Grafana OnCall directly supports the export of alert notifications to some popul To configure supported messaging apps, see the following topics: -{{< section >}} + +{{< section >}} \ No newline at end of file diff --git a/docs/sources/chat-options/configure-slack.md b/docs/sources/chat-options/configure-slack.md index 9d42934f..07a0642b 100644 --- a/docs/sources/chat-options/configure-slack.md +++ b/docs/sources/chat-options/configure-slack.md @@ -9,37 +9,60 @@ keywords: - amixr - oncall - slack -title: Connect Slack to Grafana OnCall +title: Slack integration for Grafana OnCall canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-slack/" weight: 100 --- -# Connect Slack to Grafana OnCall +# Slack integration for Grafana OnCall -Grafana OnCall integrates closely with your Slack workspace to deliver alert group notifications to individuals, groups, and team members. +The Slack integration for Grafana OnCall incorporates your Slack workspace directly into your incident response workflow to help your team focus on alert resolution with less friction. -## Connect to Slack +Integrating your Slack workspace with Grafana OnCall allows users and teams to be notified of alerts directly in Slack with automated alert escalation steps and user notification preferences. There are a number of alert actions that users can take directly from Slack, including acknowledge, resolve, add resolution notes, and more. -Connect your organization's Slack workspace to your Grafana OnCall instance. -> **NOTE:** Only Grafana users with the administrator role can configure OnCall settings. +## Before you begin -1. In OnCall, click on the **ChatOps** tab and select Slack in the side menu. -1. Click **Install Slack integration**. -1. Read the notice and click the button to proceed to the Slack website. -1. Sign in to your organization's workspace. -1. Click **Allow** to allow OnCall to access Slack. -1. Ensure users verify their Slack accounts in their user profile in OnCall. +To install the Slack integration, you must have Admin permissions in your Grafana instance as well as the Slack workspace that you’d like to integrate with. -## Configure Slack in OnCall +For Open Source Grafana OnCall Slack installation guidance, refer to [Open Source Grafana OnCall]({{< relref " open-source.md" >}}). -In the Slack settings for Grafana OnCall, administrators can set a default Slack channel for notifications and opt to set reminders for acknowledged alerts that can timeout and revert an alert group to the unacknowledged state. +## Install Slack integration for Grafana OnCall -1. In OnCall, click on the **ChatOps** tab and select Slack in the side menu. -1. In the first dropdown menu, select a default Slack channel. - When you set up escalation policies to notify Slack channels of incoming alerts, the default will be the one you set here. You will still have the option to select from all the channels available in your organization. -1. In **Additional settings** you can choose how to remind users of acknowledged but unresolved alert groups. You can also select whether and or when to automatically revoke the "acknowledged" status from an alert group to an unacknowledged state. +1. From the **ChatOps** tab in Grafana OnCall, select **Slack** in the side menu. +2. Click **Install Slack integration**. +3. Read the notice and agree to proceed to the Slack website. +4. Provide your Slack workspace URL and sign with your Slack credentials. +5. Click **Allow** to give Grafana OnCall permission to access your Slack workspace. -## Slack settings for on-call calendar scheduling notifications -Admins can configure settings in Slack to notify people and groups about on-call schedules. When an on-call shift notification is sent to a person or channel, click the gear button to access **Notification preferences**. Use the options to configure the behavior of future shift notifications. +## Post-install configuration for Slack integration + +Configure the following additional settings to ensure Grafanan OnCall alerts are routed to the intended Slack channels and users: + +1. From your **Slack integration** settings, select a default slack channel in the first dropdown menu. This is where alerts will be sent unless otherwise specified in escalation chains. +2. In **Additional Settings**, configure alert reminders for alerts to retrigger after being acknowledged for some amount of time. +3. Ensure all users verify their slack account in their Grafana OnCall **users info**. + +### Configure Escalation Chains with Slack notifications +Once your Slack integration is configured you can configure Escalation Chains to notify via Slack messages for alerts in Grafana OnCall. + +There are two Slack notification options that you can configure into escalation chains, notify whole Slack channel and notify Slack user group: + +1. In Grafana OnCall, navigate to the **Escalation Chains** tab then select an existing escalation chain or click **+ New escalation chain**. +2. Click the dropdown for **Add escalation step**. +3. Configure your escalation chain with automated Slack notifications. + +### Configure user notifications with Slack mentions +To be notified of alerts in Grafana OnCall via Slack mentions: + +1. Navigate to the **Users** tab in Grafana OnCall, click **Edit** next to a user. +2. In the **User Info** tab, edit or configure notification steps by clicking + Add Notification step +3. select **Notify by** in the first dropdown and select **Slack mentions** in the second dropdown to receive alert notifications via Slack mentions. + +### Configure on-call notifications in Slack +The Slack integration for Grafana Oncall supports automated Slack on-call notifications that notify individuals and teams of their on-call shifts. Admins can configure shift notification behavior in Notification preferences: + +1. When an on-call shift notification is sent to a person or channel, click the gear icon to access **Notifications preferences**. +2. Configure on-call notifications for future shift notifications. + diff --git a/docs/sources/chat-options/configure-telegram.md b/docs/sources/chat-options/configure-telegram.md index 056e2dff..30c220e9 100644 --- a/docs/sources/chat-options/configure-telegram.md +++ b/docs/sources/chat-options/configure-telegram.md @@ -9,12 +9,12 @@ keywords: - amixr - oncall - telegram -title: Connect Telegram to Grafana OnCall +title: Telegram integration for Grafana OnCall canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-telegram/" weight: 300 --- -# Connect Telegram to Grafana OnCall +# Telegram integration for Grafana OnCall You can use Telegram to deliver alert group notifications to a dedicated channel, and allow users to perform notification actions. diff --git a/docs/sources/configure-user-settings.md b/docs/sources/configure-user-settings.md index 64529000..287adf8e 100644 --- a/docs/sources/configure-user-settings.md +++ b/docs/sources/configure-user-settings.md @@ -11,7 +11,7 @@ keywords: - integrations title: Manage users and teams for Grafana OnCall canonical: "https://grafana.com/docs/oncall/latest/configure-user-setting/" -weight: 1100 +weight: 1300 --- # Manage users and teams for Grafana OnCall diff --git a/docs/sources/escalation-policies/_index.md b/docs/sources/escalation-policies/_index.md index 4e8f832d..99326a51 100644 --- a/docs/sources/escalation-policies/_index.md +++ b/docs/sources/escalation-policies/_index.md @@ -1,6 +1,6 @@ --- title: Configure escalation chains and routes for Grafana OnCall -weight: 500 +weight: 700 canonical: "https://grafana.com/docs/oncall/latest/escalation-policies/" aliases: - /docs/oncall/latest/chat-options/escalation-policies/ diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index c2fe2569..4097e05b 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -1,20 +1,26 @@ --- -title: -- Get started with Grafana OnCall -aliases: -- /docs/grafana-cloud/oncall/getting-started +aliases: + - /docs/grafana-cloud/oncall/getting-started/ + - /docs/oncall/latest/getting-started/ +keywords: + - Get started + - On call + - Grafana Cloud +title: Get started with Grafana OnCall canonical: "https://grafana.com/docs/oncall/latest/getting-started/" -weight: 100 +weight: 300 --- -canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/ - # 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: + + + 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. diff --git a/docs/sources/integrations/_index.md b/docs/sources/integrations/_index.md index debce6e8..3b0cb820 100644 --- a/docs/sources/integrations/_index.md +++ b/docs/sources/integrations/_index.md @@ -12,7 +12,7 @@ keywords: - integrations title: Connect to Grafana OnCall canonical: "https://grafana.com/docs/oncall/latest/integrations/" -weight: 300 +weight: 500 --- # Connect to Grafana OnCall diff --git a/docs/sources/oncall-api-reference/_index.md b/docs/sources/oncall-api-reference/_index.md index 708be1a7..86ba4fe3 100644 --- a/docs/sources/oncall-api-reference/_index.md +++ b/docs/sources/oncall-api-reference/_index.md @@ -3,7 +3,7 @@ aliases: - /docs/oncall/latest/oncall-api-reference/ title: Grafana OnCall HTTP API reference canonical: "https://grafana.com/docs/oncall/latest/oncall-api-reference/" -weight: 1300 +weight: 1500 --- # HTTP API Reference diff --git a/docs/sources/open-source.md b/docs/sources/open-source.md index 15da9bb1..d32707e1 100644 --- a/docs/sources/open-source.md +++ b/docs/sources/open-source.md @@ -6,7 +6,7 @@ keywords: - Open Source title: Open Source canonical: "https://grafana.com/docs/oncall/latest/open-source/" -weight: 100 +weight: 300 --- # Open Source From 00e318e03de1095d214e6adff40f3809a64fc808 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 11:05:44 +0100 Subject: [PATCH 06/13] Remove trailing space from available-integrations pages Signed-off-by: Jack Baldry --- .../_index.md | 2 +- .../add-alertmanager.md | 0 .../add-grafana-alerting.md | 0 .../add-zabbix.md | 0 4 files changed, 1 insertion(+), 1 deletion(-) rename docs/sources/integrations/{available-integrations => available-integrations}/_index.md (91%) rename docs/sources/integrations/{available-integrations => available-integrations}/add-alertmanager.md (100%) rename docs/sources/integrations/{available-integrations => available-integrations}/add-grafana-alerting.md (100%) rename docs/sources/integrations/{available-integrations => available-integrations}/add-zabbix.md (100%) diff --git a/docs/sources/integrations/available-integrations /_index.md b/docs/sources/integrations/available-integrations/_index.md similarity index 91% rename from docs/sources/integrations/available-integrations /_index.md rename to docs/sources/integrations/available-integrations/_index.md index 1d785f3c..c3127657 100644 --- a/docs/sources/integrations/available-integrations /_index.md +++ b/docs/sources/integrations/available-integrations/_index.md @@ -18,7 +18,7 @@ weight: 100 Grafana OnCall can connect directly to the monitoring services where your alerts originate. All currently available integrations are listed in the Grafana OnCall **Create Integration** section. -If the integration you're looking for isn't currently listed, see [Configure Webhook integrations for Grafana OnCall]({{< relref " ../add-webhook-integration/" >}}) to integration your monitoring system with Grafana OnCall. +If the integration you're looking for isn't currently listed, see [Configure Webhook integrations for Grafana OnCall]({{< relref "../add-webhook-integration/" >}}) to integration your monitoring system with Grafana OnCall. > **Note:** Some integrations are available for Grafana Cloud instances only. See individual integration guides for more information. diff --git a/docs/sources/integrations/available-integrations /add-alertmanager.md b/docs/sources/integrations/available-integrations/add-alertmanager.md similarity index 100% rename from docs/sources/integrations/available-integrations /add-alertmanager.md rename to docs/sources/integrations/available-integrations/add-alertmanager.md diff --git a/docs/sources/integrations/available-integrations /add-grafana-alerting.md b/docs/sources/integrations/available-integrations/add-grafana-alerting.md similarity index 100% rename from docs/sources/integrations/available-integrations /add-grafana-alerting.md rename to docs/sources/integrations/available-integrations/add-grafana-alerting.md diff --git a/docs/sources/integrations/available-integrations /add-zabbix.md b/docs/sources/integrations/available-integrations/add-zabbix.md similarity index 100% rename from docs/sources/integrations/available-integrations /add-zabbix.md rename to docs/sources/integrations/available-integrations/add-zabbix.md From 21dd05dc76cb84cd16439fa68f0670d1e47a6733 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 11:06:20 +0100 Subject: [PATCH 07/13] Fix broken links found by doc-validator Signed-off-by: Jack Baldry --- docs/sources/chat-options/_index.md | 5 ++--- docs/sources/chat-options/configure-slack.md | 4 ++-- docs/sources/getting-started.md | 12 ++++++------ 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/sources/chat-options/_index.md b/docs/sources/chat-options/_index.md index aa137a0e..ed858e62 100644 --- a/docs/sources/chat-options/_index.md +++ b/docs/sources/chat-options/_index.md @@ -16,9 +16,8 @@ weight: 900 # Connect ChatOps to Grafana OnCall -Grafana OnCall directly supports the export of alert notifications to some popular messaging applications like Slack and Telegram. You can use outgoing webhooks to applications that aren't directly supported. For information on configuring outgoing webhooks, see [Send alert group notifications by webhook]({{< relref "../integrations/webhooks/configure-outgoing-webhooks.md" >}}). +Grafana OnCall directly supports the export of alert notifications to some popular messaging applications like Slack and Telegram. You can use outgoing webhooks to applications that aren't directly supported. For information on configuring outgoing webhooks, see [Send alert group notifications by webhook]({{< relref "../integrations/configure-outgoing-webhooks.md" >}}). To configure supported messaging apps, see the following topics: - -{{< section >}} \ No newline at end of file +{{< section >}} diff --git a/docs/sources/chat-options/configure-slack.md b/docs/sources/chat-options/configure-slack.md index 07a0642b..25a5d27a 100644 --- a/docs/sources/chat-options/configure-slack.md +++ b/docs/sources/chat-options/configure-slack.md @@ -25,7 +25,7 @@ Integrating your Slack workspace with Grafana OnCall allows users and teams to b To install the Slack integration, you must have Admin permissions in your Grafana instance as well as the Slack workspace that you’d like to integrate with. -For Open Source Grafana OnCall Slack installation guidance, refer to [Open Source Grafana OnCall]({{< relref " open-source.md" >}}). +For Open Source Grafana OnCall Slack installation guidance, refer to [Open Source Grafana OnCall]({{< relref "../open-source.md" >}}). ## Install Slack integration for Grafana OnCall @@ -38,7 +38,7 @@ For Open Source Grafana OnCall Slack installation guidance, refer to [Open Sourc ## Post-install configuration for Slack integration -Configure the following additional settings to ensure Grafanan OnCall alerts are routed to the intended Slack channels and users: +Configure the following additional settings to ensure Grafana OnCall alerts are routed to the intended Slack channels and users: 1. From your **Slack integration** settings, select a default slack channel in the first dropdown menu. This is where alerts will be sent unless otherwise specified in escalation chains. 2. In **Additional Settings**, configure alert reminders for alerts to retrigger after being acknowledged for some amount of time. diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index 4097e05b..adcc572c 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -26,14 +26,14 @@ These procedures introduce you to initial Grafana OnCall configuration steps, in ## 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 [Open Source Grafana OnCall]({{< relref " open-source.md" >}}) +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" >}}) For more information, see [Grafana Pricing](https://grafana.com/pricing/) for details. ## Install Open Source Grafana OnCall -For Open Source Grafana OnCall installation guidance, refer to [Open Source Grafana OnCall]({{< relref " open-source.md" >}}) +For Open Source Grafana OnCall installation guidance, refer to [Open Source Grafana OnCall]({{< relref "open-source.md" >}}) >**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” @@ -59,7 +59,7 @@ Regardless of where your alerts originate, you can send them to Grafana OnCall v 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, [Connect to Grafana OnCall]({{< relref " ../integrations.md/" >}}) +For more information on Grafana OnCall integrations and further configuration guidance, refer to, [Connect to Grafana OnCall]({{< relref "integrations/" >}}) ### Configure Escalation Chains @@ -76,14 +76,14 @@ To configure Escalation Chains: 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-policies.md/" >}}) +For more information on Escalation Chains and more ways to customize them, refer to [Configure and manage Escalation Chains]({{< relref "escalation-policies/configure-escalation-chains/" >}}) ## 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. 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/" >}}) +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/" >}}) To configure users personal notification policies: @@ -119,6 +119,6 @@ To integrate your on-call calendar with Grafana OnCall: 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 -For more information on on-call schedules, refer to [Configure and manage on-call schedules]({{< relref " ../calendar-schedules.md/" >}}) +For more information on on-call schedules, refer to [Configure and manage on-call schedules]({{< relref "calendar-schedules/" >}}) From 236daece0d9ccb4e2152c500fe5f81737f0775a0 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 13:43:20 +0100 Subject: [PATCH 08/13] Remove self referencing link Signed-off-by: Jack Baldry --- docs/sources/escalation-policies/configure-escalation-chains.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/sources/escalation-policies/configure-escalation-chains.md b/docs/sources/escalation-policies/configure-escalation-chains.md index f1ce2607..8c244f15 100644 --- a/docs/sources/escalation-policies/configure-escalation-chains.md +++ b/docs/sources/escalation-policies/configure-escalation-chains.md @@ -31,5 +31,3 @@ An escalation chain can have many steps, or only one step. For example, steps ca ## Routes An escalation workflow can employ **routes** that administrators can configure to filter alerts by regular expressions in their payloads. Notifications for these alerts can be sent to individuals, or they can make use of a new or existing escalation chain. - -To learn how to configure escalation chains and routes, see [Configure escalation policies]({{< relref "configure-escalation-policies">}}). From 6cf190ce7113d30ac3a645b102fdd1a13dd0a096 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 14:01:03 +0100 Subject: [PATCH 09/13] Fix more links Signed-off-by: Jack Baldry --- docs/sources/getting-started.md | 2 +- docs/sources/integrations/_index.md | 2 +- docs/sources/integrations/add-webhook-integration.md | 2 +- docs/sources/oncall-api-reference/integrations.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sources/getting-started.md b/docs/sources/getting-started.md index adcc572c..77460b05 100644 --- a/docs/sources/getting-started.md +++ b/docs/sources/getting-started.md @@ -105,7 +105,7 @@ To configure Slack for Grafana OnCall: 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 [Connect Slack to Grafana OnCall]({{< relref " ../configure-slack.md/" >}}) +For further instruction on connecting to your Slack workspace, refer to [Connect Slack to Grafana OnCall]({{< relref "chat-options/configure-slack/" >}}) ### Add your on-call schedule diff --git a/docs/sources/integrations/_index.md b/docs/sources/integrations/_index.md index 3b0cb820..c0e62147 100644 --- a/docs/sources/integrations/_index.md +++ b/docs/sources/integrations/_index.md @@ -53,7 +53,7 @@ To customize alert grouping for an integration: 2. Select **Alert Behavior** from the dropdown menu next to **Edit template for**. 3. Edit the **grouping id**, **acknowledge condition**, and **resolve condition** templates as needed to customize your alert behavior. -For more information on alert templates, see [Configure alerts in Grafana OnCall]({{< relref " ../create-custom-templates/" >}}) +For more information on alert templates, see [Configure alerts in Grafana OnCall]({{< relref "create-custom-templates/" >}}) #### Add Routes diff --git a/docs/sources/integrations/add-webhook-integration.md b/docs/sources/integrations/add-webhook-integration.md index 09ad3705..f1d96eed 100644 --- a/docs/sources/integrations/add-webhook-integration.md +++ b/docs/sources/integrations/add-webhook-integration.md @@ -56,4 +56,4 @@ For example: }' ``` -To learn how to use custom alert templates for formatted webhooks, see [Configure alerts in Grafana OnCall]({{< relref "../create-custom-templates/" >}}). +To learn how to use custom alert templates for formatted webhooks, see [Configure alerts in Grafana OnCall]({{< relref "../integrations/create-custom-templates/" >}}). diff --git a/docs/sources/oncall-api-reference/integrations.md b/docs/sources/oncall-api-reference/integrations.md index ff8a7cc9..19e3edee 100644 --- a/docs/sources/oncall-api-reference/integrations.md +++ b/docs/sources/oncall-api-reference/integrations.md @@ -68,7 +68,7 @@ The above command returns JSON structured in the following way: ``` Integrations are sources of alerts and alert groups for Grafana OnCall. -For example, to learn how to integrate Grafana OnCall with Alertmanager see [Alertmanager]({{< relref "../integrations/add-alertmanager" >}}). +For example, to learn how to integrate Grafana OnCall with Alertmanager see [Alertmanager]({{< relref "../integrations/available-integrations/add-alertmanager/" >}}). **HTTP request** From fe1d2cd2ad713a50d3dccba9071c7cd63df9e2f0 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 14:05:51 +0100 Subject: [PATCH 10/13] Remove empty routes relref Signed-off-by: Jack Baldry --- docs/sources/integrations/_index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/sources/integrations/_index.md b/docs/sources/integrations/_index.md index c0e62147..354257a8 100644 --- a/docs/sources/integrations/_index.md +++ b/docs/sources/integrations/_index.md @@ -65,8 +65,6 @@ To add a route to an integration using regular expression: 4. Click **Create Route**. 5. Select an escalation chain for “**IF** alert payload matches regex” and “**ELSE**” to specify where to route each type of alert. -To learn more about routes, refer to [Configure and manage Routes]({{< relref " ../configure-routes/" >}}) - #### Edit integration name To edit the name of an integration: From c484730641cd3679b29ab50d37a486191dce1295 Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Tue, 14 Jun 2022 08:39:41 -0600 Subject: [PATCH 11/13] open source doc edits --- docs/sources/open-source.md | 73 +++++++++++++++++++++---------------- 1 file changed, 42 insertions(+), 31 deletions(-) diff --git a/docs/sources/open-source.md b/docs/sources/open-source.md index d32707e1..6364c6ef 100644 --- a/docs/sources/open-source.md +++ b/docs/sources/open-source.md @@ -9,26 +9,33 @@ canonical: "https://grafana.com/docs/oncall/latest/open-source/" weight: 300 --- -# Open Source +# Grafana OnCall Open Source guide -We prepared three environments for OSS users: -- **Hobby** environment for local usage & playing around: [README.md](https://github.com/grafana/oncall#getting-started). +Grafana OnCall is a developer-friendly incident response tool that is available to Grafana OSS users. + +This document is meant to guide you through open source specific Grafana OnCall configuration steps. + +There are three Grafana OnCall environments available for OSS users: + +- **Hobby** Playground environment for local usage: [README.md](https://github.com/grafana/oncall#getting-started). - **Development** environment for contributors: [DEVELOPER.md](https://github.com/grafana/oncall/blob/dev/DEVELOPER.md) - **Production** environment for reliable cloud installation using Helm: [Production Environment](#production-environment) -## Production Environment -TBD +## Configure Slack for OSS Grafana OnCall -## Slack Setup +The Slack integration for Grafana OnCall Slack leverages Slack API features for a customizable and useful integration. -Grafana OnCall Slack integration use a lot of Slack API features: -- Subscription on Slack events requires OnCall to be externally available and provide https endpoint. -- You will need to register new Slack App. +The following are required to configure Slack for open source Grafana OnCall: +- Register a new Slack App. +- Grafana OnCall must be externally available and provide https endpoint to establish subscription on Slack events. -1. Make sure your OnCall is up and running. +1. Make sure your Grafana OnCall environment is up and running. + +2. OnCall must be accessible through https. For development purposes, it's recommended to use [localtunnel](https://github.com/localtunnel/localtunnel). For production purposes please consider setting up proper web server with HTTPS termination. + +Refer to the following example configuration for localtunnel: -1. You need OnCall to be accessible through https. For development purposes we suggest using [localtunnel](https://github.com/localtunnel/localtunnel). For production purposes please consider setting up proper web server with HTTPS termination. For localtunnel: ```bash # Choose the unique prefix instead of pretty-turkey-83 # Localtunnel will generate an url, e.g. https://pretty-turkey-83.loca.lt @@ -36,15 +43,15 @@ Grafana OnCall Slack integration use a lot of Slack API features: lt --port 8000 -s pretty-turkey-83 --print-requests ``` -1. If you use localtunnel, open your external URL and click "Continue" to allow requests to bypass the warning page. +1. If using localtunnel, open your external URL and click **Continue** to allow requests to bypass the warning page. -1. [Create a Slack Workspace](https://slack.com/create) for development, or use your company workspace. +2. [Create a Slack Workspace](https://slack.com/create) or for development, or use your company workspace. -1. Go to https://api.slack.com/apps and click Create New App button +3. Go to https://api.slack.com/apps and click **Create New App**. -1. Select `From an app manifest` option and choose the right workspace +4. Select **`From an app manifest`** option and select your workspace. -1. Copy and paste the following block with the correct and fields +5. Copy and paste the following block. Be sure to replace and fields with the appropriate information. ```yaml _metadata: @@ -134,7 +141,7 @@ Grafana OnCall Slack integration use a lot of Slack API features: socket_mode_enabled: false ``` -1. Go to your "OnCall" -> "Env Variables" and set: +6. Set environment variables by navigating to your Grafana OnCall, then click **Env Variables** and set the following: ```bash SLACK_CLIENT_OAUTH_ID = Basic Information -> App Credentials -> Client ID @@ -143,28 +150,32 @@ Grafana OnCall Slack integration use a lot of Slack API features: SLACK_INSTALL_RETURN_REDIRECT_HOST = << OnCall external URL >> ``` -1. Go to "OnCall" -> "ChatOps" -> "Slack" and install Slack Integration +7. From **OnCall**, navigate to **ChatOps**, select **Slack** and install Slack integration. -## Telegram Setup +## Configure Telegram for OSS Grafana OnCall -- Telegram integrations requires OnCall to be externally available and provide https endpoint. -- Telegram integration in OnCall is designed for collaborative team work. It requires Telegram Group and a Telegram Channel (private) for alerts. +The Telegram integration for Grafana OnCall is designed for collaborative team work and improved incident response. -1. Make sure your OnCall is up and running. +The following is required to configure the Telegram integration for OSS OnCall: -1. Respectfully ask [BotFather](https://t.me/BotFather) for a key, put it in `TELEGRAM_TOKEN` in "OnCall" -> "Env Variables". +- Grafana OnCall must be externally available and provide https endpoint to establish connection to Telegram. +- Telegram requires a separate, private Telegram Group and Telegram Channel for OnCall alerts to be sent to. -1. Set `TELEGRAM_WEBHOOK_HOST` with your external url for OnCall. +1. Make sure your Grafana OnCall environment is up and running. -1. Go to "OnCall" -> "ChatOps" -> Telegram and enjoy! +2. Request [BotFather](https://t.me/BotFather) for a key, then add the key in `TELEGRAM_TOKEN` in Grafana OnCall by navigating to **Env Variables**. -## Grafana OSS-Cloud Setup +3. Set `TELEGRAM_WEBHOOK_HOST` with your external URL for Grafana OnCall. -Grafana OSS could be connected to Grafana Cloud for heartbeat and SMS / Phone Calls. We tried our best in making Grafana OSS <-> Cloud self-explanatory. Check "Cloud" page in your OSS OnCall instance. +4. From the **ChatOps** tab in Grafana OnCall, click **Telegram** and your integration is now ready for use. -Please note that it's possible either to use Grafana Cloud either Twilio for SMS/Phone calls. +## Configure Grafana Cloud for OnCall OSS -## Twilio Setup +Open source Grafana OnCall can be connected to Grafana Cloud to configure heartbeat notification as well as SMS and phone calls for user notifications.For more information, refer to the "Cloud" page in your OSS Grafana OnCall instance. -1. Make sure Grafana OSS <-> Cloud connector is disabled. Set `GRAFANA_CLOUD_NOTIFICATIONS_ENABLED` as False. -1. Check "OnCall" -> "Env Variables" and set all variables starting with `TWILIO_` +>**NOTE:** Phone call and SMS notifications can be configured using Grafana Cloud or you can use Twilio as an alternative option. + +## Configure OSS Grafana OnCall notifications with Twilio + +1. Set `GRAFANA_CLOUD_NOTIFICATIONS_ENABLED` as False to ensure the Grafana OSS <-> Cloud connector is disabled. +2. From your OnCall environment, select **Env Variables** and configure all variables starting with `TWILIO_`. From 56564d8eeb7c075d66d94d119fc8a06a218dc882 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 17:04:23 +0100 Subject: [PATCH 12/13] Add publish docs workflows Signed-off-by: Jack Baldry --- .../publish-technical-documentation-next.yml | 43 +++++++++++ ...ublish-technical-documentation-release.yml | 74 +++++++++++++++++++ 2 files changed, 117 insertions(+) create mode 100644 .github/workflows/publish-technical-documentation-next.yml create mode 100644 .github/workflows/publish-technical-documentation-release.yml diff --git a/.github/workflows/publish-technical-documentation-next.yml b/.github/workflows/publish-technical-documentation-next.yml new file mode 100644 index 00000000..67a6cf25 --- /dev/null +++ b/.github/workflows/publish-technical-documentation-next.yml @@ -0,0 +1,43 @@ +name: "publish-technical-documentation-next" + +on: + push: + branches: + - "main" + - "dev" + paths: + - "docs/sources/**" + workflow_dispatch: +jobs: + test: + runs-on: "ubuntu-latest" + steps: + - name: "Check out code" + uses: "actions/checkout@v3" + - name: "Build website" + # -e HUGO_REFLINKSERRORLEVEL=ERROR prevents merging broken refs with the downside + # that no refs to external content can be used as these refs will not resolve in the + # docs-base image. + run: | + docker run -v ${PWD}/docs/sources:/hugo/content/docs/oncall/latest -e HUGO_REFLINKSERRORLEVEL=ERROR --rm grafana/docs-base:latest /bin/bash -c 'make hugo' + + sync: + runs-on: "ubuntu-latest" + needs: "test" + steps: + - name: "Check out code" + uses: "actions/checkout@v3" + + - name: "Clone website-sync Action" + run: "git clone --single-branch --no-tags --depth 1 -b master https://grafanabot:${{ secrets.GH_BOT_ACCESS_TOKEN }}@github.com/grafana/website-sync ./.github/actions/website-sync" + + - name: "Publish to website repository (next)" + uses: "./.github/actions/website-sync" + id: "publish-next" + with: + repository: "grafana/website" + branch: "master" + host: "github.com" + github_pat: "${{ secrets.GH_BOT_ACCESS_TOKEN }}" + source_folder: "docs/sources" + target_folder: "content/docs/oncall/next" diff --git a/.github/workflows/publish-technical-documentation-release.yml b/.github/workflows/publish-technical-documentation-release.yml new file mode 100644 index 00000000..ace2f629 --- /dev/null +++ b/.github/workflows/publish-technical-documentation-release.yml @@ -0,0 +1,74 @@ +name: "publish-technical-documentation-release" + +on: + push: + branches: + - "release-*" + tags: + - "v[0-9]+.[0-9]+.[0-9]+" + paths: + - "docs/sources/**" + workflow_dispatch: +jobs: + test: + runs-on: "ubuntu-latest" + steps: + - name: "Check out code" + uses: "actions/checkout@v3" + - name: + "Build website" + # -e HUGO_REFLINKSERRORLEVEL=ERROR prevents merging broken refs with the downside + # that no refs to external content can be used as these refs will not resolve in the + # docs-base image. + run: | + docker run -v ${PWD}/docs/sources:/hugo/content/docs/oncall/latest -e HUGO_REFLINKSERRORLEVEL=ERROR --rm grafana/docs-base:latest /bin/bash -c 'make hugo' + + sync: + runs-on: "ubuntu-latest" + needs: "test" + steps: + - name: "Checkout code and tags" + uses: "actions/checkout@v3" + with: + fetch-depth: 0 + + - name: "Checkout Actions library" + uses: "actions/checkout@v3" + with: + repository: "grafana/grafana-github-actions" + path: "./actions" + + - name: "Install Actions from library" + run: "npm install --production --prefix ./actions" + + - name: "Determine if there is a matching release tag" + id: "has-matching-release-tag" + uses: "./actions/has-matching-release-tag" + with: + ref_name: "${{ github.ref_name }}" + release_tag_regexp: "^v(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$" + release_branch_regexp: "^release-(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$" + + - name: "Determine technical documentation version" + if: "steps.has-matching-release-tag.outputs.bool == 'true'" + uses: "./actions/docs-target" + id: "target" + with: + ref_name: "${{ github.ref_name }}" + + - name: "Clone website-sync Action" + if: "steps.has-matching-release-tag.outputs.bool == 'true'" + run: "git clone --single-branch --no-tags --depth 1 -b master https://grafanabot:${{ secrets.GH_BOT_ACCESS_TOKEN }}@github.com/grafana/website-sync ./.github/actions/website-sync" + + - name: "Publish to website repository (release)" + if: "steps.has-matching-release-tag.outputs.bool == 'true'" + uses: "./.github/actions/website-sync" + id: "publish-release" + with: + repository: "grafana/website" + branch: "master" + host: "github.com" + github_pat: "${{ secrets.GH_BOT_ACCESS_TOKEN }}" + source_folder: "docs/sources" + # Append ".x" to target to produce a v..x directory. + target_folder: "content/docs/oncall/${{ steps.target.outputs.target }}.x" From 8f03384cb5faf4a6577ede95be4811864d9df6cf Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Tue, 14 Jun 2022 17:08:49 +0100 Subject: [PATCH 13/13] Revert publish on pushes to dev Signed-off-by: Jack Baldry --- .github/workflows/publish-technical-documentation-next.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/publish-technical-documentation-next.yml b/.github/workflows/publish-technical-documentation-next.yml index 67a6cf25..1e0e3e9c 100644 --- a/.github/workflows/publish-technical-documentation-next.yml +++ b/.github/workflows/publish-technical-documentation-next.yml @@ -4,7 +4,6 @@ on: push: branches: - "main" - - "dev" paths: - "docs/sources/**" workflow_dispatch: