Skip to content

out_kinesis_firehose: introduce port parameter #10660

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

runderwo
Copy link

@runderwo runderwo commented Jul 29, 2025

This mirrors the same for Kinesis Streams in #9317

The port parameter is migrated to uint16_t for correctness.


Enter [N/A] in the box, if an item is not applicable to your change.

Testing
Before we can approve your change; please submit the following in a comment:

  • Example configuration file for the change
  • Debug log output from testing the change
  • Attached Valgrind output that shows no leaks or memory corruption was found

If this is a change to packaging of containers or native binaries then please confirm it works for all targets.

  • Run local packaging test showing all targets (including any new ones) build.
  • Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

  • Documentation required for this feature

Backporting

  • Backport to latest stable release.

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of custom port numbers for Kinesis Firehose and Kinesis Streams output plugins, ensuring proper validation and assignment of port values.
    • Enhanced error logging for invalid port configurations.
  • Refactor

    • Updated internal logic to use unsigned 16-bit integers for port values and removed obsolete port range constants.
    • Introduced a default HTTPS port constant for more consistent configuration.

@runderwo
Copy link
Author

example config:

  outputs:
    - name: kinesis_firehose
      match: "kinesis_*"
      region: us-east-1
      delivery_stream: mystream
      profile: firehose
      host: logs.cloud.loadbalancer.com
      port: 15173

There isn't any interesting log output, but tcpdump proves it's working:

19:02:12.777256 IP 192.168.254.210.38238 > 3.231.133.249.15173: Flags [.], ack 1, win 502, options [nop,nop,TS val 3607838653 ecr 1038761701], length 0
19:02:12.780031 IP 192.168.254.210.38238 > 3.231.133.249.15173: Flags [P.], seq 1:518, ack 1, win 502, options [nop,nop,TS val 3607838656 ecr 1038761701], length 517

@agup006
Copy link
Member

agup006 commented Aug 5, 2025

Approving the unit tests and tagging @cosmo0920 to take a look

@agup006
Copy link
Member

agup006 commented Aug 5, 2025

@runderwo we will also need DCO / signed commits (https://github.com/apps/dco)

Copy link
Contributor

@cosmo0920 cosmo0920 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically, the change should be valid but I'm wondering that is there any reason to be removed the validation of port range? Isn't it worth for the validation of the port range?

@cosmo0920
Copy link
Contributor

Plus, we need to add Signed-off line in this commit: 4f35d08

Copy link

coderabbitai bot commented Aug 6, 2025

Walkthrough

The changes update the port handling logic for both the Kinesis Firehose and Kinesis Streams output plugins. Port assignment is now dynamic, using the port specified in the output instance configuration or defaulting to 443 if unspecified. Structs are updated to use uint16_t for port storage, and related macros are adjusted or removed.

Changes

Cohort / File(s) Change Summary
Kinesis Firehose Port Handling
plugins/out_kinesis_firehose/firehose.c, plugins/out_kinesis_firehose/firehose.h
Port assignment in Firehose output is now based on the instance configuration, defaulting to 443 if unspecified. Added a macro for the default port, a port field to the context struct, and updated logic to validate and assign the port dynamically with error handling and debug logs.
Kinesis Streams Port Handling & Struct Update
plugins/out_kinesis_streams/kinesis.c, plugins/out_kinesis_streams/kinesis.h
Updated Streams output logic to assign port dynamically and validate as uint16_t. Changed the port field in the context struct to uint16_t and removed obsolete min/max port macros. Error handling and logging updated accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OutputInstance
    participant PluginContext

    User->>OutputInstance: Configure host and port
    OutputInstance->>PluginContext: Initialize with host and port
    PluginContext->>PluginContext: If port == 0, set to default (443)
    PluginContext->>PluginContext: If port valid (1-65535), assign
    PluginContext->>PluginContext: Else, log error and abort
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A rabbit hopped to ports anew,
From hardwired numbers, now we flew.
Dynamic checks with gentle care,
No more magic numbers there!
With structs updated, macros trimmed,
Our codebase shines, no longer dimmed.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 cb56e6a and d6776a3.

📒 Files selected for processing (4)
  • plugins/out_kinesis_firehose/firehose.c (2 hunks)
  • plugins/out_kinesis_firehose/firehose.h (2 hunks)
  • plugins/out_kinesis_streams/kinesis.c (1 hunks)
  • plugins/out_kinesis_streams/kinesis.h (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • plugins/out_kinesis_firehose/firehose.c
  • plugins/out_kinesis_firehose/firehose.h
  • plugins/out_kinesis_streams/kinesis.h
  • plugins/out_kinesis_streams/kinesis.c
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@cosmo0920 cosmo0920 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, we need to add some prefixes into commit messages like:

out_kinesis_firehose: [And the descriptions of the change]

This mirrors the same for Kinesis Streams in
fluent#9317

Signed-off-by: Ryan Underwood <[email protected]>
@runderwo runderwo changed the title Introduce port parameter for Kinesis Firehose output plugin out_kinesis_firehose: introduce port parameter Aug 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants