Adds documentation for the Data Prepper delay processor. (opensearch-…

…project#7708) Adds documentation for the delay processor. Signed-off-by: David Venable <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>
sandervandegeijn · Jul 30, 2024 · 6ab605a · 6ab605a
1 parent b57f352
commit 6ab605a
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/_data-prepper/pipelines/configuration/processors/delay.md b/_data-prepper/pipelines/configuration/processors/delay.md
@@ -0,0 +1,27 @@
+---
+layout: default
+title: delay
+parent: Processors
+grand_parent: Pipelines
+nav_order: 41
+---
+
+# delay
+
+This processor will add a delay into the processor chain. Typically, you should use this only for testing, experimenting, and debugging.
+
+## Configuration
+
+Option | Required | Type | Description
+:--- | :--- | :--- | :---
+`for` | No | Duration | The duration of time to delay. Defaults to `1s`.
+
+## Usage
+
+The following example shows using the `delay` processor to delay for 2 seconds.
+
+```yaml
+processor:
+  - delay:
+      for: 2s
+```
diff --git a/...onfiguration/processors/delete-entries.md → ...onfiguration/processors/delete_entries.md b/...onfiguration/processors/delete-entries.md → ...onfiguration/processors/delete_entries.md
@@ -3,7 +3,7 @@ layout: default
 title: delete_entries
 parent: Processors
 grand_parent: Pipelines
-nav_order: 41
+nav_order: 43
 ---
 
 # delete_entries

diff --git a/_data-prepper/pipelines/configuration/processors/mutate-event.md b/_data-prepper/pipelines/configuration/processors/mutate-event.md
@@ -13,7 +13,7 @@ Mutate event processors allow you to modify events in Data Prepper. The followin
 * [add_entries]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/add-entries/) allows you to add entries to an event.
 * [convert_entry_type]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/convert_entry_type/) allows you to convert value types in an event.
 * [copy_values]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/copy-values/) allows you to copy values within an event.
-* [delete_entries]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/delete-entries/) allows you to delete entries from an event.
+* [delete_entries]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/delete_entries/) allows you to delete entries from an event.
 * [list_to_map]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/list-to-map) allows you to convert list of objects from an event where each object contains a `key` field into a map of target keys.
 * `map_to_list` allows you to convert a map of objects from an event, where each object contains a `key` field, into a list of target keys.
 * [rename_keys]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/rename-keys/) allows you to rename keys in an event.