oncall docs IA refactor
This commit is contained in:
alyssa wada
parent
f4cc1a9eb0
commit
52ec19d593
22 changed files with 84 additions and 124 deletions
|
|
@ -8,4 +8,4 @@ pull:
|
|||
|
||||
.PHONY: docs
|
||||
docs: pull
|
||||
docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE)
|
||||
docker run -v '$(shell pwd)/sources:$(CONTENT_PATH):Z' -p $(PORT) --rm -it $(IMAGE)
|
||||
|
|
|
|||
|
|
@ -1,15 +1,56 @@
|
|||
+++
|
||||
title = "On-call calendar scheduling"
|
||||
title = "Configure and manage on-call schedules"
|
||||
description = ""
|
||||
keywords = ["Grafana", "oncall", "on-call", "calendar"]
|
||||
aliases = []
|
||||
weight = 1100
|
||||
weight = 900
|
||||
+++
|
||||
|
||||
# Use calendars to create on-call schedules
|
||||
# Configure and manage on-call schedules
|
||||
|
||||
Grafana OnCall allows you to use any calendar service that uses the iCal format to create customized on-call schedules for team members. Using Grafana OnCall, you can create a primary calendar that acts as a read-only schedule, and an override calendar that allows all team members to modify schedules as they change.
|
||||
|
||||
To learn more about creating on-call calendars, see the following topics:
|
||||
|
||||
{{< section >}}
|
||||
# Configure and manage on-call schedules
|
||||
|
||||
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.
|
||||
|
||||
When you create a schedule, you will be able to select a Slack channel, associated with your OnCall account, that will notify users when there are errors or notifications regarding the assigned on-call shifts.
|
||||
|
||||
## Create an on-call schedule calendar
|
||||
|
||||
Create a primary calendar and an optional override calendar to schedule on-call shifts for team members.
|
||||
|
||||
1. In the **Scheduling** section of Grafana OnCall, click **+ Create schedule**.
|
||||
|
||||
1. Give the schedule a name.
|
||||
|
||||
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 when you create the calendar determine who can modify the calendar.
|
||||
|
||||
1. Click **Create Schedule**.
|
||||
|
||||
1. Schedule on-call times for team members.
|
||||
|
||||
Use the Grafana username 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. Create overlapping schedules (optional).
|
||||
|
||||
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 a level 9 prioritization, or `[L9]`.
|
||||
|
||||
# Create an override calendar (optional)
|
||||
|
||||
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.
|
||||
|
||||
1. Create a new calendar using the same calendar service you used to create the primary calendar.
|
||||
|
||||
Be sure to set permissions that allow team members to edit the calendar.
|
||||
|
||||
1. In the scheduling section of Grafana OnCall, select the primary calendar you want to override.
|
||||
|
||||
1. Click **Edit**.
|
||||
|
||||
1. Enter the secret iCal URL in the **Overrides schedule iCal URL** field and click **Update**.
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
+++
|
||||
title = "About Grafana OnCall calendar scheduling"
|
||||
description = ""
|
||||
keywords = ["Grafana", "oncall", "on-call", "calendar"]
|
||||
aliases = []
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# About Grafana OnCall scheduling
|
||||
|
||||
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.
|
||||
|
||||
When you create a schedule, you will be able to select a Slack channel, associated with your OnCall account, that will notify users when there are errors or notifications regarding the assigned on-call shifts.
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
+++
|
||||
title = "Create an on-call schedule calendar"
|
||||
description = ""
|
||||
keywords = ["Grafana", "oncall", "on-call", "calendar"]
|
||||
aliases = []
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Create an on-call schedule calendar
|
||||
|
||||
Create a primary calendar and an optional override calendar to schedule on-call shifts for team members.
|
||||
|
||||
1. In the **Scheduling** section of Grafana OnCall, click **+ Create schedule**.
|
||||
|
||||
1. Give the schedule a name.
|
||||
|
||||
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 when you create the calendar determine who can modify the calendar.
|
||||
|
||||
1. Click **Create Schedule**.
|
||||
|
||||
1. Schedule on-call times for team members.
|
||||
|
||||
Use the Grafana username 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. Create overlapping schedules (optional).
|
||||
|
||||
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 a level 9 prioritization, or `[L9]`.
|
||||
|
||||
# Create an override calendar (optional)
|
||||
|
||||
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.
|
||||
|
||||
1. Create a new calendar using the same calendar service you used to create the primary calendar.
|
||||
|
||||
Be sure to set permissions that allow team members to edit the calendar.
|
||||
|
||||
1. In the scheduling section of Grafana OnCall, select the primary calendar you want to override.
|
||||
|
||||
1. Click **Edit**.
|
||||
|
||||
1. Enter the secret iCal URL in the **Overrides schedule iCal URL** field and click **Update**.
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Messaging application configuration"
|
||||
title = "Connect ChatOps to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "slack"]
|
||||
weight = 700
|
||||
+++
|
||||
|
||||
# Messaging application configuration
|
||||
# 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" >}}).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Configure Slack for Grafana OnCall"
|
||||
title = "Connect Slack to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "slack"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Configure Slack for Grafana OnCall
|
||||
# Connect Slack to Grafana OnCall
|
||||
Grafana OnCall integrates closely with your Slack workspace to deliver alert group notifications to individuals, groups, and team members.
|
||||
|
||||
## Connect to Slack
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Configure Telegram for Grafana OnCall"
|
||||
title = "Connect Telegram to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "telegram"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Configure Telegram for Grafana OnCall
|
||||
# Connect Telegram to Grafana OnCall
|
||||
|
||||
You can use Telegram to deliver alert group notifications to a dedicated channel, and allow users to perform notification actions.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Configure user settings"
|
||||
title = "Manage users and teams for Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"]
|
||||
weight = 900
|
||||
weight = 1100
|
||||
+++
|
||||
|
||||
# User settings for Grafana OnCall
|
||||
# Manage users and teams for Grafana OnCall
|
||||
|
||||
Grafana OnCall is configured based on the teams you've created on the organization level of your Grafana instance, in **Configuration > Teams**. Administrators can create a different configuration for each team, and can navigate between team configurations in the **Select Team** dropdown menu in the **Incidents** section of Grafana OnCall.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Escalation policies"
|
||||
title = "Escalation Chains and Routes"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"]
|
||||
weight = 500
|
||||
+++
|
||||
|
||||
# Grafana OnCall escalation policies
|
||||
# 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "About escalation policies"
|
||||
title = "Configure and manage Escalation Chains"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# About escalation policies
|
||||
# Configure and manage Escalation Chains
|
||||
|
||||
Escalation policies dictate how users and groups are notified when an alert notification is created. They can be very simple, or very complex. You can define as many escalation configurations for an integration as you need, and you can send notifications for certain alerts to a designated place when certain conditions are met, or not met.
|
||||
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Configure escalation policies"
|
||||
title = "Configure and manage Routes"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Configure escalation policies
|
||||
# Configure and manage Routes
|
||||
Set up escalation chains and routes to configure escalation behavior for alert group notifications.
|
||||
|
||||
## Configure escalation chains
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
+++
|
||||
title = "Getting started with Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call"]
|
||||
aliases = ["/docs/grafana-cloud/oncall/configure-notifications"]
|
||||
draft = true
|
||||
aliases = ["/docs/grafana-cloud/oncall/getting-started"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Configure users, notifications, and on-call schedules
|
||||
# Getting started with Grafana OnCall
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
title = "Connect to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "oncall", "integrations"]
|
||||
weight = 100
|
||||
weight = 300
|
||||
aliases = ["/docs/grafana-cloud/oncall/integrations/"]
|
||||
+++
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Webhook integration"
|
||||
title = "Webhook integration for Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Alertmanager", "Prometheus"]
|
||||
weight = 100
|
||||
weight = 700
|
||||
+++
|
||||
|
||||
# Integrate with your alert source using webhooks
|
||||
# Webhook integration for Grafana OnCall
|
||||
|
||||
Grafana OnCall directly supports integrations from many alert sources, but you can connect to any alert source that isn't listed in the **Create Integration** page by using webhooks.
|
||||
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
+++
|
||||
title = "Integrate with alert sources"
|
||||
title = "Currently available integrations for Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Alertmanager", "Prometheus"]
|
||||
aliases = ["/docs/grafana-cloud/oncall/integrations/add-integration/"]
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Integrate with alert sources
|
||||
# Currently available integrations
|
||||
|
||||
Grafana OnCall can connect directly to the monitoring services of your alert sources listed in the Grafana OnCall **Integrations** section.
|
||||
|
||||
|
|
@ -20,3 +20,5 @@ Grafana OnCall can connect directly to the monitoring services of your alert sou
|
|||
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 as an alert source, select Grafana and follow the instructions.
|
||||
|
||||
{{< section >}}
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
+++
|
||||
title = "Configure alert notifications with Alertmanager"
|
||||
title = "Connect Alert Manager to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Alertmanager", "Prometheus"]
|
||||
aliases = ["/docs/grafana-cloud/oncall/integrations/add-alertmanager/"]
|
||||
weight = 500
|
||||
aliases = ["/docs/grafana-cloud/oncall/available-integrations/add-alertmanager/"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Alertmanager (Prometheus)
|
||||
# Connect Alert manager to Grafana OnCall
|
||||
|
||||
The Alertmanager integration handles alerts sent by client applications such as the Prometheus server.
|
||||
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
+++
|
||||
title = "Configure alert notifications with Grafana Alerting"
|
||||
title = "Connect Grafana Alerting to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Prometheus"]
|
||||
aliases = ["/docs/grafana-cloud/oncall/integrations/add-grafana-alerting/"]
|
||||
weight = 300
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
# Connect Grafana Alerting to Grafana OnCall
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
title = "Configure alert notifications with Zabbix"
|
||||
title = "Connect Zabbix to Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Zabbix"]
|
||||
weight = 700
|
||||
weight = 500
|
||||
+++
|
||||
|
||||
# Connect Zabbix to Grafana OnCall
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Send alert notifications by webhook"
|
||||
title = "Configure outgoing webhooks for Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "amixr", "webhooks"]
|
||||
weight = 500
|
||||
+++
|
||||
|
||||
# Send alert group notifications by webhook
|
||||
# Configure outgoing webhooks for Grafana OnCall
|
||||
You can configure outgoing webhooks to send alerts to destination. Once a webhook is created, you can choose the webhook as a notification method in escalation steps.
|
||||
|
||||
1. In Grafana OnCall, navigate to **Outgoing Webhooks** and click **+ Create**.
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
+++
|
||||
title = "Format alerts with templates"
|
||||
title = "Configure alerts in Grafana OnCall"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Jinja"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Format alerts with templates
|
||||
# Configure alerts in Grafana OnCall
|
||||
|
||||
Grafana OnCall works with over one thousand alert monitoring systems. Almost any monitoring system can send alerts using webhooks with JSON payloads.
|
||||
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
+++
|
||||
title = "Use webhooks to send and receive alerts"
|
||||
keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Alertmanager", "Prometheus"]
|
||||
weight = 900
|
||||
+++
|
||||
|
||||
# Use webhooks to receive alerts
|
||||
You can use webhooks to send alerts to Grafana OnCall. You can also use custom templates to format your alerts.
|
||||
|
||||
Follow these links to learn more about using webhooks for OnCall alert notifications:
|
||||
|
||||
{{< section >}}
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
+++
|
||||
title = "Manage alert groups"
|
||||
description = ""
|
||||
keywords = ["Grafana", "oncall", "on-call", "calendar", "incidents", "alert groups"]
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Manage alert groups
|
||||
|
||||
When you create a new alert integration, alerts are sent from the alert monitoring service of that source to Grafana OnCall. When the first alert is sent, the escalation policies you have in place for that integration determine when and where notifications are sent. Alerts will continue to gather until resolved, forming an alert group. For example, if Juan, an administrator, silences a firing alert group, the alerts will continue to collect in that group until the status is **resolved**. Once this occurs, a new alert will begin the next alert group.
|
||||
|
||||
In the **Alert Groups** tab, you can view alert groups by status. Groups are named by the name of the first alert that was fired. When you click on a group, you can view information on all of alerts that have fired, the source of the alerts, and the users assigned in the escalation chain associated with the group. You can also view the timeline of the group, which shows all of the actions associated with the configured escalation policies, and resolution notes.
|
||||
|
||||
Administrators can change the status of individual alert groups, or can select multiple groups to edit at once. Alert group status can be changed in the following ways: `acknowledge`, `resolve`, `unresolve`, `restart`, and `silence`.
|
||||
Loading…
Add table
Reference in a new issue