Skip to content

pipeline: inputs: systemd: document FLUENT_BIT_PARSER per-unit parser - #2685

Open
nourdouf wants to merge 1 commit into
fluent:masterfrom
nourdouf:nourdouf/in_systemd-fluent-bit-parser
Open

pipeline: inputs: systemd: document FLUENT_BIT_PARSER per-unit parser#2685
nourdouf wants to merge 1 commit into
fluent:masterfrom
nourdouf:nourdouf/in_systemd-fluent-bit-parser

Conversation

@nourdouf

@nourdouf nourdouf commented Aug 31, 2026

Copy link
Copy Markdown

Summary

Documents the new in_systemd capability to select a parser at runtime, per journal entry, via the FLUENT_BIT_PARSER field. This can be advertised from a systemd unit with:

[Service]
LogExtraFields=FLUENT_BIT_PARSER=logfmt

When present, the plugin applies the named parser to the entry's MESSAGE field and emits structured fields instead of the raw message. The doc covers behavior (metadata field stripped, MESSAGE-only parsing, graceful fallback when the parser is missing or parsing fails, per-entry resolution) and includes a logfmt example.

Related

Documentation for code PR fluent/fluent-bit#11353 (adds FLUENT_BIT_PARSER support to the systemd input).


Fluent Bit is licensed under Apache 2.0.

Summary by CodeRabbit

  • Documentation
    • Added guidance for selecting parsers per Systemd journal entry at runtime.
    • Documented configuration examples for YAML and classic conf formats.
    • Clarified parser behavior, including fallback handling, metadata processing, and per-entry resolution.
    • Explained how parser selection can be configured through the FLUENT_BIT_PARSER journal field and advertised from a unit file.

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 9eb24b20-c5c0-40fa-93db-94413bad31ac

📥 Commits

Reviewing files that changed from the base of the PR and between 0c302db and 8194feb.

📒 Files selected for processing (1)
  • pipeline/inputs/systemd.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • pipeline/inputs/systemd.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The Systemd input documentation describes per-entry parser selection through the FLUENT_BIT_PARSER journal field. It covers metadata handling, fallback behavior, per-entry resolution, and YAML and conf configuration examples.

Changes

Systemd parser documentation

Layer / File(s) Summary
Document per-unit parser selection
pipeline/inputs/systemd.md
Documents FLUENT_BIT_PARSER, LogExtraFields, parser behavior, fallback handling, and configuration examples.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 8194f

This change documents per-entry systemd parser selection and fallback behavior. No current merge-readiness risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the Systemd input documentation change for the FLUENT_BIT_PARSER per-unit parser capability. It is concise and directly related to the main change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

…parser

Document the ability to select a parser at runtime, per journal entry,
via the FLUENT_BIT_PARSER field (settable from a systemd unit with
LogExtraFields=FLUENT_BIT_PARSER=<parser>). Covers behavior, fallback,
and a logfmt example.

  - Unwrap hard-wrapped paragraphs and list items to single lines so
    GitBook doesn't render mid-sentence breaks
  - Replace "This is useful when" with "Use this when" (FluentBit.Simplicity)
  - Replace "unparsed" with "unmodified" (FluentBit.Spelling)

Relates to fluent/fluent-bit#11353

Signed-off-by: Nour Douffir <nourdouf@github.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
eschabell force-pushed the nourdouf/in_systemd-fluent-bit-parser branch from 0c302db to 8194feb Compare September 3, 2026 18:57
@eschabell

Copy link
Copy Markdown
Collaborator

@nourdouf fixing a few vale issue, then will review.

@eschabell eschabell left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@nourdouf ready to go, just waiting on code PR to merge.

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Sep 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants