Skip to content

Conversation

@alexakreizinger
Copy link
Member

@alexakreizinger alexakreizinger commented Dec 5, 2025

this PR consolidates multiline parsers info to make it more consistent with the other parsing docs.

EDIT: I also removed the "here's how to format links" guidance from CONTRIBUTING.md since it clearly is not working :P

Summary by CodeRabbit

  • Documentation
    • Moved Multiline parsing from Administration to Parsers for improved discoverability
    • Updated internal links and navigation targets to reflect the new structure
    • Expanded and clarified multiline parser guidance with clearer terminology, extended configuration explanations, a focused YAML example, and informational hint blocks
    • Removed guidance recommending absolute file-path links and cleaned up minor formatting for readability

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

Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
@alexakreizinger alexakreizinger requested review from a team as code owners December 5, 2025 03:34
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 5, 2025

Walkthrough

Moved and reorganized multiline parsing documentation: added a redirect from the Administration path to pipeline/parsers/multiline-parsing.md, relocated and rewrote YAML-focused guidance and examples, and updated internal links across parser-related pages. No code or public APIs changed.

Changes

Cohort / File(s) Summary
Redirect & Navigation
/.gitbook.yaml, ./SUMMARY.md
Added redirect mapping from administration/configuring-fluent-bit/multiline-parsingpipeline/parsers/multiline-parsing.md and relocated the Multiline parsing navigation entry.
Multiline parser doc (moved & rewritten)
./pipeline/parsers/multiline-parsing.md
Rewrote multiline parser description and headings, added informational hint blocks, expanded configuration table text, and clarified terminology and YAML usage.
YAML-focused docs & examples
./administration/configuring-fluent-bit/yaml/multiline-parsers-section.md, ./administration/configuring-fluent-bit/yaml/parsers-section.md, ./administration/configuring-fluent-bit/yaml.md
Reworked YAML guidance for multiline_parsers, added Syntax section and examples, updated wording (e.g., "customer" → "custom") and adjusted internal cross-links to the new parsers location.
Parser configuration page updates
./pipeline/parsers/configuring-parser.md, ./pipeline/parsers.md
Updated cross-reference targets and minor formatting/wording adjustments to point to administration YAML/parsers anchors and the relocated parsers doc.
Pipeline pages — link fixes
./pipeline/filters/multiline-stacktrace.md, ./pipeline/inputs/tail.md
Updated Markdown links to reference ../parsers/multiline-parsing.md (new relative path) instead of the old administration-based paths; minor whitespace/formatting edits.
Contributing guidance
./CONTRIBUTING.md
Removed guidance recommending absolute file-path links and deleted the "Links" subsection and example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10–15 minutes

  • Verify all updated internal links and the redirect entry in .gitbook.yaml.
  • Check YAML example formatting, hint block markup, and document anchors in the moved multiline parser doc.
  • Confirm SUMMARY.md renders the updated navigation correctly.

Possibly related PRs

Suggested labels

4.2.1

Suggested reviewers

  • cosmo0920
  • cnorris-cs

Poem

🐇 I hopped through docs with nimble paws,
Moved multiline paths and fixed the laws,
YAML hints snug in their new home,
Links now point where parsers roam,
A tiny hop — the docs applaud.

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 accurately summarizes the main objective of consolidating multiline parser documentation for consistency with other parsing docs.
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-153847/consolidate-move-multiline-parsing-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 b079f13 and a575c23.

📒 Files selected for processing (2)
  • administration/configuring-fluent-bit/yaml.md (1 hunks)
  • pipeline/parsers/configuring-parser.md (1 hunks)
🔇 Additional comments (2)
administration/configuring-fluent-bit/yaml.md (1)

11-18: Relative links are properly formatted.

All section links correctly use the ./yaml/ relative path prefix. The past critical issue on line 14 (malformed .yaml/ path) has been resolved, and the new multiline_parsers link on line 16 follows the same consistent pattern.

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

3-7: Cross-reference links corrected.

Line 3 uses the correct relative path ../parsers.md (resolves to pipeline/parsers.md), and line 7 correctly omits the .md extension from the anchor #standalone-parsers-files. Both past critical issues have been resolved.


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.

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: 5

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9803d3 and ffc6bfd.

📒 Files selected for processing (6)
  • .gitbook.yaml (1 hunks)
  • SUMMARY.md (1 hunks)
  • administration/configuring-fluent-bit/yaml/multiline-parsers-section.md (2 hunks)
  • pipeline/filters/multiline-stacktrace.md (5 hunks)
  • pipeline/inputs/tail.md (1 hunks)
  • pipeline/parsers/multiline-parsing.md (4 hunks)
🔇 Additional comments (6)
.gitbook.yaml (1)

105-105: Redirect mapping is correctly placed and formatted.

The new redirect maintains backward compatibility for existing links that reference the old documentation location.

SUMMARY.md (1)

128-128: Navigation reorganization is well-structured.

Moving the Multiline parsing link under the Parsers section correctly reflects that multiline parsers are a type of parser configuration, improving discoverability and organization consistency.

pipeline/parsers/multiline-parsing.md (4)

7-7: Improved definition of multiline parsers.

The revised description clearly communicates the purpose and use cases for multiline parsers, making the documentation more accessible to new users.


11-11: Consistent capitalization in section headers.

The lowercase styling for "multiline parser engine" and the consistent naming in "Configuring multiline parsers" aligns with the terminology and improves readability.

Also applies to: 29-29


33-37: User-friendly information hint improves discoverability.

The new info hint block that directs users to the YAML multiline_parsers section helps with configuration workflow and reduces confusion about where to define custom parsers.


48-48: Expanded type parameter description provides better guidance.

The updated description now clarifies the purpose of multiline parser types, helping users select the correct configuration approach for their use case.

alexakreizinger and others added 3 commits December 4, 2025 20:16
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffc6bfd and 3819dd4.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit/yaml/multiline-parsers-section.md (2 hunks)
🔇 Additional comments (1)
administration/configuring-fluent-bit/yaml/multiline-parsers-section.md (1)

3-3: Previous critical path issues have been fixed.

The three relative paths that were flagged as critical in the prior review have been corrected:

  • Line 3: Now correctly uses ../../pipeline/parsers/multiline-parsing.md
  • Line 7: Now correctly uses ./parsers-section.md (same directory)
  • Line 37: Now correctly uses ../../pipeline/parsers/multiline-parsing.md#configuring-multiline-parsers

Also applies to: 7-7, 37-37

alexakreizinger and others added 2 commits December 4, 2025 20:19
…ection.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
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: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
administration/configuring-fluent-bit/yaml/parsers-section.md (1)

3-3: Fix typo and incorrect relative path.

Line 3 has two issues:

  1. Typo: "customer parsers" should be "custom parsers" (inconsistent with line 13 which correctly says "custom").
  2. Incorrect path: From administration/configuring-fluent-bit/yaml/parsers-section.md, the link ../pipeline/parsers.md resolves to administration/configuring-fluent-bit/pipeline/parsers.md, which doesn't exist. The correct relative path should navigate to the root first, then down to pipeline/parsers.md.
-You can define customer [parsers](../pipeline/parsers.md) in the `parsers` section of YAML configuration files.
+You can define custom [parsers](../../../pipeline/parsers.md) in the `parsers` section of YAML configuration files.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3819dd4 and b079f13.

📒 Files selected for processing (7)
  • CONTRIBUTING.md (0 hunks)
  • administration/configuring-fluent-bit/yaml.md (1 hunks)
  • administration/configuring-fluent-bit/yaml/multiline-parsers-section.md (2 hunks)
  • administration/configuring-fluent-bit/yaml/parsers-section.md (2 hunks)
  • pipeline/inputs/tail.md (1 hunks)
  • pipeline/parsers.md (1 hunks)
  • pipeline/parsers/configuring-parser.md (1 hunks)
💤 Files with no reviewable changes (1)
  • CONTRIBUTING.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • administration/configuring-fluent-bit/yaml/multiline-parsers-section.md
🧰 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 (4)
pipeline/inputs/tail.md (1)

161-163: Cross-references corrected.

The multiline parser links have been properly updated to use the correct relative paths ../parsers/multiline-parsing.md from pipeline/inputs/tail.md. The past review concern about incorrect ../pipeline/parsers/ paths has been resolved.

pipeline/parsers.md (1)

42-54: Documentation formatting and link updates look good.

The list marker removals improve readability, and the updated cross-references to ../administration/configuring-fluent-bit/yaml/parsers-section.md are correctly formed relative paths from pipeline/parsers.md.

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

7-7: Cross-reference update is correct.

The updated link to the multiline_parsers section now correctly uses the sibling file reference ./multiline-parsers-section.md.


38-38: Cross-reference update is correct.

The updated link to the configuring-parser documentation now correctly points to ../../pipeline/parsers/configuring-parser.md from the yaml directory.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
@eschabell eschabell self-assigned this Dec 5, 2025
@eschabell eschabell added the 4.2.1 label Dec 5, 2025
@eschabell eschabell merged commit dc0465e into master Dec 5, 2025
8 checks passed
@eschabell eschabell deleted the alexakreizinger/sc-153847/consolidate-move-multiline-parsing-info branch December 5, 2025 08:01
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.

3 participants