-
Notifications
You must be signed in to change notification settings - Fork 546
consolidate multiline parsers info #2279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
consolidate multiline parsers info #2279
Conversation
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
WalkthroughMoved and reorganized multiline parsing documentation: added a redirect from the Administration path to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10–15 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🔇 Additional comments (2)
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 |
There was a problem hiding this 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
📒 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.
administration/configuring-fluent-bit/yaml/multiline-parsers-section.md
Outdated
Show resolved
Hide resolved
administration/configuring-fluent-bit/yaml/multiline-parsers-section.md
Outdated
Show resolved
Hide resolved
administration/configuring-fluent-bit/yaml/multiline-parsers-section.md
Outdated
Show resolved
Hide resolved
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>
There was a problem hiding this 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
📒 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-parsersAlso applies to: 7-7, 37-37
administration/configuring-fluent-bit/yaml/multiline-parsers-section.md
Outdated
Show resolved
Hide resolved
…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>
There was a problem hiding this 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:
- Typo: "customer parsers" should be "custom parsers" (inconsistent with line 13 which correctly says "custom").
- Incorrect path: From
administration/configuring-fluent-bit/yaml/parsers-section.md, the link../pipeline/parsers.mdresolves toadministration/configuring-fluent-bit/pipeline/parsers.md, which doesn't exist. The correct relative path should navigate to the root first, then down topipeline/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
📒 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.mdfrompipeline/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.mdare correctly formed relative paths frompipeline/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.mdfrom the yaml directory.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
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.mdsince it clearly is not working :PSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.