Updates Concepts section of docs for new release#2392
Updates Concepts section of docs for new release#2392eschabell wants to merge 2 commits intofluent:masterfrom
Conversation
…types - Add Processor to the intro topic list - Add Processor section describing how processors differ from filters - Update Events/Records description to include traces and profiles - Fix grammar: "associated timestamps" → "associated timestamp" Applies to fluent#2391 Signed-off-by: Eric D. Schabell <eric@schabell.org>
… sections - Add Processors node to Mermaid pipeline diagram between Input and Parser - Add Processors section describing plugin-attached, tag-free, YAML-only processing - Update diagram accessible description to include processors Applies to fluent#2391 Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughDocumentation updates to Fluent Bit concepts section introduce a new Processors stage in the data pipeline diagram, restructuring the flow from Input → Processors → Parser → Filter → Buffer → Routing → Outputs. Added comprehensive Processor concept documentation covering attachment to plugins, threading model, and YAML-based configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
🧹 Nitpick comments (1)
concepts/data-pipeline.md (1)
25-29: Consider varying sentence structure for readability.Three consecutive sentences begin with "Processors," which creates repetitive flow. Consider rephrasing for smoother reading.
📝 Suggested refinement
-[Processors](../pipeline/processors.md) are components that modify, transform, or enhance data as it flows through the pipeline. Processors are attached directly to individual input or output plugins rather than defined globally, and they don't use tag matching. +[Processors](../pipeline/processors.md) are components that modify, transform, or enhance data as it flows through the pipeline. These components are attached directly to individual input or output plugins rather than defined globally, and they don't use tag matching. -Because processors run in the same thread as their associated plugin, they can reduce performance overhead compared to filters—especially when [multithreading](../administration/multithreading.md) is enabled. +Because they run in the same thread as their associated plugin, processors can reduce performance overhead compared to filters—especially when [multithreading](../administration/multithreading.md) is enabled. -Processors are configured in [YAML configuration files](../administration/configuring-fluent-bit/yaml.md) only. +Configuration is supported in [YAML configuration files](../administration/configuring-fluent-bit/yaml.md) only.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@concepts/data-pipeline.md` around lines 25 - 29, Reword the three consecutive sentences that start with "Processors" in concepts/data-pipeline.md to avoid repetition: keep the same facts (they modify/transform/enhance data, are attached to individual input/output plugins not globally, run in the plugin thread and can be faster than filters with multithreading, and are configured via YAML) but vary sentence openings and flow—for example, start one sentence with an action (e.g., "They modify..."), another with a contrast or placement (e.g., "Rather than being defined globally..."), and the last with configuration detail (e.g., "Configure processors in YAML files...") so the paragraph reads smoother while preserving content.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@concepts/data-pipeline.md`:
- Around line 25-29: Reword the three consecutive sentences that start with
"Processors" in concepts/data-pipeline.md to avoid repetition: keep the same
facts (they modify/transform/enhance data, are attached to individual
input/output plugins not globally, run in the plugin thread and can be faster
than filters with multithreading, and are configured via YAML) but vary sentence
openings and flow—for example, start one sentence with an action (e.g., "They
modify..."), another with a contrast or placement (e.g., "Rather than being
defined globally..."), and the last with configuration detail (e.g., "Configure
processors in YAML files...") so the paragraph reads smoother while preserving
content.
|
@cosmo0920 and @patrick-stephens ready for review, bit of an update for 5.0 release here! |
key-concepts: add processor concept and update event types
data-pipeline: add processors to pipeline diagram and sections
Fixes #2391
Summary by CodeRabbit