Updating general layout and case for config options in systemd input plugin docs. Fixes #2214. #2228
Conversation
…plugin docs. Fixes #2214. Signed-off-by: Eric D. Schabell <[email protected]>
|
Warning Rate limit exceeded@eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 31 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughDocumentation update to the Systemd input plugin configuration guide, standardizing configuration key naming from CamelCase to snake_case conventions and aligning default values to lowercase forms throughout the configuration reference. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pipeline/inputs/systemd.md (1)
20-20: Minor: Remove unnecessary "of" for conciseness.Consider the wording of the filter matching logic.
- 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. + 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.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pipeline/inputs/systemd.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
pipeline/inputs/systemd.md
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...ith and a record is matched only when all of the systemd_filter have a match. With `or...
(ALL_OF_THE)
🔇 Additional comments (2)
pipeline/inputs/systemd.md (2)
11-22: Configuration table keys properly converted to snake_case. ✓The key renaming from CamelCase to snake_case is applied consistently throughout the configuration parameters table, and default values are appropriately normalized to lowercase forms.
48-62: Configuration format inconsistency between YAML and .conf examples.The YAML example (lines 48–62) correctly uses snake_case keys (
systemd_filter), but the classical.confexample (lines 67–81) still uses CamelCase (Systemd_Filteron line 76).In Fluent Bit, the
.confformat traditionally uses CamelCase for configuration keys, while YAML uses snake_case. However, the documentation now presents snake_case in the official configuration table, which may confuse users about which syntax applies to their config format.Please clarify:
- Are both CamelCase (
.confformat) and snake_case (YAML format) both valid?- Should the documentation explicitly note the format-specific differences?
- Does the
.confexample require updating to reflect current Fluent Bit conventions, or is CamelCase still the standard for that format?If CamelCase is still required for
.conffiles, consider adding a note in the documentation (e.g., "Configuration keys use snake_case in YAML format and CamelCase in the classical.confformat").Also applies to: 67-81
Signed-off-by: Eric D. Schabell <[email protected]>
|
AI review passed, merging. |
|
@alexakreizinger requesting a post merge look please? |
| | `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` | |
There was a problem hiding this comment.
if you revisit this page, I would change Values: to Possible values:
| | `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` | |
There was a problem hiding this comment.
I don't know if you have any more info about this than I do (and that this is the original definition before you opened the PR), but this description is definitely confusing 😅
| | `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 `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_ | |
There was a problem hiding this comment.
if you revisit this page, I would change the description to Fluent Bit uses tags to route messages. For the Systemd input plugin, tags have an additional capability: if the tag includes...
2 participants
Updating general layout and case for config options in systemd input plugin docs. Fixes #2214.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.