[WIP][SPARK-29228][SS] Adding the ability to add headers to the KafkaRecords published to Kafka from spark structured streaming #25916
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.
What changes were proposed in this pull request?
The changes in the pull request allow a developer to provide a column within their structured streaming dataframe titled
header
and of typemap<string, string>
which when the dataframe is sinked to kafka the headers will be applied to the producer record. This can have many applications but the main reason we wanted this introduced was for tracing purposes.Why are the changes needed?
Sometimes it is necessary to add custom headers to the kafka producer record but with the current spark-kafka sink this is not possible, these changes make it optional to add headers to the kafka records that will be produced.
Does this PR introduce any user-facing change?
If the user wants to apply headers in the records that will be published to kafka they can provide a new column of type
map<string, string>
with the titleheader
:How was this patch tested?
Unit tests have been added and it has been tested thoroughly on a cluster.