Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Nov 27, 2025

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

Summary by CodeRabbit

  • Documentation
    • Standardized Systemd input configuration keys to use snake_case naming format instead of CamelCase
    • Updated default values and option presentation for configuration consistency

✏️ Tip: You can customize this high-level summary in your review settings.

@eschabell eschabell added this to the Fluent Bit Docs 4.2 milestone Nov 27, 2025
@eschabell eschabell self-assigned this Nov 27, 2025
@eschabell eschabell requested review from a team as code owners November 27, 2025 12:25
@eschabell eschabell added the 4.2 label Nov 27, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 27, 2025

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between aca86b3 and 5c27fc8.

📒 Files selected for processing (1)
  • pipeline/inputs/systemd.md (1 hunks)

Walkthrough

Documentation 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

Cohort / File(s) Summary
Systemd documentation standardization
pipeline/inputs/systemd.md
Renamed all Systemd input configuration keys from CamelCase to snake_case (e.g., Path → path, Max_Fields → max_fields, Systemd_Filter → systemd_filter); updated default values to lowercase forms (e.g., Full → full, Off → off); reorganized option presentation to align with new naming conventions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Verify consistent application of CamelCase → snake_case naming conversion across all configuration options
  • Confirm default values were updated to match lowercase naming conventions
  • Spot-check a few key parameter mappings for accuracy (e.g., Max_Entries, Systemd_Filter_Type, etc.)

Suggested labels

waiting-on-review

Suggested reviewers

  • patrick-stephens

Poem

🐰 Our Systemd docs now dance with grace,
No more CamelCase in this place!
snake_case whispers through the night,
Configuration keys now shining bright,
Simple, clean, and oh so neat! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The linked issue #2214 describes 'Explicit restarts for journal data cursor' but the PR only updates configuration option naming/layout documentation without addressing cursor restart functionality. Clarify whether the configuration documentation updates are preparatory work for the cursor restart feature or if they fully address issue #2214's requirements.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating layout and case for config options in the systemd input plugin documentation.
Out of Scope Changes check ✅ Passed The PR changes are narrowly scoped to documentation updates: renaming configuration keys from CamelCase to snake_case and updating defaults in the systemd.md file, which aligns with the PR's stated objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 27, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9a7d6e4 and aca86b3.

📒 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 .conf example (lines 67–81) still uses CamelCase (Systemd_Filter on line 76).

In Fluent Bit, the .conf format 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:

  1. Are both CamelCase (.conf format) and snake_case (YAML format) both valid?
  2. Should the documentation explicitly note the format-specific differences?
  3. Does the .conf example require updating to reflect current Fluent Bit conventions, or is CamelCase still the standard for that format?

If CamelCase is still required for .conf files, consider adding a note in the documentation (e.g., "Configuration keys use snake_case in YAML format and CamelCase in the classical .conf format").

Also applies to: 67-81

@eschabell
Copy link
Collaborator Author

AI review passed, merging.

@eschabell eschabell merged commit 863ec6d into fluent:master Nov 27, 2025
8 checks passed
@eschabell eschabell deleted the erics_in_systemd_42 branch November 27, 2025 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhancement 4.2 - Systemd input plugin

1 participant