Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872. #1873

eschabell · 2025-07-07T16:04:11Z

Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872.

Updated the following:

Signed-off-by: Eric D. Schabell <[email protected]>

. Signed-off-by: Eric D. Schabell <[email protected]>

Signed-off-by: Eric D. Schabell <[email protected]>

. Signed-off-by: Eric D. Schabell <[email protected]>

Signed-off-by: Eric D. Schabell <[email protected]>

#1872. Signed-off-by: Eric D. Schabell <[email protected]>

esmerel

Stylistic suggestions mostly but otherwise this covers a lot of good updates.

esmerel · 2025-07-07T16:35:49Z

pipeline/filters/aws-metadata.md


 ```shell
-bin/fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf
+$ ./fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf


Suggested change

$ ./fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf

fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf

We don't put the prompt in commands - it prevents a direct copy & paste, and markdownlint errors.

esmerel · 2025-07-07T16:38:00Z

pipeline/filters/ecs-metadata.md

+Below configurations assume a properly configured parsers file and 'storage.path' variable defined in the services
+section of the fluent bit configuration (not shown below).


Suggested change

Below configurations assume a properly configured parsers file and 'storage.path' variable defined in the services

section of the fluent bit configuration (not shown below).

The following configurations assume a properly configured parsers file and `storage.path` variable defined in the services section of the Fluent Bit configuration (not shown).

We try not to use positional language, and we can't use line wraps because gitbook renders them and it makes the pages look bad.

esmerel · 2025-07-07T16:40:06Z

pipeline/filters/ecs-metadata.md

 #### Example 3: Attach cluster metadata to non-container logs

-This examples shows a use case for the `Cluster_Metadata_Only` option- attaching cluster metadata to ECS Agent logs.
+This examples shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.


Suggested change

This examples shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.

This example shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.

esmerel · 2025-07-07T16:41:53Z

pipeline/filters/record-modifier.md

+You can run the filter from command line:

+```shell
+$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'


Suggested change

$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'

fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'

esmerel · 2025-07-07T16:42:10Z

pipeline/filters/record-modifier.md

+You can also run the filter from command line.
+
+```shell
+$ ./fluent-bit -i mem -o stdout -F  record_modifier -p 'Remove_key=Swap.total' -p 'Remove_key=Swap.free' -p 'Remove_key=Swap.used' -m '*'


Suggested change

$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Remove_key=Swap.total' -p 'Remove_key=Swap.free' -p 'Remove_key=Swap.used' -m '*'

fluent-bit -i mem -o stdout -F record_modifier -p 'Remove_key=Swap.total' -p 'Remove_key=Swap.free' -p 'Remove_key=Swap.used' -m '*'

esmerel · 2025-07-07T16:42:23Z

pipeline/filters/record-modifier.md

-```shell copy
-fluent-bit -i mem -o stdout -F record_modifier -p 'Allowlist_key=Mem.total' -p 'Allowlist_key=Mem.free' -p 'Allowlist_key=Mem.used' -m '*'
+```shell
+$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Allowlist_key=Mem.total' -p 'Allowlist_key=Mem.free' -p 'Allowlist_key=Mem.used' -m '*'


Suggested change

$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Allowlist_key=Mem.total' -p 'Allowlist_key=Mem.free' -p 'Allowlist_key=Mem.used' -m '*'

fluent-bit -i mem -o stdout -F record_modifier -p 'Allowlist_key=Mem.total' -p 'Allowlist_key=Mem.free' -p 'Allowlist_key=Mem.used' -m '*'

esmerel · 2025-07-07T16:43:38Z

pipeline/filters/tensorflow.md

   The script creates the shared library
   `bazel-bin/tensorflow/lite/c/libtensorflowlite_c.so`.
-1. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.
+4. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.


Suggested change

4. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.

1. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.

Markdown increments numbers on its own. We do not increment numbers.

esmerel · 2025-07-07T16:44:00Z

pipeline/filters/tensorflow.md

-```bash
-cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...
+```shell
+$ ./cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...


Suggested change

$ ./cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...

cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...

esmerel · 2025-07-07T16:44:12Z

pipeline/filters/tensorflow.md

-```bash
-bin/fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p
+```shell
+$ ./fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p


Suggested change

$ ./fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p

fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p

…lf of filters in list. Fixes fluent#1872. (fluent#1873) * Adding YAML examples for aws metadata filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for ecs metadata filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for geoip2 filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for kubernetes filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for lua filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for record modifier filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for nightfall filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for standard output filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for throttle filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for tensorflow filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> * Adding YAML examples for multiline stacktrace filter doc. Part of issue fluent#1872. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]> Signed-off-by: Tom <[email protected]>

eschabell added 11 commits July 7, 2025 16:03

Adding YAML examples for aws metadata filter doc. Part of issue #1872.

f5931f0

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for ecs metadata filter doc. Part of issue #1872.

4c8c419

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for geoip2 filter doc. Part of issue #1872.

b46e8d6

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for kubernetes filter doc. Part of issue #1872.

f8667d4

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for lua filter doc. Part of issue #1872.

fd50e80

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for record modifier filter doc. Part of issue #1872

f6c3e5f

. Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for nightfall filter doc. Part of issue #1872.

5095879

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for standard output filter doc. Part of issue #1872

6c0233d

. Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for throttle filter doc. Part of issue #1872.

68fdca3

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for tensorflow filter doc. Part of issue #1872.

574522f

Signed-off-by: Eric D. Schabell <[email protected]>

Adding YAML examples for multiline stacktrace filter doc. Part of issue

d3208e5

#1872. Signed-off-by: Eric D. Schabell <[email protected]>

eschabell requested review from a team as code owners July 7, 2025 16:04

patrick-stephens approved these changes Jul 7, 2025

View reviewed changes

patrick-stephens merged commit bbed530 into fluent:master Jul 7, 2025
5 checks passed

esmerel approved these changes Jul 7, 2025

View reviewed changes

esmerel mentioned this pull request Jul 7, 2025

Revert "Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872." #1875

Merged

eschabell deleted the erics-filters-yaml-updates branch July 8, 2025 09:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872. #1873

Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872. #1873

Uh oh!

eschabell commented Jul 7, 2025

Uh oh!

Uh oh!

esmerel left a comment

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

esmerel Jul 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	$ ./fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf
	fluent-bit -c /PATH_TO_CONF_FILE/fluent-bit.conf

		Below configurations assume a properly configured parsers file and 'storage.path' variable defined in the services
		section of the fluent bit configuration (not shown below).

	Below configurations assume a properly configured parsers file and 'storage.path' variable defined in the services
	section of the fluent bit configuration (not shown below).
	The following configurations assume a properly configured parsers file and `storage.path` variable defined in the services section of the Fluent Bit configuration (not shown).

	This examples shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.
	This example shows a use case for the `Cluster_Metadata_Only` option attaching cluster metadata to ECS Agent logs.

	$ ./fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'
	fluent-bit -i mem -o stdout -F record_modifier -p 'Record=hostname ${HOSTNAME}' -p 'Record=product Awesome_Tool' -m '*'

	4. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.
	1. Copy the library to a location such as `/usr/lib` that can be used by Fluent Bit.

	$ ./cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...
	cmake -DFLB_FILTER_TENSORFLOW=On -DTensorflow_DIR=<AddressOfTensorflowSourceCode> ...

	$ ./fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p
	fluent-bit -i mqtt -p 'tag=mqtt.data' -F tensorflow -m '*' -p 'input_field=image' -p 'model_file=/home/user/model.tflite' -p

Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872. #1873

Update the filter docs with YAML configuration examples, the first half of filters in list. Fixes #1872. #1873

Uh oh!

Conversation

eschabell commented Jul 7, 2025

Uh oh!

Uh oh!

esmerel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants