pagerduty

Milestone: 1

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.

Synopsis

This is what it might look like in your config file:

output {
  pagerduty {
    codec => ... # codec (optional), default: "plain"
    description => ... # string (optional), default: "Logstash event for %{host}"
    details => ... # hash (optional), default: {"timestamp"=>"%{@timestamp}", "message"=>"%{message}"}
    event_type => ... # string, one of ["trigger", "acknowledge", "resolve"] (optional), default: "trigger"
    incident_key => ... # string (optional), default: "logstash/%{host}/%{type}"
    pdurl => ... # string (optional), default: "https://events.pagerduty.com/generic/2010-04-15/create_event.json"
    service_key => ... # string (required)
    workers => ... # number (optional), default: 1
  }
}

Details

codec

• 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.

description

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

Custom description

details

• 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_type

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

Event type

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

incident_key

• 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.

pdurl

• 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_key (required setting)

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

The PagerDuty Service API Key

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

• 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.

---

This is documentation from lib/logstash/outputs/pagerduty.rb