centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

oncall doc updates

Browse source
This commit is contained in:
alyssa wada 2022-06-13 21:21:58 -06:00
parent a7dc16fbac
commit f1cc392ceb
11 changed files with 69 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/sources/_index.md
View file

@ -17,6 +17,8 @@ weight: 1000
# Grafana OnCall documentation
<img src="/static/img/docs/oncall/oncall-logo.png" class="no-shadow" width="700px">
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:

2
docs/sources/calendar-schedules/_index.md
View file

@ -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

5
docs/sources/chat-options/_index.md
View file

@ -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 >}}

63
docs/sources/chat-options/configure-slack.md
View file

@ -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.

4
docs/sources/chat-options/configure-telegram.md
View file

@ -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.

2
docs/sources/configure-user-settings.md
View file

@ -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

2
docs/sources/escalation-policies/_index.md
View file

@ -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/

20
docs/sources/getting-started.md
View file

@ -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:
<img src="/static/img/docs/oncall/oncall-alertworkflow.png" class="no-shadow" width="700px">
These procedures introduce you to initial Grafana OnCall configuration steps, including monitoring system integration, how to set up escalation chains, and how to use your calendar service for on-call scheduling.

2
docs/sources/integrations/_index.md
View file

@ -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

2
docs/sources/oncall-api-reference/_index.md
View file

@ -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

2
docs/sources/open-source.md
View file

@ -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