Skip to content

Commit e4717b4

Browse files
authored
docs: in_systemd: fix defaults, grammar, whitespace (#2358)
- Change boolean defaults from 'off' to 'false' to match source code: lowercase, read_from_tail, strip_underscores - Fix grammar in db.sync description: add comma and 'see the' before link - Remove trailing whitespace after backslash in command-line example Fixes #2357 Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent fae8394 commit e4717b4

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

pipeline/inputs/systemd.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The plugin supports the following configuration parameters:
99
| Key | Description | Default |
1010
|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
1111
| `db` | Specify the absolute path of a database file to keep track of the `journald` cursor. | _none_ |
12-
| `db.sync` | Set a default synchronization (I/O) method. Possible values: `extra`, `full`, `normal`, and `off`. This flag affects how the internal SQLite engine synchronizes to disk. For more details [SQLite documentation](https://www.sqlite.org/pragma.html#pragma_synchronous). Available in Fluent Bit v1.4.6 and later. | `full` |
13-
| `lowercase` | Lowercase the `journald` field (key). | `off` |
12+
| `db.sync` | Set a default synchronization (I/O) method. Possible values: `extra`, `full`, `normal`, and `off`. This flag affects how the internal SQLite engine synchronizes to disk. For more details, see the [SQLite documentation](https://www.sqlite.org/pragma.html#pragma_synchronous). Available in Fluent Bit v1.4.6 and later. | `full` |
13+
| `lowercase` | Lowercase the `journald` field (key). | `false` |
1414
| `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` |
1515
| `max_fields` | Set a maximum number of fields (keys) allowed per record. | `8000` |
1616
| `path` | Optional path to the Systemd journal directory. If not set, the plugin uses default paths to read local-only logs. | _none_ |
17-
| `read_from_tail` | Start reading new entries. Skip entries already stored in `journald`. | `off` |
18-
| `strip_underscores` | Remove the leading underscore of the `journald` field (key). For example, the `journald` field `_PID` becomes the key `PID`. | `off` |
17+
| `read_from_tail` | Start reading new entries. Skip entries already stored in `journald`. | `false` |
18+
| `strip_underscores` | Remove the leading underscore of the `journald` field (key). For example, the `journald` field `_PID` becomes the key `PID`. | `false` |
1919
| `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_ |
2020
| `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 `systemd_filter` have a match. With `or` a record is matched when any `systemd_filter` has a match. | `or` |
2121
| `tag` | Fluent Bit uses tags to route messages. For the Systemd input plugin, tags have 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_ |
@@ -32,7 +32,7 @@ From the command line you can let Fluent Bit listen for Systemd messages with th
3232
```shell
3333
fluent-bit -i systemd \
3434
-p systemd_filter=_SYSTEMD_UNIT=docker.service \
35-
-p tag='host.*' \
35+
-p tag='host.*' \
3636
-o stdout
3737
```
3838

0 commit comments

Comments
 (0)