document transmit_decoded_records configuration option

teslamotors · Jan 16, 2025 · b214980 · b214980
1 parent 00e5880
commit b214980
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -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.
   "monitoring": {
     "prometheus_metrics_port": int,
     "profiler_port": int,

diff --git a/config/config.go b/config/config.go
@@ -90,6 +90,7 @@ type Config struct {
 	Records map[string][]telemetry.Dispatcher `json:"records,omitempty"`
 
 	// TransmitDecodedRecords if true decodes proto message before dispatching it to supported datastores
+	// when vehicle configuration has prefer_typed set to true, enum fields will have a prefix
 	TransmitDecodedRecords bool `json:"transmit_decoded_records,omitempty"`
 
 	// MetricCollector collects metrics for the application