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
    • Updated OpenTelemetry input plugin documentation to reflect correct configuration parameter naming conventions and ensure consistency and accuracy throughout all reference materials.
    • Improved overall documentation formatting and structure to enhance visual clarity and make it easier for users to understand and properly implement the plugin configuration.

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

…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

Applies to fluent#2209.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@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

The pull request corrects a typo in OpenTelemetry input plugin documentation by renaming the configuration key log_supress_interval to log_suppress_interval. Minor formatting adjustments accompany the change.

Changes

Cohort / File(s) Summary
Documentation typo fix
pipeline/inputs/opentelemetry.md
Renamed configuration key log_supress_interval to log_suppress_interval (spelling correction) and adjusted formatting around related configuration options

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single file change limited to documentation
  • Straightforward typo correction with no semantic impact
  • No functional logic or control flow implications

Possibly related PRs

Suggested reviewers

  • alexakreizinger
  • esmerel

Poem

🐰 A hop through the docs, a typo caught clear,
"Suppress" spells right—the fix brings good cheer,
One letter stood wrong, now tidy and true,
Attention to detail, that's what we do!

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 both main changes: fixing a typo (log_suppress_interval) and sorting configuration parameters in the OpenTelemetry input plugin 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

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.

| `threaded` | Enable threading on an input. | `false` |
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
| `threaded` | Enable threading on an input. | `false` |
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd probably link out to what this means somewhere.

Copy link
Member

Choose a reason for hiding this comment

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

| `listen` | The network address to listen on. | `0.0.0.0` |
| `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` |
| `log_supress_interval` | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
| `log_suppress_interval` | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| `log_suppress_interval` | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
| `log_suppress_interval` | Suppresses similar log messages from this plugin that appear within a specified time interval. A value of `0` sets no suppression. | `0` |

| `threaded` | Enable threading on an input. | `false` |
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
| `threaded` | Enable threading on an input. | `false` |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| `threaded` | Enable threading on an input. | `false` |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

copied this phrasing/link from a different plugin page :)

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!

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