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

connect to oncall section updates

Browse source
This commit is contained in:
alyssa wada 2022-06-08 14:10:12 -06:00
parent 67782050a2
commit 0163ca9365
8 changed files with 97 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -45,7 +45,8 @@ 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, refer to Configure Alerts in Grafana OnCall (ADD RELREF)
For more information on alert templates, see [Configure alerts in Grafana OnCall]({{< relref " ../create-custom-templates/" >}})
#### Add Routes
@ -76,13 +77,4 @@ To delete an integration:
{{< section >}}

41
docs/sources/integrations/add-webhook-integration.md
View file

@ -4,25 +4,33 @@ keywords = ["Grafana Cloud", "Alerts", "Notifications", "on-call", "Alertmanager
weight = 700
+++
# Webhook integration for Grafana OnCall
# Configure Webhook integrations 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.
Grafana OnCall directly supports many integrations, those that aren’t currently listed in the Integrations menu can be connected using the webhook integration and configured alert templates.
1. In **Integrations**, click **+ New integration for receiving alerts**.
1. Select a webhook format.
There are two available formats. **Webhook** and **Formatted Webhook**.
* **Webhook** will pull all of the raw JSON information and display it in the manner that it is received.
* **Formatted Webhook** can be used if the body of the alerts sent by your monitoring service are formatted in a way that OnCall can read. The following fields are recognized, but none are required:
* `alert_uid`: a unique alert ID for grouping.
* `title`: a title.
* `image_url`: a URL for an image attached to alert.
* `state`: either `ok` or `alerting`. Helpful for auto-resolving.
* `link_to_upstream_details`: link back to your monitoring system.
* `message`: alert details.
With the webhook integration, you can connect to any alert source that isn't listed in the **Create Integration** page.
To learn how to use custom alert templates for formatted webhooks, see [Configure custom alert templates]({{< relref "../create-custom-templates/" >}}).
There are two available formats, **Webhook** and **Formatted Webhook**.
1. Use the unique webhook URL for requests. For example:
* **Webhook** will pull all of the raw JSON payload and display it in the manner that it's received.
* **Formatted Webhook** can be used if the alert payload sent by your monitoring service is formatted in a way that OnCall recognizes.
The following fields are recognized, but none are required:
* `alert_uid`: a unique alert ID for grouping.
* `title`: a title.
* `image_url`: a URL for an image attached to alert.
* `state`: either `ok` or `alerting`. Helpful for auto-resolving.
* `link_to_upstream_details`: link back to your monitoring system.
* `message`: alert details.
To configure a webhook integration:
1. In the **Integrations** tab, click **+ New integration for receiving alerts**.
2. Select either **Webhook** or **Formatted Webhook** integration.
3. Follow the configuration steps in the **How to connect** section of the integration settings.
4. Use the unique webhook URL to complete any configuration in your monitoring service to send POST requests. Use any http client, e.g. curl to send POST requests with any payload.
For example:
```json
curl -X POST \
@ -37,3 +45,6 @@ Grafana OnCall directly supports integrations from many alert sources, but you c
"message": "Smth happened. Oh no!"
}'
```
To learn how to use custom alert templates for formatted webhooks, see [Configure alerts in Grafana OnCall]({{< relref "../create-custom-templates/" >}}).

12
docs/sources/integrations/available-integrations /_index.md
View file

@ -7,18 +7,10 @@ weight = 100
# Currently available integrations
Grafana OnCall can connect directly to the monitoring services of your alert sources listed in the Grafana OnCall **Integrations** section.
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.
1. Connect to alert source with configured alerts.
In Grafana OnCall, click on the **Integrations** tab and click **+ New integration for receiving alerts**.
The following integrations are currently available for Grafana Cloud OnCall and have documentation:
1. Select an integration from the provided options.
If you want to use an integration that is not listed, you must use webhooks. To learn more about using webhooks see [Integrate with webhooks]({{< relref "/integrations/webhooks/add-webhook-integration/" >}}).
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 >}}

28
docs/sources/integrations/available-integrations /add-alertmanager.md
View file

@ -5,25 +5,25 @@ aliases = ["/docs/grafana-cloud/oncall/available-integrations/add-alertmanager/"
weight = 300
+++
# Connect Alert manager to Grafana OnCall
# Connect AlertManager to Grafana OnCall
The Alertmanager integration handles alerts sent by client applications such as the Prometheus server.
The AlertManager integration for Grafana OnCall handles alerts sent by client applications such as the Prometheus server.
Grafana OnCall provides<!--[grouping](#alertmanager-grouping-amp-oncall-grouping)--> grouping abilities when processing alerts from Alertmanager, including initial deduplicating, grouping, and routing the alerts to Grafana OnCall.
Grafana OnCall provides<!--[grouping](#alertmanager-grouping-amp-oncall-grouping)--> grouping abilities when processing alerts from Alert Manager, including initial deduplicating, grouping, and routing the alerts to Grafana OnCall.
## Connect Alertmanager to Grafana OnCall
## Configure AlertManager integration for Grafana OnCall
You must have an Admin role to connect to Grafana OnCall.
You must have an Admin role to create integrations in Grafana OnCall.
1. Navigate to the **Integrations** tab in Grafana OnCall.
1. In the **Integrations** tab, click **+ New integration for receiving alerts**.
1. Click on the Alertmanager icon.
2. Select **AlertManager** from the list of available integrations.
1. Follow the instructions that display in the dialog box to find a unique integration URL in the monitoring configuration.
3. Follow the instructions in the **How to connect** window to get your unique integration URL and identify next steps.
<!--![123](../_images/connect-new-monitoring.png)-->
## Configure Alertmanager
## Configure AlertManager
Update the `receivers` section of your Alertmanager configuration to use a unique integration URL:
```
@ -38,20 +38,20 @@ receivers:
send_resolved: true
```
## Configure grouping with Alertmanager and Grafana OnCall
## Configure grouping with AlertManager and Grafana OnCall
You can use the grouping mechanics of Alertmanager and Grafana OnCall to configure settings for groups of alert notifications.
You can use the alert grouping mechanics of AlertManager and Grafana OnCall to configure your alert grouping preferences.
Alertmanager offers three grouping settings:
AlertManager offers three alert grouping options:
- `group_by` provides two options, `instance` or `job`.
- `group_wait` sets the length of time to initially wait before sending a notification for a particular group of alerts. For example, `group_wait` can be set to 45s.
Setting a high value for `group_wait` reduces alert noise and minimizes interruption, but it may introduce longer delays in receiving alert notifications. To set an appropriate wait time, consider whether the group of alerts will be the same as those previously sent.
Setting a high value for `group_wait` reduces alert noise and minimizes interruption, but it may introduce delays in receiving alert notifications. To set an appropriate wait time, consider whether the group of alerts will be the same as those previously sent.
- `group_interval` sets the length of time to wait before sending notifications about new alerts that have been added to a group of alerts that have been previously alerted on. This setting is usually set to five minutes or more.
During high alert volume periods, Alertmanager will send alerts at each `group_interval`, which can mean a lot of distraction. Grafana OnCall grouping will help manage this in the following ways:
During high alert volume periods, AlertManager will send alerts at each `group_interval`, which can mean a lot of distraction. Grafana OnCall grouping will help manage this in the following ways:
- Grafana OnCall groups alerts based on the first label of each alert.

52
docs/sources/integrations/available-integrations /add-grafana-alerting.md
View file

@ -7,23 +7,24 @@ weight = 100
# Connect Grafana Alerting to Grafana OnCall
You must have the Admin role assigned to connect to Grafana OnCall.
1. Navigate to the **Integrations** tab in Grafana OnCall.
1. Click on the Grafana logo.
1. Follow the instructions that display in the dialog box to find a unique integration URL in the monitoring configuration.
## Grafana installations
Grafana OnCall can be set up using two methods:
Grafana Alerting for Grafana OnCall can be set up using two methods:
- Grafana Alerting: Grafana OnCall is connected to the same Grafana instance being used to manage Grafana OnCall.
- Grafana (External): Grafana OnCall is connected to one or more Grafana instances separate from the one being used to manage Grafana OnCall.
- Grafana (Other Grafana): Grafana OnCall is connected to one or more Grafana instances separate from the one being used to manage Grafana OnCall.
### Grafana Cloud Alerting
## Configure Grafana Alerting for Grafana OnCall
You must have an Admin role to create integrations in Grafana OnCall.
1. In the **Integrations** tab, click **+ New integration for receiving alerts**.
2. Select **Grafana Alerting** by clicking the **Quick connect** button or select **Grafana (Other Grafana)** from the integrations list.
3. Follow the configuration steps that display in the **How to connect** window to retrieve your unique integration URL and complete any necessary configurations.
### Configure Grafana Cloud Alerting
Use the following method if you are connecting Grafana OnCall with alerts coming from the same Grafana instance from which Grafana OnCall is being managed.
1. In Grafana OnCall, navigate to the **Integrations** tab and select **New Integration for receiving alerts**.
@ -32,29 +33,30 @@ Use the following method if you are connecting Grafana OnCall with alerts coming
>**Note:** You must connect the contact point with a notification policy. For more information, see [Contact points in Grafana Alerting](https://grafana.com/docs/grafana/latest/alerting/unified-alerting/contact-points/)
1. Determine the escalation chain for the new integration by either selecting an existing one or by creating a new chain. For more information on creating escalation chains, see: [Configure alert notifications with Grafana OnCall]({{< relref "../configure-notifications" >}})..
1. Determine the escalation chain for the new integration by either selecting an existing one or by creating a new escalation chain.
1. In Grafana Cloud Alerting, navigate to **Alerting > Contact Points** and find a contact point with a name matching the integration you created in Grafana OnCall.
2. In Grafana Cloud Alerting, navigate to **Alerting > Contact Points** and find a contact point with a name matching the integration you created in Grafana OnCall.
1. Click the **Edit** (pencil) icon, then click **Test**. This will send an alert to Grafana OnCall.
3. Click the **Edit** (pencil) icon, then click **Test**. This will send a test alert to Grafana OnCall.
### Grafana (External)
### Configure Grafana (Other Grafana)
Connect Grafana OnCall with alerts coming from a Grafana instance that is different from the instance that Grafana OnCall is being managed:
Connect Grafana OnCall with alerts coming from an instance of Grafana different from the one on which Grafana OnCall is being managed:
1. In Grafana OnCall, navigate to the **Integrations** tab and select **New Integration for receiving alerts**.
1. Select the **Grafana** tile.
2. Select the **Grafana (Other Grafana)** tile.
1. View and save the URL needed to connect.
3. Follow the configuration steps that display in the **How to connect** window to retrieve your unique integration URL and complete any necessary configurations.
1. Determine the escalation chain for the new integration by either selecting an existing one or by creating a new chain. For more information on creating escalation chains, see: [Configure alert notifications with Grafana OnCall]({{< relref "../configure-notifications/" >}}).
4. Determine the escalation chain for the new integration by either selecting an existing one or by creating a new escalation chain.
1. Go to the other Grafana instance to connect to Grafana OnCall and navigate to **Alerting > Contact Points**.
5. Go to the other Grafana instance to connect to Grafana OnCall and navigate to **Alerting > Contact Points**.
1. Select **New Contact Point**.
6. Select **New Contact Point**.
1. Choose the contact point type `webhook`, then paste the URL generated in step 3 into the URL field.
7. Choose the contact point type `webhook`, then paste the URL generated in step 3 into the URL field.
>**Note:** You must connect the contact point with a notification policy. For more information, see [Contact points in Grafana Alerting](https://grafana.com/docs/grafana/latest/alerting/unified-alerting/contact-points/).
1. Click the **Edit** (pencil) icon, then click **Test**. This will send an alert to Grafana OnCall.
8. Click the **Edit** (pencil) icon, then click **Test**. This will send a test alert to Grafana OnCall.

9
docs/sources/integrations/available-integrations /add-zabbix.md
View file

@ -8,11 +8,14 @@ weight = 500
Zabbix is an open-source monitoring software tool for diverse IT components, including networks, servers, virtual machines, and cloud services. Zabbix provides monitoring for metrics such as network utilization, CPU load, and disk space consumption.
To connect Grafana OnCall with Zabbix using the following procedure, you must have an Admin role assigned.
1. Navigate to the **Integrations** tab in Grafana OnCall.
## Configure Zabbix integration for Grafana OnCall
1. Follow the instructions that display in the dialog box to use a unique integration URL in the monitoring configuration.
You must have an Admin role to create integrations in Grafana OnCall.
1. In the **Integrations** tab, click **+ New integration for receiving alerts**.
2. Select **Zabbix** from the list of available integrations
3. Follow the instructions in the **How to connect** window to get your unique integration URL and review next steps.
<!--![123](../_images/connect-new-monitoring.png)-->

33
docs/sources/integrations/configure-outgoing-webhooks.md
View file

@ -5,27 +5,33 @@ weight = 500
+++
# 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.
Outgoing webhooks allow you to send alert details to a specified URL from Grafana OnCall. Once an outgoing webhook is configured, you can use it as a notification method in escalation chains.
To automatically send alert data to a destination URL via outgoing webhook:
1. In Grafana OnCall, navigate to **Outgoing Webhooks** and click **+ Create**.
This is also the place to edit and delete existing webhooks.
This is also the place to edit and delete existing outgoing webhooks.
1. Name your webhook and enter the destination URL.
2. Provide a name for your outgoing webhook and enter the destination URL.
1. If the destination requires authentication, enter your credentials.
3. If the destination requires authentication, enter your credentials.
You can enter a username and password (HTTP) or an authorization header formatted in JSON.
1. Configure the webhook payload in the **Data** field.
You can use four variables to automate the body of your webhook. The format you use to call the variables must match the structure of how the fields are nested in your alert payload. The **Data** field can use the following four variables to auto-populate the webhook payload with information about the first alert in the alert group:
- `{{ alert_title }}`
- `{{ alert_message }}`
- `{{ alert_url }}`
- `{{ alert_payload }}`
4. Configure the webhook payload in the **Data** field.
5. Click **Create Webhook**.
The format you use to call the variables must match the structure of how the fields are nested in the alert payload. The **Data** field can use the following four variables to auto-populate the webhook payload with information about the first alert in the alert group:
- `{{ alert_title }}`
- `{{ alert_message }}`
- `{{ alert_url }}`
- `{{ alert_payload }}`
<br>
`alert_payload` is always the first level of any variable you want to call.
`alert_payload` is always the first level of any variable you want to call.
The following is an example of an entry in the **Data** field that might return an alert name and description.
The following is an example of an entry in the **Data** field that might return an alert name and description.
```json
{
@ -34,6 +40,5 @@ You can configure outgoing webhooks to send alerts to destination. Once a webhoo
}
```
>**NOTE:** If you get an error message and cannot create a webhook, make sure your JSON is formatted correctly.
>**NOTE:** If you receive an error message and cannot create an outgoing webhook, verify that your JSON is formatted correctly.
1. Click **Create Webhook**.

2
docs/sources/integrations/create-custom-templates.md
View file

@ -6,7 +6,7 @@ weight = 300
# Configure alerts in Grafana OnCall
Grafana OnCall can integrate with any monitoring systems that can send alerts using webhooks with JSON payloads. By default, webhooks deliver raw JSON payloads. When Grafana OnCall receives an alert and parses its payload, a default preconfigured alert template is applied to modify the alert payload to be more human readable. These alert templates are customizable for any integration.
Grafana OnCall can integrate with any monitoring systems that can send alerts using webhooks with JSON payloads. By default, webhooks deliver raw JSON payloads. When Grafana OnCall receives an alert and parses its payload, a default pre configured alert template is applied to modify the alert payload to be more human readable. These alert templates are customizable for any integration.
See Format alerts with alert templates in this document to learn more about how to customize alert templates.