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

document transmit_decoded_records configuration option #307

Conversation

patrickdemers6
Copy link
Collaborator

Description

Improving documentation of transmit_decoded_records.

Fixes #256

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
@@ -56,6 +56,7 @@ For ease of installation and operation, run Fleet Telemetry on Kubernetes or a s
"json_log_enable": bool,
"namespace": string - kafka topic prefix,
"reliable_ack": bool - for use with reliable datastores, recommend setting to true with kafka,
"transmit_decoded_records": bool - if true, transmit JSON to dispatchers instead of proto. false is recommended as using protos improves codebase maintainability.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: recommend removing false is recommended as using protos improves codebase maintainability

@patrickdemers6 patrickdemers6 force-pushed the document-transmit-decoded-records branch from 32712fa to b214980 Compare January 16, 2025 19:28
@patrickdemers6 patrickdemers6 merged commit 1fc5ead into teslamotors:main Jan 22, 2025
1 check passed
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.

prefer_typed changes the values of strings
2 participants