Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Dec 12, 2025

  • Fix typo: log_supress_interval → log_suppress_interval
  • Sort configuration parameters alphabetically:
    • buffer_chunk_size before buffer_max_size
    • thread.ring_buffer.* before threaded
    • tls.ciphers before tls.crt_file

Applies to #2209.

Summary by CodeRabbit

  • Documentation
    • Renamed configuration parameter to log_suppress_interval and clarified its behavior (0 = no suppression).
    • Clarified buffer size and threading descriptions (including ring buffer capacity/window and multithreading behavior) without changing defaults or semantics.
    • Retained TLS certificate option details and improved ordering/formatting for readability.

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

@eschabell eschabell self-assigned this Dec 12, 2025
@eschabell eschabell requested review from a team as code owners December 12, 2025 15:48
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 4.2.1 labels Dec 12, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 12, 2025

Walkthrough

Renames config key log_supress_interval to log_suppress_interval and updates wording, ordering, and threading descriptions in the OpenTelemetry input plugin docs; buffer_max_size and tls.crt_file rows were repositioned or rephrased. No semantic or default-value changes.

Changes

Cohort / File(s) Summary
OpenTelemetry input docs
pipeline/inputs/opentelemetry.md
Renamed log_supress_intervallog_suppress_interval; reordered buffer_max_size; expanded and clarified threading entries (thread.ring_buffer.capacity, thread.ring_buffer.window, and threaded) and adjusted tls.crt_file placement/formatting. No behavioral changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single documentation file; spelling/ordering and phrasing edits only.
  • Check the renamed key occurrences and table formatting for consistency.

Possibly related PRs

Suggested labels

4.2.1

Suggested reviewers

  • alexakreizinger
  • esmerel

Poem

🐰 I hopped through docs with a twitch and a whisk,

I fixed a typo quick—no need to risk.
Threads and buffers now neatly described,
Keys renamed gently, no logic denied.
A tiny rabbit cheer for docs well-tidied! 🎉🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the two main changes: fixing a typo (log_supress_interval → log_suppress_interval) and sorting configuration parameters alphabetically in the OpenTelemetry input documentation.
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 cf9fc04 and 36e3bbc.

📒 Files selected for processing (1)
  • pipeline/inputs/opentelemetry.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pipeline/inputs/opentelemetry.md

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.

@eschabell
Copy link
Collaborator Author

@alexakreizinger a new PR with some changes for your review.

@eschabell eschabell added 4.2 and removed 4.2.1 labels Dec 12, 2025
Copy link
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.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6d31204 and 8cd1777.

📒 Files selected for processing (1)
  • pipeline/inputs/opentelemetry.md (2 hunks)
🔇 Additional comments (3)
pipeline/inputs/opentelemetry.md (3)

16-18: Keep key ordering consistent: buffer_chunk_size should remain before buffer_max_size.

This section looks correct as shown (and matches the PR objective).


43-46: Threading options ordering matches the stated convention.

Placing thread.ring_buffer.* before threaded improves scanability and matches the PR objective.


49-51: TLS keys ordering matches the stated convention (tls.ciphers before tls.crt_file).

Looks consistent with the sorting objective.

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.

added a few suggestions, but pending those LGTM!

…ically

- Fix typo: log_supress_interval → log_suppress_interval
- Sort configuration parameters alphabetically:
  - buffer_chunk_size before buffer_max_size
  - thread.ring_buffer.* before threaded
  - tls.ciphers before tls.crt_file
- Improve thread.ring_buffer.capacity and thread.ring_buffer.window descriptions
- Add links to multithreading administration doc for threading parameters

Applies to fluent#2209.

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

Fixes and suggestions applied, merging.

@eschabell eschabell merged commit d261f6a into fluent:master Dec 15, 2025
6 of 8 checks passed
@eschabell eschabell deleted the erics_in_otel_fixes branch December 17, 2025 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

4.2 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants