PagerDuty

Most recent version: v1.0.0

See the changelog of this 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.

Select PagerDuty from the list of Data sink types and click Configuration to start.

Data sink configuration

Now you need to specify how and where to send the data, and how to establish a connection with PagerDuty.

Metadata

Enter the basic information for the new Data sink.

Parameters
Description

Name*

Enter a name for the new Data sink.

Description

Optionally, enter a description for the Data sink.

Tags

Add tags to easily identify your Data sink. Hit the Enter key after you define each tag.


Metrics

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


Configuration

Now, add the configuration to establish the connection.

Parameter
Description

Routing Key*

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

Rate limit per second

Parameter
Description

Maximum requests per second*

Establish a limit for the amount of requests permitted per second. The minimum value is 1 and the maximum value is 100.

Advanced configuration

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

Parameter
Description

Scheme*

Choose the scheme to connect to.

Host*

The host of the proxy URL used to establish the connection.

Port*

The port of the proxy URL used to establish the connection.

Username

This is the username used to access the proxy.

Password

Enter the proxy passcode.

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.

Last updated

Was this helpful?