For other versions, see theVersioned plugin docs.
For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-pagerduty
. See Working with plugins for more details.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
The PagerDuty output will send notifications based on pre-configured servicesand escalation policies. Logstash can send "trigger", "acknowledge" and "resolve"event types. In addition, you may configure custom descriptions and event details.The only required field is the PagerDuty "Service API Key", which can be found onthe service’s web page on pagerduty.com. In the default case, the description andevent details will be populated by Logstash, using message
, timestamp
and host
data.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
||
Yes |
Also see Common Options for a list of options supported by alloutput plugins.
{"timestamp"=>"%{@timestamp}", "message"=>"%{message}"}
The event details. These might be data from the Logstash event fields you wish to include.Tags are automatically included if detected so there is no need to explicitly add them here.
"logstash/%{host}/%{type}"
The service key to use. You’ll need to set this up in PagerDuty beforehand.
"https://events.pagerduty.com/generic/2010-04-15/create_event.json"
PagerDuty API URL. You shouldn’t need to change this, but is included to allow for flexibilityshould PagerDuty iterate the API and Logstash hasn’t been updated yet.
The PagerDuty Service API Key
The following configuration options are supported by all output plugins:
"plain"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.
true
Disable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type. For example, if you have 2 pagerduty outputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { pagerduty { id => "my_plugin_id" }}