Fixing intro docs (about), highlight profiles, OTLP, and fix vale suggestions#2540
Conversation
… suggestions
- Update opening paragraph to explicitly list the telemetry signal
types Fluent Bit processes (logs, metrics, traces, and profiles),
aligning with concepts/key-concepts.md and fluentbit.io messaging.
- Call out native OpenTelemetry (OTLP) ingestion and delivery rather
than grouping it with general ecosystem integrations.
- Split long sentences to improve readability.
- Use "open source" instead of "open-source".
Applies to fluent#2539
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applies to fluent#2539 Signed-off-by: Eric D. Schabell <eric@schabell.org>
…son table
- Highlight native OTLP ingestion and delivery in Fluent Bit as a
differentiator versus Fluentd's plugin-based OpenTelemetry support.
Applies to fluent#2539
Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughDocumentation updates to align Fluent Bit introduction materials with current OTLP capabilities. Changes include navigation label refinement, expanded telemetry type listing, and clarified native OpenTelemetry support across comparison and foundational documentation pages. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
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 (2)
about/what-is-fluent-bit.md (2)
9-9: Remove promotional phrasing to keep intro docs neutralLine 9 includes marketing-style wording (“Trusted by major cloud providers, banks…”). Please keep this paragraph technical and capability-focused.
Proposed wording tweak
-Rather than serving as a drop-in replacement, Fluent Bit enhances the observability strategy for your infrastructure. It adapts and optimizes your existing logging layer, and adds metrics and traces processing. Fluent Bit supports a vendor-neutral approach, with native OpenTelemetry (OTLP) ingestion and delivery and seamless integration with ecosystems such as Prometheus. Trusted by major cloud providers, banks, and companies that need a ready-to-use telemetry agent, Fluent Bit effectively manages diverse data sources and formats. It maintains optimal performance while keeping resource consumption low. +Rather than serving as a drop-in replacement, Fluent Bit enhances observability for existing infrastructure. It adapts and optimizes logging pipelines and adds metrics and traces processing. Fluent Bit follows a vendor-neutral approach, with native OpenTelemetry (OTLP) ingestion and delivery and integration with ecosystems such as Prometheus, while maintaining low resource consumption.Based on learnings, in the fluent-bit-docs repository Markdown documentation should remain technical and neutral, avoiding marketing-style language.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@about/what-is-fluent-bit.md` at line 9, Remove the marketing phrase "Trusted by major cloud providers, banks, and companies that need a ready-to-use telemetry agent" from the paragraph and replace it with a neutral, capability-focused sentence that describes Fluent Bit's technical strengths (e.g., its broad adoption across diverse environments or extensibility) while keeping the rest of the paragraph about OTLP, Prometheus integration, performance, and low resource usage unchanged; target the sentence that begins with "Trusted by major cloud providers..." in the paragraph to make the edit.
7-7: Clarify the scope of “profiles” support to avoid over-claimingLine 7 states Fluent Bit processes profiles generically, but current plugin/docs coverage in
pipeline/processors.md(Line 1-10),pipeline/inputs/forward.md(Line 1-10), andpipeline/outputs/vivo-exporter.md(Line 1-10) still describe logs/metrics/traces only. Please narrow the wording (for example, OTLP-specific profile support) or add a precise qualifier.Proposed wording tweak
-[Fluent Bit](https://fluentbit.io) is an open source telemetry agent that processes logs, metrics, traces, and profiles. +[Fluent Bit](https://fluentbit.io) is an open source telemetry agent that processes logs, metrics, and traces, with OpenTelemetry (OTLP) support that includes profiles.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@about/what-is-fluent-bit.md` at line 7, The sentence in what-is-fluent-bit.md that reads "processes logs, metrics, traces, and profiles" overstates support; update that phrase to narrow scope (e.g., "processes logs, metrics, traces and OTLP profiles" or "processes logs, metrics, and traces; OTLP profile support is experimental/limited") to match current docs (see pipeline/processors.md, pipeline/inputs/forward.md, pipeline/outputs/vivo-exporter.md); keep the rest of the paragraph unchanged and ensure the qualifier ("OTLP" or "experimental/limited") is clearly appended to the word "profiles."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@about/what-is-fluent-bit.md`:
- Line 9: Remove the marketing phrase "Trusted by major cloud providers, banks,
and companies that need a ready-to-use telemetry agent" from the paragraph and
replace it with a neutral, capability-focused sentence that describes Fluent
Bit's technical strengths (e.g., its broad adoption across diverse environments
or extensibility) while keeping the rest of the paragraph about OTLP, Prometheus
integration, performance, and low resource usage unchanged; target the sentence
that begins with "Trusted by major cloud providers..." in the paragraph to make
the edit.
- Line 7: The sentence in what-is-fluent-bit.md that reads "processes logs,
metrics, traces, and profiles" overstates support; update that phrase to narrow
scope (e.g., "processes logs, metrics, traces and OTLP profiles" or "processes
logs, metrics, and traces; OTLP profile support is experimental/limited") to
match current docs (see pipeline/processors.md, pipeline/inputs/forward.md,
pipeline/outputs/vivo-exporter.md); keep the rest of the paragraph unchanged and
ensure the qualifier ("OTLP" or "experimental/limited") is clearly appended to
the word "profiles."
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0261b54b-6708-458e-b22f-9173d3e712e3
📒 Files selected for processing (3)
SUMMARY.mdabout/fluentd-and-fluent-bit.mdabout/what-is-fluent-bit.md
Fluent Bit processes (logs, metrics, traces, and profiles),
aligning with concepts/key-concepts.md and fluentbit.io messaging.
and delivery rather than grouping it with ecosystem integrations.
SUMMARY.md, split long sentences, and use "open source".
table to call out native OTLP support as a differentiator.
Fixes #2539
Summary by CodeRabbit