Skip to content

Processor plugin docs updates#2369

Merged
patrick-stephens merged 4 commits intofluent:masterfrom
eschabell:erics_processor_plugin_updates
Feb 4, 2026
Merged

Processor plugin docs updates#2369
patrick-stephens merged 4 commits intofluent:masterfrom
eschabell:erics_processor_plugin_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Feb 4, 2026

Summary of fixes applied:

  • Processor: content-modifier.md issues Found: Missing action param, unsorted
  • Processor: labels.md issues Found: Unsorted, wrong hash algorithm in example
  • Processor: `metrics-selector.md issues Found: Unsorted, typos in context values
  • Processor: sampling.md issues Found: Missing debug param, unsorted tables, swapped min/max descriptions

Fixes #2368.

Summary by CodeRabbit

  • Documentation
    • Enhanced processor configuration documentation with new parameters and default values.
    • Added action and type conversion options to content modifier configuration.
    • Expanded sampling configuration with debug parameter and default values.
    • Clarified label operation descriptions and updated hash algorithm reference.

  - Add missing `action` configuration parameter
  - Sort configuration parameters alphabetically
  - Add Oxford comma in converted_type description

Applies to fluent#2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>
  - Sort configuration parameters alphabetically
  - Fix hash example to say SHA-256 (not SHA-1) to match implementation

Applies to fluent#2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>
  - Sort configuration parameters alphabetically
  - Fix context default value typo (metrics_name -> metric_name)
  - Fix context possible value (delete_label -> delete_label_value)

Applies to fluent#2368

Signed-off-by: Eric D. Schabell <eric@schabell.org>
  - Add missing `debug` configuration parameter
  - Sort all configuration parameter tables alphabetically
  - Fix swapped min_spans/max_spans descriptions in span count condition
  - Add Default column to main config table
  - Normalize table separator styles

Applies to fluent#2368

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

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

Documentation updates for four Fluent Bit processor plugins: content-modifier, labels, metrics-selector, and sampling. Changes include adding missing configuration parameters, reordering configuration tables, updating default values, and refining parameter descriptions to align with current functionality.

Changes

Cohort / File(s) Summary
Processor Documentation Updates
pipeline/processors/content-modifier.md, pipeline/processors/labels.md, pipeline/processors/metrics-selector.md, pipeline/processors/sampling.md
Added missing parameters (action, converted_type, debug, label), reordered configuration tables for consistency, updated context values (delete_label → delete_label_value), added Default column to sampling config tables, updated hash algorithm example from SHA-1 to SHA-256, and refined parameter descriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

4.2.3

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Docs refined with care and thought,
Parameters sorted as they ought,
New defaults gleaming, clear and bright,
Processor guides now set just right!

🚥 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 accurately summarizes the main focus of the PR: updating documentation for processor plugins across multiple files.
Linked Issues check ✅ Passed All coding objectives from issue #2368 are met: missing parameters added (action in content-modifier, debug in sampling), tables alphabetized, and typos/errors fixed across all processor docs.
Out of Scope Changes check ✅ Passed All changes are scoped to processor plugin documentation updates; no out-of-scope code modifications or unrelated alterations are present.
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.

@patrick-stephens patrick-stephens merged commit c8f31de into fluent:master Feb 4, 2026
8 checks passed
@eschabell eschabell deleted the erics_processor_plugin_updates branch February 7, 2026 13:13
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Feb 13, 2026
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.

Processor plugin docs need updates (general issue)

2 participants