-
Notifications
You must be signed in to change notification settings - Fork 545
in_opentelemetry: fix typo and sort configuration parameters #2298
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
…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>
WalkthroughThe pull request corrects a typo in OpenTelemetry input plugin documentation by renaming the configuration key Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
|
@alexakreizinger a new PR with some changes for your review. |
There was a problem hiding this 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
📒 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_sizeshould remain beforebuffer_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.*beforethreadedimproves scanability and matches the PR objective.
49-51: TLS keys ordering matches the stated convention (tls.ciphersbeforetls.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` | |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe this doc? https://docs.fluentbit.io/manual/administration/multithreading
| | `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` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| | `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` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| | `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 :)
alexakreizinger
left a comment
There was a problem hiding this 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!
Applies to #2209.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.