Skip to content

Parser plugin docs updates#2371

Merged
patrick-stephens merged 7 commits intofluent:masterfrom
eschabell:erics_parsers_docs_updates
Feb 10, 2026
Merged

Parser plugin docs updates#2371
patrick-stephens merged 7 commits intofluent:masterfrom
eschabell:erics_parsers_docs_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Feb 7, 2026

  • configuring-parser: improve config parameter table
  • decoders: improve structure and config tables
  • json: add link to configuring-parser
  • logfmt: add config parameter table and link
  • ltsv: add link to configuring-parser
  • multiline-parsing: add missing parameters
  • regular-expression: fix config table and formatting

Fixes #2370

Summary by CodeRabbit

  • Documentation
    • Parser configuration keys standardized to snake_case (e.g., Name → name, Skip_Empty_Values → skip_empty_values) with updated defaults.
    • Added parameters: logfmt_no_bare_keys, key_group, key_pattern.
    • Decoder options expanded: mysql_quoted, escaped, escaped_utf8, json; new decoder actions documented.
    • Docs reorganized with clearer configuration sections, examples updated, and improved cross-references to configuring custom parsers.

  - Sort parameter table alphabetically
  - Add Default column with values for each parameter
  - Add missing logfmt_no_bare_keys parameter
  - Add missing mysql_quoted decoder type to decode_field and decode_field_as
  - Fix Time_System_timezone case to time_system_timezone
  - Lowercase all parameter names to match repo YAML convention
  - Remove inaccurate format restriction on types parameter

Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
  - Restructure sections to Configuration parameters before Examples
  - Sort decoder options table alphabetically
  - Sort optional actions table alphabetically
  - Add missing mysql_quoted decoder type
  - Lowercase parameter references to match repo YAML convention

Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
  - Add link to configuring-parser for common parameters
  - Add format-specific parameter table for logfmt_no_bare_keys

Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Feb 7, 2026
@eschabell eschabell requested a review from a team as a code owner February 7, 2026 16:39
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Feb 7, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 7, 2026

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 38 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.

📝 Walkthrough

Walkthrough

Standardizes parser documentation keys from CamelCase to snake_case across multiple parser docs, adds configuration parameter tables and cross-references to the main configuring-parsers guide, and documents new parser options (e.g., mysql_quoted, logfmt_no_bare_keys, key_group, key_pattern). All edits are documentation-only.

Changes

Cohort / File(s) Summary
Core parser config
pipeline/parsers/configuring-parser.md
Replaced CamelCase config keys with snake_case equivalents, added Default column, adjusted time-related options to snake_case and updated defaults; introduced mysql_quoted in decoder options and added logfmt_no_bare_keys entry.
Decoder docs
pipeline/parsers/decoders.md
Renamed Decode_Field/Decode_Field_As to decode_field/decode_field_as, added Configuration parameters, Decoder options (including json, escaped, escaped_utf8, mysql_quoted) and Optional actions (do_next, try_next) tables and examples.
Parser-specific docs
pipeline/parsers/logfmt.md, pipeline/parsers/regular-expression.md, pipeline/parsers/ltsv.md
Added logfmt_no_bare_keys config and cross-references; normalized option names (e.g., skip_empty_values) and adjusted table headers/wording; minor formatting and guidance additions.
Multiline parser
pipeline/parsers/multiline-parsing.md
Documented two new options: key_group (grouping streams by a key) and key_pattern (apply matching to an alternative key).
Cross-reference additions
pipeline/parsers/json.md
Added a link to the main Configuring custom parsers guide; small contextual update.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 I hopped through pages, nibbled CamelCase away,
Now_snake_case trails follow where I play.
Tables sprout defaults, options tidy and neat,
Cross-links bind the paths so docs are complete.
A small hop for docs, a joyful carrot treat.

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Parser plugin docs updates' is vague and generic, using non-descriptive terms that don't convey specific information about the changeset. Consider a more specific title that highlights the main change, such as 'Standardize parser configuration naming to snake_case and add config documentation links' or 'Reorganize parser docs with snake_case parameters and cross-references.'
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed The pull request comprehensively addresses all objectives from issue #2370: centralizes general config parameters in configuring-parser, adds links from individual parser pages, sorts configuration tables, adds missing parameters, and ensures consistent snake_case naming.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #2370 objectives; no out-of-scope modifications detected beyond documentation updates to parser configuration and cross-references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
Copy Markdown
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

🤖 Fix all issues with AI agents
In `@pipeline/parsers/ltsv.md`:
- Line 1: Remove the leading spaces before the Markdown header so the header
token starts at column 0; locate the header line that contains "# LTSV format"
and delete any preceding whitespace so it becomes exactly "# LTSV format" with
no indentation.
🧹 Nitpick comments (1)
pipeline/parsers/multiline-parsing.md (1)

44-44: Consider rewording to address style guideline.

The description uses "useful," which the style guide discourages as it implies ease of use. Consider a more direct phrasing.

Alternative wording
-| `key_pattern`   | For an incoming structured message, specify an alternative key to apply matching rules against, separate from `key_content`. This is useful when you want to match against one field while concatenating content from another. | _none_ |
+| `key_pattern`   | For an incoming structured message, specify an alternative key to apply matching rules against, separate from `key_content`. This allows matching against one field while concatenating content from another. | _none_ |

@eschabell eschabell force-pushed the erics_parsers_docs_updates branch from 74f3e6c to 5041702 Compare February 7, 2026 17:00
  - Add link to configuring-parser for common parameters
  - Lowercase skip_empty_values and its default to match repo convention
  - Fix {% end hint %} to {% endhint %}

Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
  - Add key_group parameter for stream grouping
  - Add key_pattern parameter for alternative match field

Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applies to fluent#2370

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_parsers_docs_updates branch from 5041702 to a4fdee4 Compare February 7, 2026 17:06
@eschabell
Copy link
Copy Markdown
Collaborator Author

@cosmo0920 or @patrick-stephens, ready for review!

@patrick-stephens patrick-stephens merged commit 6e7d8e9 into fluent:master Feb 10, 2026
8 checks passed
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Feb 13, 2026
@eschabell eschabell deleted the erics_parsers_docs_updates branch March 19, 2026 17:08
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.

General updates needed across the Parser plugin docs needed

3 participants