---
title: Pagerduty output plugin
description: Plugin version: v3.0.9 (Other versions), Released on: 2020-01-27, Changelog. For questions about the plugin, open a topic in the Discuss forums. For bugs...
url: https://www.elastic.co/docs/reference/logstash/plugins/plugins-outputs-pagerduty
products:
  - Logstash
applies_to:
  - Elastic Stack: Generally available
---

# Pagerduty output plugin
- Plugin version: v3.0.9 ([Other versions](https://www.elastic.co/docs/reference/logstash/versioned-plugins/output-pagerduty-index))
- Released on: 2020-01-27
- [Changelog](https://github.com/logstash-plugins/logstash-output-pagerduty/blob/v3.0.9/CHANGELOG.md)


## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-pagerduty). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

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.

## Pagerduty Output Configuration Options

This plugin supports the following configuration options plus the [Common options](#plugins-outputs-pagerduty-common-options) described later.

| Setting                                                   | Input type                                                                                                    | Required |
|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|----------|
| [`description`](#plugins-outputs-pagerduty-description)   | [string](/docs/reference/logstash/plugins/value-types#string)                                                 | No       |
| [`details`](#plugins-outputs-pagerduty-details)           | [hash](/docs/reference/logstash/plugins/value-types#hash)                                                     | No       |
| [`event_type`](#plugins-outputs-pagerduty-event_type)     | [string](/docs/reference/logstash/plugins/value-types#string), one of `["trigger", "acknowledge", "resolve"]` | No       |
| [`incident_key`](#plugins-outputs-pagerduty-incident_key) | [string](/docs/reference/logstash/plugins/value-types#string)                                                 | No       |
| [`pdurl`](#plugins-outputs-pagerduty-pdurl)               | [string](/docs/reference/logstash/plugins/value-types#string)                                                 | No       |
| [`service_key`](#plugins-outputs-pagerduty-service_key)   | [string](/docs/reference/logstash/plugins/value-types#string)                                                 | Yes      |

Also see [Common options](#plugins-outputs-pagerduty-common-options) for a list of options supported by all output plugins.

### `description`

- Value type is [string](/docs/reference/logstash/plugins/value-types#string)
- Default value is `"Logstash event for %{host}"`

Custom description

### `details`

- Value type is [hash](/docs/reference/logstash/plugins/value-types#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

### `incident_key`

- Value type is [string](/docs/reference/logstash/plugins/value-types#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](/docs/reference/logstash/plugins/value-types#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`

- This is a required setting.
- Value type is [string](/docs/reference/logstash/plugins/value-types#string)
- There is no default value for this setting.

The PagerDuty Service API Key

## Common options

These configuration options are supported by all output plugins:

| Setting                                                     | Input type                                                      | Required |
|-------------------------------------------------------------|-----------------------------------------------------------------|----------|
| [`codec`](#plugins-outputs-pagerduty-codec)                 | [codec](/docs/reference/logstash/plugins/value-types#codec)     | No       |
| [`enable_metric`](#plugins-outputs-pagerduty-enable_metric) | [boolean](/docs/reference/logstash/plugins/value-types#boolean) | No       |
| [`id`](#plugins-outputs-pagerduty-id)                       | [string](/docs/reference/logstash/plugins/value-types#string)   | No       |


### `codec`

- Value type is [codec](/docs/reference/logstash/plugins/value-types#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.

### `enable_metric`

- Value type is [boolean](/docs/reference/logstash/plugins/value-types#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.

### `id`

- Value type is [string](/docs/reference/logstash/plugins/value-types#string)
- There is no default value for this setting.

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 useful when 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"
  }
}
```