https://github.com/codeclimate/codeclimate-connector-pagerduty

Code Climate Connector for PagerDuty
https://github.com/codeclimate/codeclimate-connector-pagerduty

engineering-data-platform velocity

Last synced: 11 months ago
JSON representation

Code Climate Connector for PagerDuty

• Host: GitHub
• URL: https://github.com/codeclimate/codeclimate-connector-pagerduty
• Owner: codeclimate
• License: apache-2.0
• Created: 2020-02-12T22:52:39.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-11-10T16:31:36.000Z (about 4 years ago)
• Last Synced: 2025-01-11T18:18:43.936Z (about 1 year ago)
• Topics: engineering-data-platform, velocity
• Language: TypeScript
• Homepage: https://github.com/codeclimate/platform
• Size: 493 KB
• Stars: 0
• Watchers: 13
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Code Climate Connector: PagerDuty

A connector integration for Code Climate Velocity to collect data from

[PagerDuty](https://pagerduty.com).

## Configuration

Expects configuration of the following schema:

```

{

  "apiToken": "your_v2_api_token" # only needs read-only access

}

```

See [PagerDuty's docs][pd_api_support] for guidance on creating API keys.

[pd_api_support]: https://support.pagerduty.com/docs/generating-api-keys#section-generating-a-general-access-rest-api-key

## Development

Clone this repo, run `yarn install` to install dependencies. `yarn test` will

run unit tests.

## Running the connector locally

To run the connector in an integration environment, the

[`codeclimate-connector-sdk`][sdk] provides a CLI you can use.

First, generate a PagerDuty token, and write a file in this project's directory

called `connector-config.json` with the token:

```json

{

  "apiToken": "YOUR_TOKEN"

}

```

There are several make rules to run different commands easily:

```

make verify-configuration

make discover-streams

make sync-stream

```

[sdk]: https://github.com/codeclimate/codeclimate-connector-sdk

## Development

See [`DEVELOPERS.md`](DEVELOPERS.md)