Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Nov 7, 2025

Updated and fixed opentelemetry input plugin options configuration table. Fixes #2152.

Summary by CodeRabbit

  • Documentation
    • Expanded OpenTelemetry input documentation: much larger configuration reference (TLS, threading, buffering, networking, transport protocols), added default values and descriptions, reorganized sections, clarified raw_traces placement, and added OTLP/HTTP and OTLP/gRPC endpoint details plus sample configurations for easier setup.

…ble. Fixes fluent#2152.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Nov 7, 2025
@eschabell eschabell requested review from a team as code owners November 7, 2025 15:50
@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Nov 7, 2025
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
Copy link
Collaborator Author

@alexakreizinger or @esmerel please review, fixed extra back tick that was breaking the code examples and updated options configuration table to be complete with latest version.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
Copy link
Collaborator Author

Fun with Linting issues...

Copy link
Member

@alexakreizinger alexakreizinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few suggestions, but LGTM :)

@edsiper
Copy link
Member

edsiper commented Nov 9, 2025

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Nov 9, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link

coderabbitai bot commented Nov 9, 2025

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 7500238 and ec01d7d.

📒 Files selected for processing (1)
  • pipeline/inputs/opentelemetry.md (1 hunks)

Walkthrough

The OpenTelemetry input plugin documentation was expanded: the configuration table now lists many additional public keys (networking, TLS, threading, buffering, storage, logging, and transport options), default values, reorganized sections, and added endpoint/transport examples. No code or runtime behavior was changed.

Changes

Cohort / File(s) Summary
Configuration documentation expansion
pipeline/inputs/opentelemetry.md
Replaced the prior concise options with an expanded configuration table adding public keys (e.g., alias, encode_profiles_as_log, host, http2, log_level, log_supress_interval, logs_body_key, logs_metadata_key, mem_buf_limit, net.*, profiles_support, routable, storage.*, tls.*, thread.ring_buffer.*, etc.), updated/added default values and descriptions, reorganized sections for TLS, threading, buffering, networking, and added OTLP/HTTP and OTLP/gRPC endpoint examples. No code changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Single documentation file with repetitive, additive table entries.
  • No code logic or runtime behavior changes.
  • Review focus:
    • Verify accuracy of new configuration key names and default values against implementation.
    • Confirm example endpoint paths and protocol notes match OTLP specs.

Poem

🐰 I hopped through docs with eager feet,
New keys and TLS made the table complete.
Threads and buffers lined up in a row,
OTLP endpoints now ready to go.
A joyful nibble—docs all aglow! 🥕✨

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 'Updated and fixed opentelemetry input plugin options configuration table. Fixes #2152.' clearly and specifically describes the main change: updating/fixing the OpenTelemetry input plugin documentation configuration table, which directly aligns with the changeset.
Linked Issues check ✅ Passed The PR addresses both objectives from #2152: the configuration table was expanded with comprehensive public keys and descriptions, and the code example formatting issue (extra backtick) was corrected.
Out of Scope Changes check ✅ Passed All changes in the PR are scoped to the OpenTelemetry input plugin documentation, specifically updating the configuration table and fixing code examples as required by #2152, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

@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.

Actionable comments posted: 2

♻️ Duplicate comments (2)
pipeline/inputs/opentelemetry.md (2)

23-23: Incorrect plugin type in log_supress_interval description.

Line 23 references "output plugin" but this is an INPUT plugin, similar to the issue on line 22. This should reference "this plugin" or "the plugin" for consistency and accuracy.

Apply this diff:

-| `log_supress_interval`              | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression.                                                                          | `0`         |
+| `log_supress_interval`              | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression.                                                                            | `0`         |

Note: This aligns with @alexakreizinger's previous suggestion.


22-22: Incorrect plugin type in log_level description.

Line 22 references "output plugin" but this is an INPUT plugin. This appears to be a copy-paste error from another plugin's documentation. The description should specify "this plugin" or "the plugin" to be accurate for an input context.

Apply this diff:

-| `log_level`                         | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section.                                                                                | `info`      |
+| `log_level`                         | Specifies the log level for this plugin. If not set here, the plugin uses the global log level specified in the `service` section of your configuration file.                                 | `info`      |

Note: This aligns with @alexakreizinger's previous suggestion.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 666e423 and f382640.

📒 Files selected for processing (1)
  • pipeline/inputs/opentelemetry.md (1 hunks)

eschabell and others added 5 commits November 9, 2025 17:04
Applying review suggestion.

Co-authored-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applying review suggestion.

Co-authored-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applying review suggestion.

Co-authored-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applying review suggestion.

Co-authored-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Applying review suggestion.

Co-authored-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Nov 9, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell
Copy link
Collaborator Author

All review comments processed and ai suggestions applied, merging.

@eschabell eschabell merged commit c21a472 into fluent:master Nov 9, 2025
8 checks passed
@eschabell eschabell deleted the erics_otel_in_fix branch November 9, 2025 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken code example tabs on OpenTelemetry Input Plugin doc

3 participants