# PagerDuty

Category: Platforms
|
Runtime: 2.1+
|
Available: Free

# Overview

PagerDuty node is a client node that connects with the PagerDuty platform for creating incident events.

# Setup

# Prerequisites

For PagerDuty node to work properly, you need to have a valid subscription of PagerDuty account (opens new window). Ensure to have the necessary permission level to create a service (opens new window) in PagerDuty and retrieve the routing key. Routing key is mandatory for connecting and creating the incident in PagerDuty.

# Installation

To install the node from designer:

  1. Go to Add more nodes option on the palette section.
  2. Check for the PagerDuty node and click install.
  3. Once installed, the designer is required to be restarted.

To install the node from CLI:

  1. Go to your project workspace where you can see your package.json file.
  2. Run the below give npm command.
    npm i @kumologica/kumologica-contrib-pagerduty

# Technical Details

Properties

  • RoutingKey (Required)
    32 character integration key. This is generated when creating a service.
  • Dedup Key (Required)
    Key for correlating triggers and resolves. The maximum permitted length of this key is 255 characters. If this property is left empty then PagerDuty will generate a dedup key which will be returned as part of the incident response. User has to persist the dedup key for further updates on the incident. Dedup key is only applicable for an open incident. Refer the following link (opens new window) for more information.
  • Summary (Optional)
    Text summary of the event, used to generate the summaries/titles of any associated alerts. The maximum length allowed is 1024 characters.
  • Source (Optional)
    Unique location of the affected system, preferably a hostname or FQDN.
  • Component (Optional)
    Component of the source machine or system that is responsible for the event, for example mysql or eth0.
  • Group (Optional)
    Logical grouping of components. eg app-stack
  • Event Action (Optional)
    The type of event. Can be trigger, acknowledge or resolve.
  • Additional Details (Optional)
    Additional details about the event and affected system. You can pass the details as JSON content or as a string. The JSON content will be rendered as a table in PagerDuty portal.
  • Class (Optional)
    Class or type of the event, for example ping failure or cpu load.
  • Severity (Optional)
    Supports info, error, warning and critical.
  • Images (Optional)
    List of images to include. The content for this property must be an array object with the following structure. [{"src" : "https://www.sample.com/something.png","href":"https://www.sample.com/something.png","alt": "some alternative text"}]
  • Links (Optional)
    List of links to include. The content for this property must be an array object with the following structure. [{"href":"https://www.sample.com/something.png","text": "some alternative text"}]

Supported Operations

Not Applicable

Throws

PagerDuty node throws the following exception.

  • PagerDutyError

Returns

Payload will not be overwritten by this node. None of the variables will be overwritten or enriched by this node. Response from the node can be accessed using msg.header.pagerduty.

← Puppeteer →