From 7e8b71d882b9251d33117c4d06d62ecae09921d0 Mon Sep 17 00:00:00 2001 From: antonio <45235678+tonypowa@users.noreply.github.com> Date: Sat, 11 May 2024 11:00:28 +0200 Subject: [PATCH] alerting: docs - pagerduty (#87604) * alerting: docs - pagerduty * pretty --- .../integrations/pager-duty.md | 64 ++++++++++++++----- 1 file changed, 47 insertions(+), 17 deletions(-) diff --git a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md index 7a55e073424..5ba0bf1789f 100644 --- a/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md +++ b/docs/sources/alerting/configure-notifications/manage-contact-points/integrations/pager-duty.md @@ -19,25 +19,55 @@ weight: 400 # Configure PagerDuty for Alerting -To set up PagerDuty, provide an integration key. +Use the Grafana Alerting - PagerDuty integration to receive notifications in PagerDuty when your alerts are firing. -| Setting | Description | -| --------------- | ------------------------------------------------------ | -| Integration Key | Integration key for PagerDuty | -| Severity | Level for dynamic notifications, default is `critical` | -| Custom Details | Additional details about the event | +## Before you begin -The `CustomDetails` field is an object containing arbitrary key-value pairs. The user-defined details are merged with the ones we use by default. +To set up PagerDuty for integration with Grafana Alerting, you need to create a [PagerDuty](https://www.pagerduty.com/) account. There are several set up steps to perform within PagerDuty before you set up the integration in Grafana Alerting. -Our default values for `CustomDetails` are: +### Create a Service -```go -{ - "firing": `{{ template "__text_alert_list" .Alerts.Firing }}`, - "resolved": `{{ template "__text_alert_list" .Alerts.Resolved }}`, - "num_firing": `{{ .Alerts.Firing | len }}`, - "num_resolved": `{{ .Alerts.Resolved | len }}`, -} -``` +In PagerDuty, a service represents a component, microservice, or infrastructure element that a team oversees, manages, and monitors. -In case of duplicate keys, the user-defined details overwrite the default ones. +1. Refer to [PagerDuty’s services and integrations guide](https://support.pagerduty.com/docs/services-and-integrations#create-a-service). + +1. Follow steps 1 to 5 under **Create a Service**. + +{{< admonition type="note" >}} +In step 5, choose **Create a service without an integration**. +{{< /admonition >}} + +### Obtain a PagerDuty integration key + +1. Once the service is created, click **Integrations** within the Service options. +1. Click **+ Add an integration**. +1. Select **Events API V2**. +1. Click **Add**. +1. Click the drop-down arrow to display the integration details. +1. Copy the **Integration Key**. + +## Procedure + +To create your PagerDuty integration in Grafana Alerting, complete the following steps. + +1. Navigate to **Alerts & IRM** -> **Alerting** -> **Contact points**. +1. Click **+ Add contact point**. +1. Enter a contact point name. + F1. rom the Integration list, select **PagerDuty**. +1. In the **Integration Key** field, copy in your integration key. +1. Click **Test** to check that your integration works. + + An incident should display in the Service’s Activity tab in PagerDuty. + +1. Click **Save contact point**. + +## Next steps + +To add the contact point and integration you created to your default notification policy, complete the following steps. + +1. Navigate to **Alerts & IRM** -> **Alerting** -> **Notification policies**. +1. In the Default policy, click the ellipsis icon (…) and then **Edit**. +1. Change the default policy to the contact point you created. +1. Click **Update default policy**. + +{{< admonition type="note" >}} If you have more than one contact point, add a new notification policy rather than edit the default one, so you can route specific alerts to PagerDuty. {{< /admonition >}}