Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Backport 2.15] Adds documentation for the Data Prepper delay processor. #7783

Merged
merged 1 commit into from
Jul 19, 2024
Merged

[Backport 2.15] Adds documentation for the Data Prepper delay processor. #7783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions _data-prepper/pipelines/configuration/processors/delay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: default
title: delay
parent: Processors
grand_parent: Pipelines
nav_order: 41
---

# delay

Check failure on line 9 in _data-prepper/pipelines/configuration/processors/delay.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _data-prepper/pipelines/configuration/processors/delay.md#L9 

[OpenSearch.HeadingCapitalization] 'delay' is a heading and should be in sentence case.
Raw output 
{"message": "[OpenSearch.HeadingCapitalization] 'delay' is a heading and should be in sentence case.", "location": {"path": "_data-prepper/pipelines/configuration/processors/delay.md", "range": {"start": {"line": 9, "column": 3}}}, "severity": "ERROR"}

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
```
2 changes: 1 addition & 1 deletion ...onfiguration/processors/delete-entries.md → ...onfiguration/processors/delete_entries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: delete_entries
parent: Processors
grand_parent: Pipelines
nav_order: 41
nav_order: 43
---

# delete_entries
Expand Down
2 changes: 1 addition & 1 deletion _data-prepper/pipelines/configuration/processors/mutate-event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading