Merge pull request #1699 from fluent/lynettemiles/sc-136161/update-fluent-bit-docs-pipeline-filters-sysinfo

Author: esmerel

pipeline/filters/sysinfo.md

@@ -1,30 +1,31 @@
 # Sysinfo
 
-The _Sysinfo Filter_ plugin allows to append system information like fluent-bit version or hostname.
+The _Sysinfo_ filter lets you append system information like the Fluent Bit version or hostname.
 
-## Configuration Prameters
+## Configuration parameters
 
 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 |
+| Key | Description | Supported platform |
+| --- | --- | --- |
+| `fluentbit_version_key` | Specify the key name for the Fluent Bit version.| All |
+| `os_name_key` | Specify the key name for operating system name. For example, `Linux`, `win64` or `macos`.| All |
+| `hostname_key`| Specify the key name for hostname. | All |
+| `os_version_key` | Specify the key name for the operating system version. Not supported on some platforms. | Linux |
+| `kernel_version_key` | Specify the key name for kernel version. Not supported on some platforms.| Linux |
 
-Some properties are supported by specific platform.
+Some properties are supported by specific platforms.
 
-## Getting Started
+## Get started
 
-In order to start filtering records, you can run the filter from the command line or through the configuration file.
+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.
+The following configuration file is to append the Fluent Bit version and operating system name.
 
 {% tabs %}
 {% tab title="fluent-bit.conf" %}
-```
+
+```python
 [INPUT]
     Name dummy
     Tag test
@@ -39,9 +40,11 @@ The following configuration file is to append fluent-bit version and OS name.
     name stdout
     match *
 ```
+
 {% endtab %}
 
 {% tab title="fluent-bit.yaml" %}
+
 ```yaml
 pipeline:
     inputs:
@@ -56,17 +59,18 @@ pipeline:
         - name: stdout
           match: '*'
 ```
+
 {% endtab %}
 {% endtabs %}
 
-
 You can also run the filter from command line.
 
-```
+```shell
 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 
-```
+The output will be something like the following:
+
+```text
 [0] dummy.0: [[1699172858.989654355, {}], {"message"=>"dummy", "flb_ver"=>"2.2.0", "os_name"=>"linux"}]
-```
+```

vale-styles/FluentBit/Spelling-exceptions.txt

@@ -169,6 +169,7 @@ subcommands
 subquery
 subrecord
 substring
+sysinfo
 syslog
 systemctl
 systemd