feat(tvix/tracing): gRPC trace context propagation
This introduces optional helper function in tvix/tracing for trace propagation and uses these helper in the `tvix-store`. The GRPCBlobService, GRPCDirectoryService and GRPCPathInfoService now accept a generic client, meaning the client can be generated with either `::new` or `::with_interceptor`. This was tested and validated by starting a `tvix-store daemon` and `tvix-store import`. Change-Id: I4b194483bf09266820104b4b56e4a135dca2b77a Reviewed-on: https://cl.tvl.fyi/c/depot/+/11863 Reviewed-by: flokli <flokli@flokli.de> Tested-by: BuildkiteCI
This commit is contained in:
parent
2b20d8d82d
commit
639a00e2ab
18 changed files with 399 additions and 48 deletions
9
tvix/tracing/src/propagate/mod.rs
Normal file
9
tvix/tracing/src/propagate/mod.rs
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
#[cfg(feature = "tonic")]
|
||||
pub mod tonic;
|
||||
|
||||
// TODO: Helper library for reqwest. We could use
|
||||
// https://github.com/TrueLayer/reqwest-middleware/tree/main/reqwest-tracing to realise this
|
||||
|
||||
// TODO: Helper library for axum or another http server, see
|
||||
// https://github.com/hseeberger/hello-tracing-rs/blob/main/hello-tracing-common/src/otel/http.rs
|
||||
// as an example and we can reuse tonic::accept_trace fun, at least for a tower::ServiceBuilder
|
||||
59
tvix/tracing/src/propagate/tonic.rs
Normal file
59
tvix/tracing/src/propagate/tonic.rs
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
use tonic::{
|
||||
metadata::{MetadataKey, MetadataMap, MetadataValue},
|
||||
Status,
|
||||
};
|
||||
use tracing::{warn, Span};
|
||||
|
||||
#[cfg(feature = "otlp")]
|
||||
use opentelemetry::{global, propagation::Injector};
|
||||
#[cfg(feature = "otlp")]
|
||||
use opentelemetry_http::HeaderExtractor;
|
||||
#[cfg(feature = "otlp")]
|
||||
use tracing_opentelemetry::OpenTelemetrySpanExt;
|
||||
|
||||
/// Trace context propagation: associate the current span with the otlp trace of the given request,
|
||||
/// if any and valid. This only sets the parent trace if the otlp feature is also enabled.
|
||||
pub fn accept_trace<B>(request: http::Request<B>) -> http::Request<B> {
|
||||
// we only extract and set a parent trace if otlp feature is enabled, otherwise this feature is
|
||||
// an noop and we return the request as is
|
||||
#[cfg(feature = "otlp")]
|
||||
{
|
||||
// Current context, if no or invalid data is received.
|
||||
let parent_context = global::get_text_map_propagator(|propagator| {
|
||||
propagator.extract(&HeaderExtractor(request.headers()))
|
||||
});
|
||||
Span::current().set_parent(parent_context);
|
||||
}
|
||||
request
|
||||
}
|
||||
|
||||
#[cfg(feature = "otlp")]
|
||||
struct MetadataInjector<'a>(&'a mut MetadataMap);
|
||||
|
||||
#[cfg(feature = "otlp")]
|
||||
impl Injector for MetadataInjector<'_> {
|
||||
fn set(&mut self, key: &str, value: String) {
|
||||
match MetadataKey::from_bytes(key.as_bytes()) {
|
||||
Ok(key) => match MetadataValue::try_from(&value) {
|
||||
Ok(value) => {
|
||||
self.0.insert(key, value);
|
||||
}
|
||||
Err(error) => warn!(value, error = format!("{error:#}"), "parse metadata value"),
|
||||
},
|
||||
Err(error) => warn!(key, error = format!("{error:#}"), "parse metadata key"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Trace context propagation: send the trace context by injecting it into the metadata of the given
|
||||
/// request. This only injects the current span if the otlp feature is also enabled.
|
||||
pub fn send_trace<T>(mut request: tonic::Request<T>) -> Result<tonic::Request<T>, Status> {
|
||||
#[cfg(feature = "otlp")]
|
||||
{
|
||||
global::get_text_map_propagator(|propagator| {
|
||||
let context = Span::current().context();
|
||||
propagator.inject_context(&context, &mut MetadataInjector(request.metadata_mut()))
|
||||
});
|
||||
}
|
||||
Ok(request)
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue