The tap-pagerduty Meltano extractor pulls data from PagerDuty that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-pagerduty are available. This document describes the default goodeggs variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

Using the Command Line Interface #

  1. Add the tap-pagerduty extractor to your project using meltano add : 

    meltano add extractor tap-pagerduty
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline

If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-pagerduty requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

API Token (token) #

A valid Pagerduty REST API key. See https://support.pagerduty.com/docs/api-access-keys.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-pagerduty set token <token>

export TAP_PAGERDUTY_TOKEN=<token>

Email (email) #

A valid email address to be inserted into the From header of the HTTP Request headers. See https://developer.pagerduty.com/docs/ZG9jOjExMDI5NTUw-rest-api-overview#http-request-headers.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-pagerduty set email <email>

export TAP_PAGERDUTY_EMAIL=<email>

Since (since) #

A date to be used as the default since parameter for all API endpoints that support that parameter.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-pagerduty set since YYYY-MM-DDTHH:MM:SSZ

export TAP_PAGERDUTY_SINCE=YYYY-MM-DDTHH:MM:SSZ

Streams (streams) #

An object used to specify more granular configurations for individual streams. Each key under a stream should represent a valid API request parameter for that endpoint. A more fleshed-out configuration file may look similar to the following.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-pagerduty set streams '{...}'

export TAP_PAGERDUTY_STREAMS='{...}'

API Request Limit (limit) #

(Default 100) The API request limit.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-pagerduty set limit 1234

export TAP_PAGERDUTY_LIMIT=1234

Looking for help? #

If you're having trouble getting the tap-pagerduty extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!