Merge pull request #1827 from fluent/lynettemiles/sc-136205/update-fluent-bit-docs-pipeline-inputs-systemd

Author: esmerel

pipeline/inputs/systemd.md

@@ -1,45 +1,45 @@
 # Systemd
 
-The _Systemd_ input plugin allows to collect log messages from the Journald daemon on Linux environments.
+The _Systemd_ input plugin lets you collect log messages from the `journald` daemon in Linux environments.
 
-## Configuration Parameters
+## Configuration parameters
 
 The plugin supports the following configuration parameters:
 
 | Key | Description | Default |
 | :--- | :--- | :--- |
-| Path | Optional path to the Systemd journal directory, if not set, the plugin will use default paths to read local-only logs. |  |
-| Max\_Fields | Set a maximum number of fields \(keys\) allowed per record. | 8000 |
-| Max\_Entries | When Fluent Bit starts, the Journal might have a high number of logs in the queue. In order to avoid delays and reduce memory usage, this option allows to specify the maximum number of log entries that can be processed per round. Once the limit is reached, Fluent Bit will continue processing the remaining log entries once Journald performs the notification. | 5000 |
-| Systemd\_Filter | Allows to perform a query over logs that contains a specific Journald key/value pairs, e.g: \_SYSTEMD\_UNIT=UNIT. The Systemd\_Filter option can be specified multiple times in the input section to apply multiple filters as required. |  |
-| Systemd\_Filter\_Type | Define the filter type when _Systemd\_Filter_ is specified multiple times. Allowed values are _And_ and _Or_. With _And_ a record is matched only when all of the _Systemd\_Filter_ have a match. With _Or_ a record is matched when any of the _Systemd\_Filter_ has a match. | Or |
-| Tag | The tag is used to route messages but on Systemd plugin there is an extra functionality: if the tag includes a star/wildcard, it will be expanded with the Systemd Unit file \(`_SYSTEMD_UNIT`, e.g. host.\* => host.UNIT\_NAME\) or `unknown` \(e.g. host.unknown\) if `_SYSTEMD_UNIT` is missing. |  |
-| DB | Specify the absolute path of a database file to keep track of Journald cursor. |  |
-| DB.Sync | Set a default synchronization \(I/O\) method. values: Extra, Full, Normal, Off. This flag affects how the internal SQLite engine do synchronization to disk, for more details about each option please refer to [this section](https://www.sqlite.org/pragma.html#pragma_synchronous). note: this option was introduced on Fluent Bit v1.4.6. | Full |
-| Read\_From\_Tail | Start reading new entries. Skip entries already stored in Journald. | Off |
-| Lowercase | Lowercase the Journald field \(key\). | Off |
-| Strip\_Underscores | Remove the leading underscore of the Journald field \(key\). For example the Journald field _\_PID_ becomes the key _PID_. | Off |
-| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
+| `Path` | Optional path to the Systemd journal directory. If not set, the plugin uses default paths to read local-only logs. | _none_ |
+| `Max_Fields` | Set a maximum number of fields (keys) allowed per record. | `8000` |
+| `Max_Entries` | When Fluent Bit starts, the Journal might have a high number of logs in the queue. To avoid delays and reduce memory usage, use this option to specify the maximum number of log entries that can be processed per round. Once the limit is reached, Fluent Bit will continue processing the remaining log entries once `journald` performs the notification. | `5000` |
+| `Systemd_Filter` | Perform a query over logs that contain specific `journald` key/value pairs. For example, `_SYSTEMD_UNIT=UNIT`. The `Systemd_Filter` option can be specified multiple times in the input section to apply multiple filters. | _none_ |
+| `Systemd_Filter_Type` | Define the filter type when `Systemd_Filter` is specified multiple times. Allowed values:`And`, `Or`. With `And` a record is matched only when all of the `Systemd_Filter` have a match. With `Or` a record is matched when any `Systemd_Filter` has a match. | `Or` |
+| `Tag` | The tag is used to route messages but on Systemd plugin there is an additional capability: if the tag includes a wildcard (`*`), it will be expanded with the Systemd Unit file (`_SYSTEMD_UNIT`, like `host.\* => host.UNIT_NAME`) or `unknown` (`host.unknown`) if `_SYSTEMD_UNIT` is missing. | _none_ |
+| `DB` | Specify the absolute path of a database file to keep track of the `journald` cursor. | _none_ |
+| `DB.Sync` | Set a default synchronization (I/O) method. Values: `Extra`, `Full`, `Normal`, and `Off`. This flag affects how the internal SQLite engine synchronizes to disk. For more details [SQL lite documentation](https://www.sqlite.org/pragma.html#pragma_synchronous). Available in Fluent Bit v1.4.6 and later. | `Full` |
+| `Read_From_Tail` | Start reading new entries. Skip entries already stored in`journald`. | `Off` |
+| `Lowercase` | Lowercase the `journald` field (key). | `Off` |
+| `Strip_Underscores` | Remove the leading underscore of the `journald` field (key). For example, the `journald` field `_PID` becomes the key `PID`. | `Off` |
+| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
 
-## Getting Started
+## Get started
 
-In order to receive Systemd messages, you can run the plugin from the command line or through the configuration file:
+To receive Systemd messages, you can run the plugin from the command line or through the configuration file.
 
-### Command Line
+### Command line
 
-From the command line you can let Fluent Bit listen for _Systemd_ messages with the following options:
+From the command line you can let Fluent Bit listen for Systemd messages with the following options:
 
 ```shell
 $ fluent-bit -i systemd \
              -p systemd_filter=_SYSTEMD_UNIT=docker.service \
              -p tag='host.*' -o stdout
 ```
 
-> In the example above we are collecting all messages coming from the Docker service.
+This example collects all messages coming from the Docker service.
 
-### Configuration File
+### Configuration file
 
-In your main configuration file append the following _Input_ & _Output_ sections:
+In your main configuration file append the following sections:
 
 {% tabs %}
 {% tab title="fluent-bit.yaml" %}
@@ -80,4 +80,4 @@ pipeline:
 ```
 
 {% endtab %}
-{% endtabs %}
+{% endtabs %}