docs: outputs: kafka: general doc update and fixes#2436
docs: outputs: kafka: general doc update and fixes#2436eschabell wants to merge 1 commit intofluent:masterfrom
Conversation
- Sort configuration parameters table alphabetically - Add missing config params - Fix `dynamic_topic` default: `Off` → `false` - Fix `format` description: add `gelf` and `avro` to available formats - Fix `topic_key`/`message_key_field` descriptions: Title_Case key names → lowercase - Fix YAML examples: `host:` → `brokers:` (`host` is not a valid param) - Fix `Parser some-parser` alignment in classic Avro config example - Replace non-standard AWS MSK IAM parameters table with reference to main table Applies to fluent#2412 Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughThe Kafka output documentation is updated with new configuration parameters, deprecated parameter replacements, and revised examples. The documentation switches from using "host" to "brokers," consolidates AWS MSK IAM references, and adds recently introduced configuration options to the parameter table. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@pipeline/outputs/kafka.md`:
- Around line 14-15: Remove the stale output parameter `aws_msk_iam_cluster_arn`
from the Kafka output parameters table and from any examples/usages that
reference it (e.g., the YAML example and the paragraph describing required
parameters), and update surrounding text to reflect that Fluent Bit v4.0.4+
auto-detects the MSK region when using `rdkafka.sasl.mechanism: aws_msk_iam`;
search for every occurrence of the symbol `aws_msk_iam_cluster_arn` and delete
the table row, remove it from example YAML, and replace explanatory text with a
short note about auto-detection in v4.0.4+.
|
@cosmo0920 and @patrick-stephens ready for review! |
dynamic_topicdefault:Off→falseformatdescription: addgelfandavroto available formatstopic_key/message_key_fielddescriptions: Title_Case key names → lowercasehost:→brokers:(hostis not a valid param)Parser some-parseralignment in classic Avro config exampleApplies to #2412
Summary by CodeRabbit