fluent-bit-docs icon indicating copy to clipboard operation
fluent-bit-docs copied to clipboard

Document simple_aggregation for kinesis/firehose

Open ShelbyZ opened this issue 2 weeks ago β€’ 1 comments

Documentation for simple_aggregation added to out_kinesis_firehose and out_kinesis_streams - https://github.com/fluent/fluent-bit/pull/11284

Summary by CodeRabbit

  • Documentation
    • Added simple_aggregation configuration option for Firehose and Kinesis outputs. When enabled, multiple records are concatenated with newlines and sent as a single API call (up to 1,024,000 bytes per record). Defaults to false.

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

ShelbyZ avatar Dec 12 '25 23:12 ShelbyZ

Walkthrough

Adds documentation for a new simple_aggregation configuration parameter to the Firehose and Kinesis output docs. The parameter documents aggregating multiple records into single API calls by newline-concatenation, up to 1,024,000 bytes, defaulting to false.

Changes

Cohort / File(s) Summary
Documentation: Simple Aggregation Parameter
pipeline/outputs/firehose.md, pipeline/outputs/kinesis.md
Added documentation for a new simple_aggregation configuration parameter that enables aggregating multiple records into single API calls by concatenating records with newlines, with a 1,024,000 byte size limit. Default: false.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Review the two Markdown files for clarity, correctness of size limit and default value, and consistent wording between Firehose and Kinesis docs.

Poem

🐰 I nibble lines and stitch them tight,
Newlines bind records through the night,
Firehose, Kinesis β€” one packet to send,
Simple aggregation, a rabbit's friend,
βœ¨πŸ“¦

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 directly matches the changeset: it documents the simple_aggregation parameter addition for both Kinesis and Firehose outputs.
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

πŸ“œ Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between f352e35ca4d54cd7b7c3115b4f55729798017b1d and ce08c1557215863bbc15684c25038e20aac3008f.

πŸ“’ Files selected for processing (2)
  • pipeline/outputs/firehose.md (1 hunks)
  • pipeline/outputs/kinesis.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • pipeline/outputs/firehose.md
  • pipeline/outputs/kinesis.md

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.

coderabbitai[bot] avatar Dec 12 '25 23:12 coderabbitai[bot]

With https://github.com/fluent/fluent-bit/pull/11284 merged, should this get merged on v4.2.2 release as well?

ShelbyZ avatar Dec 22 '25 22:12 ShelbyZ

With fluent/fluent-bit#11284 merged, should this get merged on v4.2.2 release as well?

Yup, it should be merged after a release so please ping if not as sometimes gets missed - we cannot merge before a release as then folks see the new docs but have the old implementation.

patrick-stephens avatar Dec 23 '25 11:12 patrick-stephens