consolidate/clarify parsers info

[alexakreizinger]

this PR consolidates and clarifies information related to parsers.

Summary by CodeRabbit

• Documentation
  • Renamed parser pages to format-focused titles (e.g., "JSON format", "Logfmt format", "LTSV format", "Regular expression format")
  • Retitled "Configuring parsers" to "Configuring custom parsers" and expanded parameter guidance
  • Added "Decoder settings"
  • Added standalone parsers file workflow and clarified service.parsers_file usage
  • Pluralized pipeline sections (Inputs, Filters, Outputs) and added structured parameter tables
  • Expanded time resolution and timezone guidance; standardized examples and links

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

[coderabbitai]

Walkthrough

Standardizes parser documentation and navigation: renames parser headings to emphasize formats, updates internal YAML links to explicit .md targets, expands custom-parser guidance (including standalone parsers_file examples), and pluralizes/restructures several YAML pipeline/service sections with updated examples and tables.

Changes

Cohort / File(s)	Summary
Summary & navigation SUMMARY.md	Renamed parser entries to format-centered titles (e.g., JSON → JSON format), added Decoder settings, and adjusted ordering/wording in Parsers group.
Top-level YAML doc administration/configuring-fluent-bit/yaml.md	Replaced section links with explicit Markdown targets under administration/configuring-fluent-bit/yaml/ (e.g., .../env-section → .../env.md), updated hint links.
YAML — parsers section administration/configuring-fluent-bit/yaml/parsers-section.md	Replaced generic examples with custom_parser YAML examples (json, regex), added standalone parsers_file workflow and my-parsers.yaml example, standardized time_format quoting and time_keep usage, and added steps to reference service.parsers_file.
YAML — pipeline section administration/configuring-fluent-bit/yaml/pipeline-section.md	Renamed headings to plurals (Input→Inputs, Filter→Filters, Output→Outputs) and introduced structured key/description tables for Inputs, Filters, and Outputs.
YAML — service section administration/configuring-fluent-bit/yaml/service-section.md	Removed blank table header row; updated parsers_file to reference standalone files (multiple allowed); adjusted plugins_file and streams_file links; moved storage keys to a storage child key and updated wording.
Parsers overview pipeline/parsers.md	Rewrote overview to focus on transforming unstructured logs to structured entries; added "How parsers work", default vs custom parsers, and steps to attach parsers to input plugins with YAML examples.
Parser configuration pipeline/parsers/configuring-parser.md	Retitled to "Configuring custom parsers"; converted parameter docs to per-parameter descriptions, expanded time/fractional-seconds details, reorganized timezone subsections, and emphasized config-file-centered guidance.
Decoder settings pipeline/parsers/decoders.md	Retitled to "Decoder settings"; minor formatting adjustments (tabs/end-of-file).
Parser format pages pipeline/parsers/json.md, pipeline/parsers/logfmt.md, pipeline/parsers/ltsv.md, pipeline/parsers/regular-expression.md	Standardized titles to "* format" (e.g., JSON format), rewrote introductions to emphasize creating custom parsers per format, updated examples and fixed minor Markdown/EOF formatting.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Verify internal link targets and SUMMARY.md ordering.
• Validate YAML/example snippets (quoting of time_format, time_keep values).
• Review consistency of renamed headings, tables and formatting across parser pages.

Possibly related PRs

• fluent/fluent-bit-docs#2254 — Modifies similar documentation files and link targets in YAML and service sections.
• fluent/fluent-bit-docs#2183 — Overlaps on parser documentation reorganization across pipeline/parsers and YAML docs.

Suggested reviewers

• cosmo0920
• cnorris-cs

Poem

🐰
I hop through docs with tiny paws,
renaming formats, fixing flaws.
Parsers sorted, links made clear,
I chew a carrot, give a cheer.
Hooray — tidy docs for every ear! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly aligns with the PR's stated objective to consolidate and clarify parser documentation across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch alexakreizinger/sc-153846/consolidate-move-parsers-info

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f223ad and 0d81430.

📒 Files selected for processing (2)

• administration/configuring-fluent-bit/yaml.md (1 hunks)
• administration/configuring-fluent-bit/yaml/service-section.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• administration/configuring-fluent-bit/yaml/service-section.md
• administration/configuring-fluent-bit/yaml.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

pipeline/parsers.md (1)

3-3: Simplify opening statement for clarity.

The opener is concise, but consider the static analysis hint at line 48 about the phrase "a variety of". Review whether similar phrasing simplification would improve this line or others in the file. Based on LanguageTool, "a variety of" can often be replaced with more direct alternatives.

For example, line 48 could be simplified from:

Fluent Bit includes a variety of [default parsers](...) for parsing common data formats...

to:

Fluent Bit includes [default parsers](...) for parsing common data formats...

or use a more specific descriptor like "numerous," "many," or "built-in."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17989cc and 4e309d8.

📒 Files selected for processing (12)

• SUMMARY.md (1 hunks)
• administration/configuring-fluent-bit/yaml.md (1 hunks)
• administration/configuring-fluent-bit/yaml/parsers-section.md (1 hunks)
• administration/configuring-fluent-bit/yaml/pipeline-section.md (3 hunks)
• administration/configuring-fluent-bit/yaml/service-section.md (2 hunks)
• pipeline/parsers.md (3 hunks)
• pipeline/parsers/configuring-parser.md (10 hunks)
• pipeline/parsers/decoders.md (2 hunks)
• pipeline/parsers/json.md (2 hunks)
• pipeline/parsers/logfmt.md (2 hunks)
• pipeline/parsers/ltsv.md (3 hunks)
• pipeline/parsers/regular-expression.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

pipeline/parsers.md

[style] ~48-~48: Consider using a more concise synonym.
Context: ...and custom parsers Fluent Bit includes a variety of [default parsers](https://github.com/fl...

(A_VARIETY_OF)

🔇 Additional comments (16)

pipeline/parsers/decoders.md (1)

1-1: Header change aligns with documentation reorganization.

The rename from "Decoders" to "Decoder settings" is consistent with the SUMMARY.md updates and clarifies the section's purpose within the parser documentation hierarchy.

pipeline/parsers/regular-expression.md (1)

1-3: Header and intro align with format-focused documentation pattern.

The header change from "Regular expression" to "Regular expression format" and the rewritten intro clarify the section's purpose as documenting a parser format for custom parsers. This matches the pattern used in json.md and maintains consistency across parser documentation.

pipeline/parsers/json.md (1)

1-3: Header and intro follow established format-focused documentation pattern.

The header change from "JSON" to "JSON format" and the expanded intro about creating custom parsers compatible with JSON data are consistent with the broader parser documentation reorganization and the pattern used in other format files.

pipeline/parsers.md (2)

19-38: Example output now emphasizes structured JSON representation.

The example has been updated to show a JSON-formatted output object instead of the previous plain-text format. This makes the structured output clearer and aligns with the documentation's focus on custom parsers. The change improves clarity for users unfamiliar with Fluent Bit's internal representation.

---

40-59: New sections provide clear parser workflow guidance.

The addition of three new sections ("How parsers work," "Default parsers and custom parsers," "Add a parser to an input plugin") significantly improves the documentation structure. All cross-referenced files exist:

• Line 48: ../configuring-fluent-bit/yaml/parsers-section.md ✓
• Line 54: ../pipeline/parsers/configuring-parser.md ✓
• Line 55: ../administration/configuring-fluent-bit/yaml/pipeline-section.md ✓

administration/configuring-fluent-bit/yaml/pipeline-section.md (3)

68-90: Section header pluralized for consistency with YAML structure.

The "Input" section has been renamed to "Inputs" to reflect the YAML structure where pipeline.inputs is an array. The addition of a parameter table (Name, Tag, Log_Level) standardizes documentation format. The example remains functional under the new heading.

---

91-114: Section header pluralized and parameter table added.

The "Filter" section is now "Filters" with an explicit parameter table (Name, Match, Match_Regex, Log_Level). This change maintains consistency with the pluralized "inputs" and "outputs" sections and provides clearer documentation of filter configuration options.

---

116-136: Section header pluralized and parameter table standardizes outputs documentation.

The "Output" section is now "Outputs" with a parameter table matching the structure used in Inputs and Filters. This pluralization aligns with the YAML array structure and the broader documentation restructuring. No dangling references to the old singular section name were found in the documentation.

administration/configuring-fluent-bit/yaml.md (1)

11-18: All eight section files referenced in the updated links exist in the administration/configuring-fluent-bit/yaml/ directory with the correct names. No action required.

SUMMARY.md (1)

128-133: Format-focused terminology standardizes parser documentation entries.

The updates to the Parsers section in the SUMMARY apply a consistent "format" suffix to parser types (JSON format, Logfmt format, LTSV format, Regular expression format) and rename the configuration section to "Configuring custom parsers." This terminological shift clarifies the documentation's focus on custom parser creation and aligns with the broader restructuring. All linked documentation files exist and match the expected names exactly.

administration/configuring-fluent-bit/yaml/service-section.md (1)

13-13: The referenced anchor is correctly configured. The heading ## Standalone parsers files at line 42 in parsers-section.md automatically generates the anchor #standalone-parsers-files used in the link at line 13 of service-section.md. The storage configuration section (lines 28-30) is also properly structured. No action required.

pipeline/parsers/logfmt.md (1)

1-5: Terminology and phrasing align well with PR objectives.

The title now clarifies this is about the "Logfmt format" for custom parsers, and the intro consistently uses the "custom parsers" language throughout. The wording is clear and purposeful.

pipeline/parsers/ltsv.md (1)

1-3: Phrasing is consistent with the broader documentation consolidation.

The title and introductory text now clearly position LTSV as a "format" for creating custom parsers, matching the pattern established across related parser documentation in this PR.

Also applies to: 16-16

administration/configuring-fluent-bit/yaml/parsers-section.md (1)

17-88: Standalone parsers file section is well-structured.

The new standalone parsers file workflow (lines 42–88) clearly guides users through the steps with concrete examples in the my-parsers.yaml file and demonstrates how to reference it in the main fluent-bit.yaml using parsers_file. The YAML syntax is consistent and examples are readable.

pipeline/parsers/configuring-parser.md (2)

1-3: Title and intro clearly establish purpose for custom parser configuration.

The title and introductory text now unambiguously state this page is about configuring custom parsers. Line 7's info box correctly directs users to both in-file parser definitions and standalone parsers file workflows.

Also applies to: 7-7

---

31-141: Section headings and time zone organization are clear and comprehensive.

The reorganized time zone sections with regional headings (Universal, North American, European, etc.) improve scannability and help users quickly locate relevant time zone abbreviations.

[alexakreizinger]

@eschabell fixed the conflicts, should be safe to merge now (with your approval 😄)