Skip to content

docs: outputs: kafka: general doc update and fixes#2436

Open
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_kafka_updates
Open

docs: outputs: kafka: general doc update and fixes#2436
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_kafka_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 17, 2026

  • Sort configuration parameters table alphabetically
  • Add missing config params
  • Fix dynamic_topic default: Offfalse
  • 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 #2412

Summary by CodeRabbit

  • Documentation
    • Updated Kafka output documentation with new configuration parameters for AWS MSK IAM, GELF support, and message handling.
    • Replaced deprecated host parameter with brokers in configuration examples for improved clarity.
    • Simplified AWS MSK IAM setup references in documentation.

  - 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>
@eschabell eschabell self-assigned this Mar 17, 2026
@eschabell eschabell requested a review from a team as a code owner March 17, 2026 09:57
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 17, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Kafka Output Documentation
pipeline/outputs/kafka.md
Added new configuration parameters (aws_msk_iam, brokers, client_id, dynamic_topic, gelf-related keys, schema_id/schema_str, timestamp_format, workers, etc.) to the configuration table. Replaced deprecated "host" references with "brokers" across examples. Simplified AWS MSK IAM section by redirecting to the configuration parameters table instead of duplicating content. Minor formatting and alignment adjustments in code blocks and descriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Hops through kafka streams with glee,
New brokers configured, wild and free!
Parameters sprouting like clover beds,
No more old hosts filling our heads!
Documentation hops renewed, we see! ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 main change: a general documentation update and fixes to the Kafka output configuration documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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

🤖 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+.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c9aed3e0-a4f7-4487-abec-62633fde882c

📥 Commits

Reviewing files that changed from the base of the PR and between 9691fb1 and 6844f7b.

📒 Files selected for processing (1)
  • pipeline/outputs/kafka.md

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant