tap-pagerduty

A Singer tap for extracting data from the Pagerduty REST API v2.

Installation

Since package dependencies tend to conflict between various taps and targets, Singer recommends installing taps and targets into their own isolated virtual environments:

Install Pagerduty Tap

$ make prod-env

Configuration

The tap accepts a JSON-formatted configuration file as arguments. This configuration file has three required fields:

1. token: A valid Pagerduty REST API key.
2. email: A valid email address to be inserted into the From header of the HTTP Request headers
3. since A date to be used as the default since parameter for all API endpoints that support that parameter.

An bare-bones Pagerduty confirguration may file may look like the following:

{
  "token": "foobarfoobar",
  "email": "foo.bar@gmail.com",
  "since": "2019-01-01"
}

Additionally, you may 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:

{
  "token": "foobarfoobar",
  "email": "foo.bar@gmail.com",
  "since": "2019-08-01",
  "streams": {
    "incidents": {
      "since": "last_status_change_at>=2019-08-01",
      "sort_by": "created_at:asc"
    }
  }
}

Streams

The current version of the tap syncs three distinct Streams:

1. Incidents: (Endpoint, Schema)
2. Notifications: (Endpoint, Schema)
3. Services: (Endpoint, Schema)

Discovery

Singer taps describe the data that a stream supports via a Discovery process. You can run the Pagerduty tap in Discovery mode by passing the --discover flag at runtime:

$ ./.venvs/tap-pagerduty/bin/tap-pagerduty --config=config/pagerduty.config.json --discover

The tap will generate a Catalog to stdout. To pass the Catalog to a file instead, simply redirect it to a file:

$ ./.venvs/tap-pagerduty/bin/tap-pagerduty --config=config/pagerduty.config.json --discover > catalog.json

Sync Locally

Running a tap in Sync mode will extract data from the various Streams. In order to run a tap in Sync mode, pass a configuration file and catalog file:

$ ./.venvs/tap-pagerduty/bin/tap-pagerduty --config=config/pagerduty.config.json --catalog=catalog.json

The tap will emit occasional State messages. You can persist State between runs by redirecting State to a file:

$ ./.venvs/tap-pagerduty/bin/tap-pagerduty --config=config/pagerduty.config.json --catalog=catalog.json >> state.json
$ tail -1 state.json > state.json.tmp
$ mv state.json.tmp state.json

To pick up from where the tap left off on subsequent runs, simply supply the State file at runtime:

$ ./.venvs/tap-pagerduty/bin/tap-pagerduty --config=config/pagerduty.config.json --catalog=catalog.json --state=state.json >> state.json
$ tail -1 state.json > state.json.tmp
$ mv state.json.tmp state.json

Sync to Stitch

You can also send the output of the tap to Stitch Data for loading into the data warehouse. To do this, first create a JSON-formatted configuration for Stitch. This configuration file has two required fields:

1. client_id: The ID associated with the Stitch Data account you'll be sending data to.
2. token The token associated with the specific Import API integration within the Stitch Data account.

An example configuration file will look as follows:

{
  "client_id": 1234,
  "token": "foobarfoobar"
}

Once the configuration file is created, simply pipe the output of the tap to the Stitch Data target and supply the target with the newly created configuration file:

$ ./.venvs/tap-pagerduty/bin/tap-pagerduty --config=config/pagerduty.config.json --catalog=catalog.json --state=state.json | ./.venvs/target-stitch/bin/target-stitch --config=config/stitch.config.json >> state.json
$ tail -1 state.json > state.json.tmp
$ mv state.json.tmp state.json

Contributing

Required Tools [Pipenv] (https://docs.pipenv.org/en/latest/) and Direnv

The first step to contributing is getting a copy of the source code, and setting up your environment. First, fork tap-pagerduty on GitHub. Then, cd into the directory where you want your copy of the source code to live and clone the source code enabling direnv:

$ git clone git@github.com:YourGitHubName/tap-pagerduty.git
$ direnv allow

For example, to format your code using isort and flake8 before commiting changes, run the following commands:

$ make isort
$ make flake8

You can also run the entire testing suite before committing using tox:

$ make lint

Finally, you can run your local version of the tap within the virtual environment using a command like the following:

$ tap-pagerduty --config=config/pagerduty.config.json --catalog=catalog.json

There's also a few useful shortcuts avainable in the Makefile take a look!

Once you've confirmed that your changes work and the testing suite passes, feel free to put out a PR!