From ee2e074232249c706c6151adf05212376c2c4dfe Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Fri, 18 Oct 2024 11:03:36 -0700 Subject: [PATCH] docs: minor corretions Signed-off-by: Lynette Miles --- pipeline/filters/record-modifier.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/pipeline/filters/record-modifier.md b/pipeline/filters/record-modifier.md index 5c448ad4e..220d1b8f3 100644 --- a/pipeline/filters/record-modifier.md +++ b/pipeline/filters/record-modifier.md @@ -1,22 +1,21 @@ # Record Modifier -The _Record Modifier_ filter plugin lets you append fields to a record, or exclude -specific fields. +The _Record Modifier_ [filter](pipeline/filters.md) plugin lets you append +fields to a record, or exclude specific fields. -## Configuration Parameters +## Configuration parameters -The plugin supports the following configuration parameters. `Remove_key` and -`Allowlist_key` are exclusive. +The plugin supports the following configuration parameters: | Key | Description | | :--- | :--- | | `Record` | Append fields. This parameter needs a key/value pair. | -| `Remove_key` | If the key is matched, that field is removed. | -| `Allowlist_key` | If the key isn't matched, that field is removed. | +| `Remove_key` | If the key is matched, that field is removed. You can this or `Allowlist_key`.| +| `Allowlist_key` | If the key isn't matched, that field is removed. You can this or `Remove_key`. | | `Whitelist_key` | An alias of `Allowlist_key` for backwards compatibility. | -| `Uuid_key` | If set, the plugin appends Uuid to each record. The value assigned becomes the key in the map.| +| `Uuid_key` | If set, the plugin appends Uuid to each record. The value assigned becomes the key in the map. | -## Getting Started +## Get started To start filtering records, run the filter from the command line or through a configuration file.