Skip to content

Commit 7f93491

Browse files
authored
filter: rewrite_tag: improve wording of rewrite_tag record re-emitting (#454)
1 parent db8c6c9 commit 7f93491

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pipeline/filters/rewrite-tag.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `rewrite_tag` filter, allows to re-emit a record under a new Tag. Once a rec
1010

1111
## How it Works
1212

13-
The way it works is defining rules that matches specific record key content against a regular expression, if a match exists, a new record with the defined Tag will be emitted and go through the beginning of the pipeline. Multiple rules can be specified and they are processed in order until one of them matches.
13+
The way it works is defining rules that matches specific record key content against a regular expression, if a match exists, **a new record with the defined Tag will be emitted, entering from the beginning of the pipeline.** Multiple rules can be specified and they are processed in order until one of them matches.
1414

1515
The new Tag to define can be composed by:
1616

@@ -33,7 +33,7 @@ The `rewrite_tag` filter supports the following configuration parameters:
3333

3434
## Rules
3535

36-
A rule aims to define matching criteria and specify how to create a new Tag for a record. You can define one or multiple rules in the same configuration section. The rules have the following format:
36+
A Rule aims to define matching criteria and specify how to create a new Tag for a record. You can define one or multiple Rules in the same configuration section. The Rules have the following format:
3737

3838
```text
3939
$KEY REGEX NEW_TAG KEEP
@@ -79,15 +79,15 @@ If `$name` equals `abc-123` , then the following **placeholders** will be create
7979
* `$1` = "abc"
8080
* `$2` = "123"
8181

82-
If the Regular expression do not matches an incoming record, the rule will be skipped and the next rule \(if any\) will be processed.
82+
If the Regular expression do not matches an incoming record, the Rule will be skipped and the next Rule \(if any\) will be processed.
8383

8484
### New Tag
8585

86-
If a regular expression has matched the value of the defined key in the rule, we are ready to compose a new Tag for that specific record. The tag is a concatenated string that can contain any of the following characters: `a-z`,`A-Z`, `0-9` and `.-,`.
86+
If a regular expression has matched the value of the defined key in the Rule, we are ready to compose a new Tag for that specific record. The tag is a concatenated string that can contain any of the following characters: `a-z`,`A-Z`, `0-9` and `.-,`.
8787

8888
A Tag can take any string value from the matching record, the original tag it self, environment variable or general placeholder.
8989

90-
Consider the following incoming data on the rule:
90+
Consider the following incoming data on the Rule:
9191

9292
* Tag = aa.bb.cc
9393
* Record = `{"name": "abc-123", "ss": {"s1": {"s2": "flb"}}}`
@@ -109,9 +109,9 @@ We make use of placeholders, record content and environment variables.
109109

110110
### Keep
111111

112-
If a rule matches the criteria the filter will emit a copy of the record with the new defined Tag. The property keep takes a boolean value to define if the original record with the old Tag must be preserved and continue in the pipeline or just be discarded.
112+
If a record matches a Rule the filter will emit a copy of the record with the new defined Tag. The property keep takes a boolean value to define if the original record with the old Tag must be preserved and continue in the pipeline or just be discarded.
113113

114-
You can use `true` or `false` to decide the expected behavior. There is no default value and this is a mandatory field in the rule.
114+
You can use `true` or `false` to decide the expected behavior. There is no default value and this is a mandatory field in the Rule.
115115

116116
## Configuration Example
117117

0 commit comments

Comments
 (0)