"Add 'otel' feature for OpenTelemetry support #97
Conversation
Enabling the 'otel' feature conditionally includes OpenTelemetry and related tracing functionalities, allowing method-level tracing and context propagation." Signed-off-by: Likhith Thammegowda <[email protected]>
databroker/src/broker.rs
Outdated
| if let Some(metadata_description) = update.description { | ||
| self.metadata.description = metadata_description; | ||
| // changed.insert(Field::ActuatorTarget); | ||
| } |
There was a problem hiding this comment.
these changes at description are not mergeable we need to find another way to propagate the context to the client/provider.
There was a problem hiding this comment.
I was thinking if we could add this to the types.proto file
message MetadataMap {
map<string, string> headers = 1;
}
message Metadata {
optional MetadataMap otel_context = 18; // to add this field alongside already existing fields in Metadata
}
By doing this, a new field is added to Metadata alongside description, while allowing the description to continue functioning as before ( I will revert all changes made to the description, ensuring it functions as it originally did ).
MetadataMap could be used for otel context propagation and here is the output of subscribe call with the field otel_context:
{
"updates": [
{
"fields": [
"FIELD_VALUE"
],
"entry": {
"path": "Vehicle.Speed",
"value": {
"timestamp": {
"seconds": "1733672625",
"nanos": 127403578
},
"float": 22
},
"actuator_target": null,
"metadata": {
"data_type": "DATA_TYPE_UNSPECIFIED",
"entry_type": "ENTRY_TYPE_UNSPECIFIED",
"value_restriction": null,
"description": "Odometer reading, total distance traveled during the lifetime of the vehicle.",
"unit": "km/h",
"otel_context": {
"headers": {
"tracestate": "",
"traceparent": "00-d9b7e6227856aefc7fe4ba0e142e2017-b6923a717115ffae-01"
}
}
}
}
}
]
}
I have tested this change locally and it works as expected.
Please let me know if this approach is acceptable.
There was a problem hiding this comment.
no changes in proto as of now. Could you confirm that the tracing stuff is working with the context stuff removed?
There was a problem hiding this comment.
Yes, I have created a new pull request #119 containing just the tracing functionality.
I have tested this change locally and it works fine.
|
no documentation how to start etc. would be nice if there would be something. As well as an example of a client & provider example for context propagation. |
|
I will add readme explaining environment variables required and context propagation mechanism between the clients and the databroker in detail in this branch testing-main. |
Enabling the 'otel' feature conditionally includes OpenTelemetry and related tracing functionalities, allowing method-level tracing and context propagation."