index.asciidoc in logstash-input-dead_letter_queue-2.0.0

- old
+ new

@@ -43,10 +43,11 @@
 This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
 
 [cols="<,<,<",options="header",]
 |=======================================================================
 |Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-clean_consumed>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-commit_offsets>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-path>> |a valid filesystem path|Yes
 | <<plugins-{type}s-{plugin}-pipeline_id>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-sincedb_path>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-start_timestamp>> |<<string,string>>|No
@@ -54,9 +55,19 @@
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
 input plugins.
 
 &nbsp;
+
+[id="plugins-{type}s-{plugin}-clean_consumed"]
+===== `clean_consumed`
+
+  * Value type is <<boolean,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.
 
 [id="plugins-{type}s-{plugin}-commit_offsets"]
 ===== `commit_offsets` 
 
   * Value type is <<boolean,boolean>>
\ No newline at end of file