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.

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

Adds documentation for the Data Prepper delay processor. #7708

Merged
27 changes: 27 additions & 0 deletions _data-prepper/pipelines/configuration/processors/delay.md
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 / style-job

[vale] reported by reviewdog 🐶 [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"}
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

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
```
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
Loading