Skip to content

Fixing intro docs (about), highlight profiles, OTLP, and fix vale suggestions#2540

Merged
eschabell merged 3 commits intofluent:masterfrom
eschabell:erics_fluent_intro_updates
Apr 7, 2026
Merged

Fixing intro docs (about), highlight profiles, OTLP, and fix vale suggestions#2540
eschabell merged 3 commits intofluent:masterfrom
eschabell:erics_fluent_intro_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Apr 7, 2026

  • what-is-fluent-bit: explicitly list the telemetry signal types
    Fluent Bit processes (logs, metrics, traces, and profiles),
    aligning with concepts/key-concepts.md and fluentbit.io messaging.
  • what-is-fluent-bit: call out native OpenTelemetry (OTLP) ingestion
    and delivery rather than grouping it with ecosystem integrations.
  • what-is-fluent-bit: rename h1 to "What's Fluent Bit?", update
    SUMMARY.md, split long sentences, and use "open source".
  • fluentd-and-fluent-bit: add OpenTelemetry row to the comparison
    table to call out native OTLP support as a differentiator.

Fixes #2539

Summary by CodeRabbit

  • Documentation
    • Updated navigation and heading wording for consistency
    • Expanded Fluent Bit description to explicitly list supported telemetry types: logs, metrics, traces, and profiles
    • Added OpenTelemetry comparison information highlighting native OTLP ingestion and delivery capabilities
    • Clarified vendor integrations with emphasis on native OpenTelemetry support

… 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>
@eschabell eschabell self-assigned this Apr 7, 2026
@eschabell eschabell requested a review from a team as a code owner April 7, 2026 19:18
@eschabell eschabell added the 5.0.3 label Apr 7, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 7, 2026

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Navigation and Heading Updates
SUMMARY.md, about/what-is-fluent-bit.md
Updated navigation label and page heading from "What is Fluent Bit?" to "What's Fluent Bit?" for consistency and modern phrasing.
OpenTelemetry Feature Documentation
about/what-is-fluent-bit.md, about/fluentd-and-fluent-bit.md
Expanded description to explicitly list supported telemetry types (logs, metrics, traces, profiles). Added OpenTelemetry row to comparison table clarifying native OTLP ingestion/delivery support. Updated vendor-neutral integrations description to specify native OpenTelemetry integration alongside Prometheus.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

waiting-on-review, 5.0

Suggested reviewers

  • alexakreizinger
  • cosmo0920

Poem

🐰 With whiskers twitching, we hop with glee,
OTEL features now clearly we see!
Logs, metrics, traces, and profiles too,
Native support shining bright and true! ✨

🚥 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 clearly reflects the main changes: updating introduction documentation to highlight profiles and OpenTelemetry (OTLP), while addressing vale style suggestions.
Linked Issues check ✅ Passed The PR addresses issue #2539 by updating introduction docs to align with OpenTelemetry features and telemetry signal support, explicitly listing logs, metrics, traces, and profiles.
Out of Scope Changes check ✅ Passed All changes are directly related to the PR objectives: updating about section docs, highlighting OTLP features, adding telemetry types, and making minor wording adjustments per vale suggestions.
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

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.

🧹 Nitpick comments (2)
about/what-is-fluent-bit.md (2)

9-9: Remove promotional phrasing to keep intro docs neutral

Line 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-claiming

Line 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), and pipeline/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

📥 Commits

Reviewing files that changed from the base of the PR and between 3da2d5f and 19648b1.

📒 Files selected for processing (3)
  • SUMMARY.md
  • about/fluentd-and-fluent-bit.md
  • about/what-is-fluent-bit.md

@eschabell eschabell merged commit 4271bcd into fluent:master Apr 7, 2026
8 checks passed
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.

Introduction docs for Fluent Bit need to align better with updates from last releases and the current website

1 participant