docs: outputs: kafka: document otlp_logs_partition_by_resource parameter#2573
docs: outputs: kafka: document otlp_logs_partition_by_resource parameter#2573eschabell wants to merge 1 commit into
Conversation
- Add `otlp_logs_partition_by_resource` boolean parameter to the
configuration parameters table
Note, covers a code update without a doc update PR.
Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughThis PR adds documentation for a new Kafka output configuration parameter ChangesKafka Output Parameter Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
pipeline/outputs/kafka.md (1)
27-27: 💤 Low valueConsider clarifying the boolean behavior in the description.
The description could be more explicit about what happens when the parameter is enabled versus disabled. Consider rephrasing to:
"When enabled, send logs from each OTLP resource as separate Kafka messages when using
otlp_jsonorotlp_protoformat."This makes it clearer that the behavior described occurs when the parameter is set to
true.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/outputs/kafka.md` at line 27, Reword the description for the otlp_logs_partition_by_resource option to explicitly state the true/false behavior: when otlp_logs_partition_by_resource is true, send logs from each OTLP resource as separate Kafka messages when using otlp_json or otlp_proto format; when false, do not partition by resource (send logs as they currently are). Update the text that currently reads "When using `otlp_json` or `otlp_proto` format for logs, send each OTLP resource's logs as a separate Kafka message." to the clearer phrasing referencing enabled/disabled behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@pipeline/outputs/kafka.md`:
- Line 27: Reword the description for the otlp_logs_partition_by_resource option
to explicitly state the true/false behavior: when
otlp_logs_partition_by_resource is true, send logs from each OTLP resource as
separate Kafka messages when using otlp_json or otlp_proto format; when false,
do not partition by resource (send logs as they currently are). Update the text
that currently reads "When using `otlp_json` or `otlp_proto` format for logs,
send each OTLP resource's logs as a separate Kafka message." to the clearer
phrasing referencing enabled/disabled behavior.
|
Be nice to have an example use case? |
2 participants
otlp_logs_partition_by_resourceboolean parameter to the configuration parameters tableNote, covers a code update without a doc update PR.
Summary by CodeRabbit
otlp_logs_partition_by_resourceconfiguration parameter for Kafka output, which controls whether logs from each OTLP resource are sent as separate Kafka messages when usingotlp_jsonorotlp_protoformats.