Update kafka types #3199
Merged
Update kafka types #3199
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
+46
to
+52
| enable_batching: { | ||
| type: 'boolean', | ||
| label: 'Batch Data to Kafka?', | ||
| description: 'If true, Segment will batch events before sending to Kafka.', | ||
| default: true, | ||
| unsafe_hidden: true | ||
| }, |
There was a problem hiding this comment.
Should we be setting the max batch size too, or is that not needed?
There was a problem hiding this comment.
No Batch size limit as such by kafka.
Comment on lines
+53
to
61
| batch_keys: { | ||
| label: 'Batch Keys', | ||
| description: 'The keys to use for batching the events.', | ||
| type: 'string', | ||
| unsafe_hidden: true, | ||
| required: false, | ||
| multiple: true, | ||
| default: ['partition', 'default_partition'] | ||
| } |
There was a problem hiding this comment.
What do these 2 keys do? What other keys are there? Will be doing a control plane migration for this field too?
itsarijitray
added a commit
that referenced
this pull request
Sep 4, 2025
* Update kafka error handling * Update kafka error handling * add tests * modify error reporting * add tests * add tests * add tests * Update kafka types (#3199) * add metrics to track batch keys * add metrics to track batch keys * Remove reties for kafka client * add test * add topic as batch keys * add topic as batch keys
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the Kafka destination integration by improving the batching capabilities and clarifying authentication options. The most significant changes include adding new batching-related fields to the payload and action definition, and removing AWS IAM as a selectable authentication mechanism in the documentation and configuration.
Batching Enhancements:
enable_batching(boolean) andbatch_keys(string array) fields to thePayloadinterface ingenerated-types.ts, allowing events to be optionally batched before sending to Kafka.send/index.tsto support the new batching options, including labels, descriptions, default values, and hiding these fields from the UI by default.Authentication Mechanism Clarification:
mechanismproperty in bothgenerated-types.tsandindex.ts, leaving only SCRAM, PLAIN, and Client Certificate as options. [1] [2]Screenshots:
Instance: https://app.segment.build/arijit-dev/destinations/actions-kafka/sources/http_api/instances/6880c59b62bcbb1aabdd3887/actions/mQBdMEYYKWsh6Fx2JCQeEt
Note: We need to run a ctl-plane-migration to enable batching as default for kafka.
WIP: https://github.com/segmentio/control-plane/pull/6191
Testing
Include any additional information about the testing you have completed to
ensure your changes behave as expected. For a speedy review, please check
any of the tasks you completed below during your testing.