Skip to content
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

Kafka Connector - Add ability to read and write headers #1016

Closed
Tracked by #2758
rd-andreas-beckmann opened this issue Aug 9, 2023 · 0 comments · Fixed by #1287 or camunda/camunda-docs#2758
Closed
Tracked by #2758
Assignees
Labels
kind:enhancement New feature or request support Support ticket version:8.3.3 version:8.4.0 Label that represents issues released on verions 8.4.0

Comments

@rd-andreas-beckmann
Copy link

rd-andreas-beckmann commented Aug 9, 2023

Is your feature request related to a problem? Please describe.

Headers are used to communicate meta information (e.g. correlation ids) between services. This requires the ability to read and write header values, which is currently not supported within the out-of-the-box kafka connector.

Describe the solution you'd like

Depending on the inbound/outbound-connector, following solution would be desirable:

Inbound
Similarly to the key and value properties of the received object, an additional header attribute containing the header information as json object would resolve the need. This solution should be backwards compatible and not require any changes to preexisting integrations.

{
    "key": "...",
    "rawValue": {[...]},
    "value": {[...]},
    "headers":{
        "headerKey1":"headerValue"
        "headerKey2":"headerValue2"
    }
}

Outbound

Adding a headers property within the message group (similarly to the key and value properties), would resolve the need. Making the property optional, would ensure backwards compatibility. Setting the headers as json Object Strings

{
     "headerKey1":"headerValue"
     "headerKey2":"headerValue2"
}

would enable setting the values dynamically as part of a workflow.

Describe alternatives you've considered
Not applicable

Additional context
If needed, a mock of the outbound template can be created.

Additional ticket: https://jira.camunda.com/browse/SUPPORT-18647

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:enhancement New feature or request support Support ticket version:8.3.3 version:8.4.0 Label that represents issues released on verions 8.4.0
Projects
None yet
4 participants