Updated 5 configuration options descriptions for otel input plugin for corresponding code update. Fixes #2181.

[eschabell]

Updated 5 configuration options descriptions for otel input plugin for corresponding code update. Fixes #2181.

http2 - Changed to: "Enable HTTP/2 protocol support for the OpenTelemetry receiver"
buffer_max_size - Changed to: "Maximum size of the HTTP request buffer"
buffer_chunk_size - Changed to: "Size of each buffer chunk allocated for HTTP requests"
tag_key - Changed to: "Record accessor key to use for generating tags from incoming records"
logs_metadata_key - Changed to: "Key name to store OpenTelemetry logs metadata in the record"

Summary by CodeRabbit

• Documentation
  • Updated OpenTelemetry configuration documentation with improved descriptions of buffer management, protocol support, metadata handling, tag generation, and TLS/networking options for clearer user guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation update to the OpenTelemetry input plugin configuration options in the Markdown reference. Multiple configuration option descriptions are reworded for clarity, including buffer settings, HTTP/2 support, metadata key specifications, and TLS file alignment, improving alignment with the receiver's terminology and behaviors.

Changes

Cohort / File(s)	Change Summary
OpenTelemetry Configuration Documentation pipeline/inputs/opentelemetry.md	Updated descriptions for configuration options: buffer_max_size, buffer_chunk_size, http2, logs_metadata_key, tag_key, and tls.crt_file. Clarified wording to reflect terminology and behaviors of the OpenTelemetry receiver.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only changes with consistent wording clarifications
• No logic, code, or API changes introduced
• All modifications are descriptive refinements to existing configuration options

Possibly related issues

• OpenTelemetry Input Plugin - missing 5 descriptions in the options for this plugin fluent-bit#11191: Directly addresses the missing descriptions for OpenTelemetry input plugin configuration options (http2, buffer_max_size, buffer_chunk_size, tag_key, logs_metadata_key) that were reported in this issue.

Possibly related PRs

• Updated and fixed opentelemetry input plugin options configuration table. Fixes #2152. #2153: Modifies the same OpenTelemetry input plugin documentation file with updates to configuration option descriptions and tables.

Suggested labels

waiting-on-review

Suggested reviewers

• esmerel
• alexakreizinger

Poem

📚 Through fields of docs, a rabbit hops with glee,
Clarifying configs for all to see,
Buffer sizes, metadata, and protocol bright—
Each description polished, now just right! ✨🐰

Pre-merge checks and finishing touches

✅ 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 identifies the main change: updating 5 configuration option descriptions for the otel input plugin and references the linked issue.
Linked Issues check	✅ Passed	All five configuration options (http2, buffer_max_size, buffer_chunk_size, tag_key, logs_metadata_key) mentioned in issue #2181 have been updated with clarified descriptions matching the upstream code changes.
Out of Scope Changes check	✅ Passed	Changes are limited to the OpenTelemetry input plugin documentation file, updating only the five specified configuration option descriptions as required by issue #2181.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2dee9d8 and 395e0a6.

📒 Files selected for processing (1)

• pipeline/inputs/opentelemetry.md (2 hunks)

🔇 Additional comments (5)

pipeline/inputs/opentelemetry.md (5)

16-16: Clear specification of buffer size units and defaults.

The updated description explicitly lists supported unit formats (KB, MB, GB), which improves clarity for users configuring this parameter. The description aligns with the default value of 4M.

Please confirm this description matches the buffer handling behavior in the corresponding fluent-bit code.

---

17-17: Helpful contextual note for advanced users.

The updated description now includes "(advanced users only)" which appropriately signals that this is not a typical configuration parameter. The description is clear about the parameter's role.

---

20-20: Specific and clear HTTP/2 configuration description.

The updated description clarifies that this option enables HTTP/2 specifically for the OpenTelemetry receiver, making the option's scope and purpose explicit.

Verify this aligns with how HTTP/2 support is implemented in the OpenTelemetry receiver code.

---

25-25: Clear purpose statement for metadata storage.

The updated description explains that this parameter defines the key name for storing OpenTelemetry logs metadata in records, which is more informative than generic key specifications.

Confirm this accurately describes how logs metadata is stored using this key in the OpenTelemetry receiver implementation.

---

42-42: Precise explanation of tag generation mechanism.

The updated description specifies that this is a "record accessor key" used for generating tags, which is more precise than previous wording and clearly indicates the dynamic tag generation capability.

Verify that "record accessor key" matches the terminology and implementation used in the OpenTelemetry receiver for tag generation.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[patrick-stephens]

I think we can merge this - it is not waiting on code merge. The code PRs are to provide the documentation that is missing to the options, but the options exist already.