IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Logstash Reference [5.1] ›Output plugins
« opentsdb pipe »

pagerdutyedit

  • Version: 3.0.3
  • Released on: 2016-09-15
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

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}"}

enable_metric

boolean

No

true

event_type

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

No

"trigger"

id

string

No

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

<<,>>

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.

enable_metricedit

  • Value type is boolean
  • Default value is 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 collection for a specific plugin.

event_typeedit

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

Event type

idedit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

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 string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« opentsdb pipe »