Skip to content

Updating general layout and case for config options in systemd input plugin docs. Fixes #2214. #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2025
Merged

Updating general layout and case for config options in systemd input plugin docs. Fixes #2214. #2228

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aca86b3
Updating general layout and case for config options in systemd input …
eschabell Nov 27, 2025
5c27fc8
Small wording fix for review suggestion.
eschabell Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions pipeline/inputs/systemd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ The plugin supports the following configuration parameters:

| Key | Description | Default |
|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
| `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` |
| `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 [SQLite documentation](https://www.sqlite.org/pragma.html#pragma_synchronous). Available in Fluent Bit v1.4.6 and later. | `full` |
| `lowercase` | Lowercase the `journald` field (key). | `off` |
| `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` |
| `max_fields` | Set a maximum number of fields (keys) allowed per record. | `8000` |
| `path` | Optional path to the Systemd journal directory. If not set, the plugin uses default paths to read local-only logs. | _none_ |
| `read_from_tail` | Start reading new entries. Skip entries already stored in `journald`. | `off` |
| `strip_underscores` | Remove the leading underscore of the `journald` field (key). For example, the `journald` field `_PID` becomes the key `PID`. | `off` |
| `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_ |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

## Get started

Expand Down