Note: This project is currently in beta, for the current Python-based agent see: https://github.com/PagerDuty/pdagent
An agent daemon to aid in creating PagerDuty events.
Goals of this project include providing:
- A command-line interface for creating PagerDuty events.
- A local entry point for PagerDuty's Events API.
- Ensuring that events are properly ordered for each integration.
- Handling back pressure or when PagerDuty is inaccessible.
If you're looking for a more comprehensive PagerDuty API Go client library and CLI, see: https://github.com/PagerDuty/go-pagerduty
Binaries for our officially supported platforms can be found on the releases page.
On first run we recommend running pdagent init to generate a default config file. By default this file will live in ~/.pdagent along with any other artifacts.
Once the config has been created, to start the daemon:
pdagent server
There are a number of other commands available that are listed as part of the command's help command:
pdagent help
Perhaps the most common command, sending events:
pdagent enqueue \
-k your_key_goes_here \
-t trigger \
-d "This is only a test" \
-u "http://pagerduty.com" \
-e "error" \
-f some_field=some_value
At a high level, the agent has three key components:
- Server: The daemon itself where most of the heavy lifting occurs.
- Client: An HTTP client to simplify making requests against the server.
- CLI: A command line tool for working with both the server and client commands.
Looking to contribute? See development for some helpful tips.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
This project includes third-party software components with different licenses. See THIRD-PARTY-LICENSES.md for complete attribution.