diff --git a/SUMMARY.md b/SUMMARY.md index ef8902b0a..029713536 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -144,6 +144,7 @@ * [Nightfall](pipeline/filters/nightfall.md) * [Rewrite Tag](pipeline/filters/rewrite-tag.md) * [Standard Output](pipeline/filters/standard-output.md) + * [Sysinfo](pipeline/filters/sysinfo.md) * [Throttle](pipeline/filters/throttle.md) * [Tensorflow](pipeline/filters/tensorflow.md) * [Wasm](pipeline/filters/wasm.md) diff --git a/installation/sources/build-and-install.md b/installation/sources/build-and-install.md index 17ffa83f3..46ad0b1f0 100644 --- a/installation/sources/build-and-install.md +++ b/installation/sources/build-and-install.md @@ -171,6 +171,7 @@ The _filter plugins_ allows to modify, enrich or drop records. The following tab | [FLB\_FILTER\_RECORD\_MODIFIER](../../pipeline/filters/record-modifier.md) | Enable Record Modifier filter | On | | [FLB\_FILTER\_REWRITE\_TAG](../../pipeline/filters/rewrite-tag.md) | Enable Rewrite Tag filter | On | | [FLB\_FILTER\_STDOUT](../../pipeline/filters/standard-output.md) | Enable Stdout filter | On | +| [FLB\_FILTER\_SYSINFO](../../pipeline/filters/sysinfo.md) | Enable Sysinfo filter | On | | [FLB\_FILTER\_THROTTLE](../../pipeline/filters/throttle.md) | Enable Throttle filter | On | | [FLB\_FILTER\_WASM](../../pipeline/filters/wasm.md) | Enable WASM filter | On | diff --git a/pipeline/filters/sysinfo.md b/pipeline/filters/sysinfo.md new file mode 100644 index 000000000..45936ac1b --- /dev/null +++ b/pipeline/filters/sysinfo.md @@ -0,0 +1,50 @@ +# Sysinfo + +The _Sysinfo Filter_ plugin allows to append system information like fluent-bit version or hostname. + +## Configuration Prameters + +The plugin supports the following configuration parameters: + +|Key|Description|Supported platform| +|---|---|---| +|fluentbit_version_key|Specify the key name for fluent-bit version.| All | +|os_name_key|Specify the key name for os name. e.g. linux, win64 or macos.| All | +|hostname_key|Specify the key name for hostname.| All| +|os_version_key|Specify the key name for os version. It is not supported on some platforms. | Linux | +|kernel_version_key|Specify the key name for kernel version. It is not supported on some platforms.| Linux | + +Some properties are supported by specific platform. + +## Getting Started + +In order to start filtering records, you can run the filter from the command line or through the configuration file. + +The following configuration file is to append fluent-bit version and OS name. + +``` +[INPUT] + Name dummy + Tag test + +[FILTER] + Name sysinfo + Match * + Fluentbit_version_key flb_ver + Os_name_key os_name + +[OUTPUT] + name stdout + match * +``` + +You can also run the filter from command line. + +``` +fluent-bit -i dummy -o stdout -F sysinfo -m '*' -p fluentbit_version_key=flb_ver -p os_name_key=os_name +``` + +The output will be +``` +[0] dummy.0: [[1699172858.989654355, {}], {"message"=>"dummy", "flb_ver"=>"2.2.0", "os_name"=>"linux"}] +``` \ No newline at end of file