« Couchdb_changes input plugin Elastic Agent input plugin »

› ›

Dead_letter_queue input plugin

edit

Dead_letter_queue input plugin

edit

Plugin version: v2.0.1
Released on: 2024-09-04
Changelog

For other versions, see the Versioned plugin docs.

Getting help

edit

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.

Description

edit

Logstash input to read events from Logstash’s dead letter queue.

input {
  dead_letter_queue {
    path => "/var/logstash/data/dead_letter_queue"
    start_timestamp => "2017-04-04T23:40:37"
  }
}

For more information about processing events in the dead letter queue, see Dead Letter Queues.

Dead_letter_queue Input Configuration Options

edit

This plugin supports the following configuration options plus the Common options described later.

Setting	Input type	Required
`clean_consumed`	boolean	No
`commit_offsets`	boolean	No
`path`	a valid filesystem path	Yes
`pipeline_id`	string	No
`sincedb_path`	string	No
`start_timestamp`	string	No

Also see Common options for a list of options supported by all input plugins.

`clean_consumed`

edit

Value type is boolean
Default value is false

When set to true, this option deletes the DLQ segments that have been read. This feature requires that commit_offsets is set to true. If not, you’ll get a configuration error. This feature is available in Logstash 8.4.0 and later. If this setting is true and and you are using a Logstash version older than 8.4.0, then you’ll get a configuration error.

`commit_offsets`

edit

Value type is boolean
Default value is true

Specifies whether this input should commit offsets as it processes the events. Typically you specify false when you want to iterate multiple times over the events in the dead letter queue, but don’t want to save state. This is when you are exploring the events in the dead letter queue.

`path`

edit

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

Path to the dead letter queue directory that was created by a Logstash instance. This is the path from which "dead" events are read and is typically configured in the original Logstash instance with the setting path.dead_letter_queue.

`pipeline_id`

edit

Value type is string
Default value is "main"

ID of the pipeline whose events you want to read from.

`sincedb_path`

edit

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

Path of the sincedb database file (keeps track of the current position of dead letter queue) that will be written to disk. The default will write sincedb files to <path.data>/plugins/inputs/dead_letter_queue.

This value must be a file path and not a directory path.

`start_timestamp`

edit

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

Timestamp in ISO8601 format from when you want to start processing the events from. For example, 2017-04-04T23:40:37.

Common options

edit

These configuration options are supported by all input plugins:

Setting	Input type	Required
`add_field`	hash	No
`codec`	codec	No
`enable_metric`	boolean	No
`id`	string	No
`tags`	array	No
`type`	string	No

`add_field`

edit

Value type is hash
Default value is {}

Add a field to an event

`codec`

edit

Value type is codec
Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

`enable_metric`

edit

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.

`id`

edit

Value type is 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 dead_letter_queue inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {
  dead_letter_queue {
    id => "my_plugin_id"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

`tags`

edit

Value type is array
There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

`type`

edit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

« Couchdb_changes input plugin Elastic Agent input plugin »