For other versions, see theVersioned plugin docs.
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.
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.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
a valid filesystem path |
Yes |
|
No |
||
No |
||
No |
Also see Common Options for a list of options supported by allinput plugins.
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 theevents in the dead letter queue, but don’t want to save state. This is when youare exploring the events in the dead letter queue.
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 configuredin the original Logstash instance with the setting path.dead_letter_queue
.
"main"
ID of the pipeline whose events you want to read from.
Path of the sincedb database file (keeps track of the current position of dead letter queue) thatwill 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.
Timestamp in ISO8601 format from when you want to start processing the events from.For example, 2017-04-04T23:40:37
.
The following configuration options are supported by all input plugins:
"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.
true
Disable or enable metric logging for this specific plugin instanceby default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
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 usefulwhen 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" }}
Add any number of arbitrary tags to your event.
This can help with processing later.
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 canalso use the type to search for it in Kibana.
If you try to set a type on an event that already has one (forexample when you send an event from a shipper to an indexer) thena new input will not override the existing type. A type set atthe shipper stays with that event for its life evenwhen sent to another Logstash server.