PagerDuty Responder setup guide - snowplow-archive/sauna GitHub Wiki

HOME > GUIDE FOR DEVOPS > SETTING UP SAUNA > RESPONDERS > PagerDuty Responder setup guide

This responder has not yet been released.

See also: PagerDuty Responder user guide

Contents

Overview

This responder lets you send events to the PagerDuty incident management platform. These events can either trigger a new incident, forwarding it to various monitoring tools and ticketing systems, or acknowledge and fix existing incidents.

Compatibility

This responder will be released in Sauna version TBC.

PagerDuty setup

The PagerDuty responder can be used with any "Generic API" integration in PagerDuty. If you don't already have a "Generic API" integration, you should create one:

  • In your account, under the Services tab, click "Add New Service".

  • Select "Use our API Directly" from the Integration Type menu and enter a name for the service.

  • Enter a name for the service and specify its' Escalation Policy, Notification Urgency, and Incident Behaviour.

  • Click the "Add Service" button.

  • Once the service is created, you'll be taken to the Integrations tab for that service. On this page, you'll see an "Integration Key" column - use this key (as a service_key JSON field) within the events you send to Sauna.

Sauna setup

Avro schema

The PagerDuty Responder must be configured using a self-describing Avro which validates against this JSON Schema:

iglu:com.snowplowanalytics.sauna.responders/PagerDutyConfig/avro/1-0-0

Example

The responder can be enabled by placing the following Avro config in the configuration directory (in an .avro or .json file):

{
    "schema": "iglu:com.snowplowanalytics.sauna.responders/PagerDutyConfig/avro/1-0-0",

    "data": {
        "enabled": true,
        "id": "com.acme.PagerDutyResponder",
        "parameters": {
            "createEventEnabled": true
        }
    }
}
⚠️ **GitHub.com Fallback** ⚠️