Added Apollo Tracing support for @defer.

You can now view traces in Apollo Studio as normal. Fixes #1600
apollographql · Dec 1, 2022 · b77af19 · b77af19
1 parent 736066d
commit b77af19
Show file tree

Hide file tree

Showing 16 changed files with 5,138 additions and 337 deletions.
diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md
@@ -238,6 +238,12 @@ supergraph:
 
 By [@Geal](https://github.com/Geal) in https://github.com/apollographql/router/pull/2155
 
+### `@defer` Apollo tracing support ([Issue #1600](https://github.com/apollographql/router/issues/1600))
+
+Added Apollo tracing support for queries that use `@defer`. You can now view traces in Apollo Studio as normal.
+
+By [@bryncooke](https://github.com/bryncooke) in https://github.com/apollographql/router/pull/2190
+
 ## 🐛 Fixes
 
 ### fix build_docker_image.sh script when using default repo ([PR #2163](https://github.com/apollographql/router/pull/2163))

diff --git a/apollo-router/Cargo.toml b/apollo-router/Cargo.toml
@@ -202,7 +202,7 @@ uname = "0.1.1"
 uname = "0.1.1"
 
 [dev-dependencies]
-insta = { version = "1.21.2", features = ["json", "redactions"] }
+insta = { version = "1.21.2", features = ["json", "redactions", "yaml"] }
 introspector-gadget = "0.1.0"
 maplit = "1.0.2"
 memchr = { version = "2.5.0", default-features = false }

diff --git a/apollo-router/src/plugins/telemetry/apollo_exporter.rs b/apollo-router/src/plugins/telemetry/apollo_exporter.rs
@@ -1,4 +1,5 @@
 //! Configuration for apollo telemetry exporter.
+use std::sync::{Arc, Mutex};
 // This entire file is license key functionality
 use std::time::Duration;
 
@@ -31,20 +32,26 @@ pub(crate) const POOL_TIMEOUT: Duration = Duration::from_secs(5);
 pub(crate) enum Sender {
     Noop,
     Spaceport(mpsc::Sender<SingleReport>),
+    #[cfg(test)]
+    InMemory(Arc<Mutex<Vec<SingleReport>>>),
 }
 
 impl Sender {
-    pub(crate) fn send(&self, metrics: SingleReport) {
+    pub(crate) fn send(&self, report: SingleReport) {
         match &self {
             Sender::Noop => {}
             Sender::Spaceport(channel) => {
-                if let Err(err) = channel.to_owned().try_send(metrics) {
+                if let Err(err) = channel.to_owned().try_send(report) {
                     tracing::warn!(
                         "could not send metrics to spaceport, metric will be dropped: {}",
                         err
                     );
                 }
             }
+            #[cfg(test)]
+            Sender::InMemory(storage) => {
+                storage.lock().expect("mutex poisoned").push(report);
+            }
         }
     }
 }

diff --git a/apollo-router/src/plugins/telemetry/mod.rs b/apollo-router/src/plugins/telemetry/mod.rs
@@ -122,7 +122,6 @@ const CLIENT_VERSION: &str = "apollo_telemetry::client_version";
 const ATTRIBUTES: &str = "apollo_telemetry::metrics_attributes";
 const SUBGRAPH_ATTRIBUTES: &str = "apollo_telemetry::subgraph_metrics_attributes";
 pub(crate) const STUDIO_EXCLUDE: &str = "apollo_telemetry::studio::exclude";
-pub(crate) const FTV1_DO_NOT_SAMPLE: &str = "apollo_telemetry::studio::ftv1_do_not_sample";
 pub(crate) const LOGGING_DISPLAY_HEADERS: &str = "apollo_telemetry::logging::display_headers";
 pub(crate) const LOGGING_DISPLAY_BODY: &str = "apollo_telemetry::logging::display_body";
 const DEFAULT_SERVICE_NAME: &str = "apollo-router";
@@ -281,13 +280,6 @@ impl Plugin for Telemetry {
     fn execution_service(&self, service: execution::BoxService) -> execution::BoxService {
         ServiceBuilder::new()
             .instrument(move |req: &ExecutionRequest| {
-                // disable ftv1 sampling for deferred queries
-                let do_not_sample_reason = if req.query_plan.root.contains_condition_or_defer() {
-                    req.context.insert(FTV1_DO_NOT_SAMPLE, true).unwrap();
-                    "query is deferred"
-                } else {
-                    ""
-                };
                 let query = req
                     .supergraph_request
                     .body()
@@ -304,7 +296,6 @@ impl Plugin for Telemetry {
                     graphql.document = query.as_str(),
                     graphql.operation.name = operation_name.as_str(),
                     "otel.kind" = %SpanKind::Internal,
-                    ftv1.do_not_sample_reason = do_not_sample_reason
                 )
             })
             .service(service)
@@ -707,7 +698,7 @@ impl Telemetry {
                 apollo_private.http.request_headers = field::Empty
             );
 
-            if is_span_sampled(&request.context) {
+            if is_span_sampled() {
                 span.record(
                     "apollo_private.graphql.variables",
                     &Self::filter_variables_values(
@@ -1185,7 +1176,7 @@ impl Telemetry {
         has_errors: bool,
         duration: Duration,
     ) {
-        if is_span_sampled(context) {
+        if is_span_sampled() {
             ::tracing::trace!("span is sampled then skip the apollo metrics");
             return;
         }
@@ -1294,12 +1285,8 @@ fn handle_error<T: Into<opentelemetry::global::Error>>(err: T) {
 }
 
 #[inline]
-pub(crate) fn is_span_sampled(context: &Context) -> bool {
+pub(crate) fn is_span_sampled() -> bool {
     Span::current().context().span().span_context().is_sampled()
-        && !context
-            .get(FTV1_DO_NOT_SAMPLE)
-            .unwrap_or_default()
-            .unwrap_or(false)
 }
 
 register_plugin!("apollo", "telemetry", Telemetry);
@@ -1315,7 +1302,7 @@ enum ApolloFtv1Handler {
 impl ApolloFtv1Handler {
     fn request_ftv1(&self, mut req: SubgraphRequest) -> SubgraphRequest {
         if let ApolloFtv1Handler::Enabled = self {
-            if is_span_sampled(&req.context) {
+            if is_span_sampled() {
                 req.subgraph_request.headers_mut().insert(
                     "apollo-federation-include-trace",
                     HeaderValue::from_static("ftv1"),

diff --git a/apollo-router/src/plugins/telemetry/tracing/apollo.rs b/apollo-router/src/plugins/telemetry/tracing/apollo.rs
@@ -11,7 +11,7 @@ use crate::plugins::telemetry::tracing::TracingConfigurator;
 use crate::spaceport::Trace;
 
 impl TracingConfigurator for Config {
-    fn apply(&self, builder: Builder, trace_config: &config::Trace) -> Result<Builder, BoxError> {
+    fn apply(&self, builder: Builder, _trace_config: &config::Trace) -> Result<Builder, BoxError> {
         tracing::debug!("configuring Apollo tracing");
         Ok(match self {
             Config {
@@ -28,7 +28,6 @@ impl TracingConfigurator for Config {
 
                 let exporter = apollo_telemetry::Exporter::builder()
                     .expose_trace_id_config(expose_trace_id.clone())
-                    .trace_config(trace_config.clone())
                     .endpoint(endpoint.clone())
                     .apollo_key(key)
                     .apollo_graph_ref(reference)