pagerdutyedit

This is a community-maintained plugin!

The PagerDuty output will send notifications based on pre-configured services and 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 on the service’s web page on pagerduty.com. In the default case, the description and event details will be populated by Logstash, using message, timestamp and host data.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

pagerduty {
    service_key => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

description

string

No

"Logstash event for %{host}"

details

hash

No

{"timestamp"=>"%{@timestamp}", "message"=>"%{message}"}

event_type

string, one of ["trigger", "acknowledge", "resolve"]

No

"trigger"

incident_key

string

No

"logstash/%{host}/%{type}"

pdurl

string

No

"https://events.pagerduty.com/generic/2010-04-15/create_event.json"

service_key

string

Yes

workers

number

No

1

Detailsedit

 

codecedit

  • Value type is codec
  • Default value is "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.

descriptionedit

  • Value type is string
  • Default value is "Logstash event for %{host}"

Custom description

detailsedit

  • Value type is hash
  • Default value is {"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.

event_typeedit

  • Value can be any of: trigger, acknowledge, resolve
  • Default value is "trigger"

Event type

incident_keyedit

  • Value type is string
  • Default value is "logstash/%{host}/%{type}"

The service key to use. You’ll need to set this up in PagerDuty beforehand.

pdurledit

  • Value type is string
  • Default value is "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 flexibility should PagerDuty iterate the API and Logstash hasn’t been updated yet.

service_keyedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The PagerDuty Service API Key

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.