From 442f4c446a418dbe7433eaa6f4b6920b864bfbef Mon Sep 17 00:00:00 2001 From: David Venable Date: Mon, 21 Aug 2023 08:39:31 -0700 Subject: [PATCH] Documents general sink options (#4759) * Adds general sink options which includes: routes, tags_target_key, include_keys, exclude_keys. Signed-off-by: David Venable * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: David Venable Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../pipelines/pipelines-configuration-options.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/_data-prepper/pipelines/pipelines-configuration-options.md b/_data-prepper/pipelines/pipelines-configuration-options.md index 73f8adad..b0e3862d 100644 --- a/_data-prepper/pipelines/pipelines-configuration-options.md +++ b/_data-prepper/pipelines/pipelines-configuration-options.md @@ -14,4 +14,17 @@ This page provides information about pipeline configuration options in Data Prep Option | Required | Type | Description :--- | :--- | :--- | :--- workers | No | Integer | Essentially the number of application threads. As a starting point for your use case, try setting this value to the number of CPU cores on the machine. Default is 1. -delay | No | Integer | Amount of time in milliseconds workers wait between buffer read attempts. Default is 3,000. \ No newline at end of file +delay | No | Integer | Amount of time in milliseconds workers wait between buffer read attempts. Default is `3000`. + + +## General sink options + +The following options are available for all sinks. + +Option | Required | Type | Description +:--- | :--- |:------------| :--- +routes | No | String list | A list of routes for which this sink applies. If not provided, this sink receives all events. See [conditional routing]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/pipelines#conditional-routing) for more information. +tags_target_key | No | String | When specified, includes event tags in the output of the provided key. +include_keys | No | String list | When specified, provides the keys in this list in the data sent to the sink. +exclude_keys | No | String list | When specified, excludes the keys given from the data sent to the sink. +