Send data to PagerDuty

Most recent version: v1.0.0

See the changelog of the PagerDuty Data sink type here.

Overview

Onum supports integration with PagerDuty.

PagerDuty is a digital operations platform that helps teams manage and respond to critical incidents. It provides features like on-call scheduling, incident tracking, automated escalations, and integrations with various monitoring and alerting systems.

Prerequisites

You must create an Events API V2 Integration on the Service. This action generates a unique, 32-character Integration Key (Routing Key). This key is the essential credential for this sink.

Onum Setup

1

Log in to your Onum tenant and click Data Sinks> New Data sink.

2

Double-click the PagerDuty Sink.

3

Enter a Name for the new Data Sink. Optionally, add a Description and some Tags to identify the Sink.

4

Decide whether or not to include this Data sink info in the metrics and graphs of the Home area.

5

The Routing Key* is the Integration Key. Create a secret with this value or select one from your Secrets.

Follow these steps to create a new routing key:

1. Log in to your PagerDuty account.

2. Go to the Services tab and select Create a Service.

3. Assign your Escalation Policy. For a heavier workload, we recommend the Events API to process Onum events and create new alerts/incidents, or update any that exist.

4. Create your Service.

5. Once the Service is created, you will be provided with an Integration Key. Copy this key for later.

6

Click New secret to create a new one:

• Give the secret a Name.

• Turn off the Expiration date option.

• Click Add new value and paste the corresponding value.

• Click Save.

Learn more about secrets in Onum in this article.

You can now select the created secrets in the configuration.

7

Establish a limit for the Maximum requests per second*. The minimum value is 1 and the maximum value is 100.

8

If you are using a proxy to establish the connection, toggle on the Proxy configuration button and enter the details here:

• Scheme*

• Host*

• Port*

• Username

• Password

Click Finish when complete. Your new Data sink will appear in the Data sinks area list.

Pipeline configuration

When it comes to using this Data sink in a Pipeline, you must configure the following output parameters. To do it, simply click the Data sink on the canvas and select Configuration.

Output configuration

Parameter	Description
Event action*	Choose the input field from where to get the required action. The field values must be trigger, acknowledge or resolve.

Deduplication key

Parameter	Description
Deduplication key*	Choose the input field that contains the deduplication key.

Payload

Parameter	Description
Summary*	Choose the field that contains the alert description.
Source*	Choose the field that contains the unique location of the affected system, preferably a hostname or FQDN.
Severity*	Choose the field that contains the alert severity. The field values must be critical, error, warning or info.

Advanced payload configuration

Parameter	Description
Date	Choose the field that contains the date on which the event was generated. Supported format is YYYY-MM-DD HH:MM:SS
Component	Choose the field that contains the component of the source machine that is responsible, for example mysql or eth0
Group	Choose the field that contains the logical grouping of components of the service, for example app-stack
Class	Choose the field that contains the class/type of the event, for example ping failure or cpu load
Client	Choose the field that contains the name of the monitoring client that is triggering this event. This field is only used for triggering events.
ClientURL	Choose the field that contains the URL of the monitoring client that is triggering this event. This field is only used for triggering events.
Details	Choose the field that contains additional details about the event and affected system.
Links	Toggle the Links switch if you want to allow sending links and enter the following information: href* - Choose the field that contains the required href attributes, that is, the URLs to be sent. text - Optionally, choose the field that contains the text attributes, that is, the visible text to be displayed.
Images	Toggle the Images switch if you want to allow sending images and enter the following information: src* - Choose the field that contains the required src attributes, that is, the image source URLs to be sent. href - Optionally, choose the field that contains the href attributes, that is, the destination URLs. alt - Choose the field that contains the required alt attributes, that is, the alternative text for images shown if the image doesn't load.

Click Save to complete the process.