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

Allow transmitting data in json bytes #95

Merged
merged 1 commit into from
Jan 10, 2024

Conversation

agbpatro
Copy link
Collaborator

@agbpatro agbpatro commented Jan 10, 2024

Description

Allowing option to send messages to producers in json instead of proto. This way, consumers wont have to decode the protobuf message. Idea based on conversation #91 (comment)

Type of change

Please select all options that apply to this change:

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Checklist:

Confirm you have completed the following steps:

  • My code follows the style of this project.
  • I have performed a self-review of my code.
  • I have made corresponding updates to the documentation.
  • I have added/updated unit tests to cover my changes.
  • I have added/updated integration tests to cover my changes.

README.md Outdated
@@ -132,7 +132,7 @@ The following [dispatchers](./telemetry/producer.go#L10-L19) are supported
* ZMQ: Configure with the config.json file. See implementation here: [config/config.go](./config/config.go)
* Logger: This is a simple STDOUT logger that serializes the protos to json.

>NOTE: To add a new dispatcher, please provide integration tests and updated documentation.
>NOTE: To add a new dispatcher, please provide integration tests and updated documentation. If you wish to send data to dispatcher in json instead protobuf, add a config `transmit_decoded_records` and set value to `true` as shown [here](config/test_configs_test.go#L104)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Lets not use "you" "your" "we" etc in documentation as it's less formal. This can be reworded to: "To serialize dispatcher data as json instead of protobufs, add a config transmit_decoded_records and set value to true as shown here"

@agbpatro agbpatro force-pushed the allow_transmitting_decoded_messages branch from 03b0d2e to 9f48c1b Compare January 10, 2024 21:25
@agbpatro agbpatro force-pushed the allow_transmitting_decoded_messages branch from 9f48c1b to e29efc5 Compare January 10, 2024 21:28
@agbpatro agbpatro merged commit 86e9a32 into main Jan 10, 2024
@agbpatro agbpatro deleted the allow_transmitting_decoded_messages branch January 10, 2024 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants