impl(otel): detach context from EndSpan(..., future<>) (#12902)

googleapis · Oct 17, 2023 · 3dddc28 · 3dddc28
1 parent 56fe3c6
commit 3dddc28
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 4 deletions.
diff --git a/google/cloud/internal/grpc_opentelemetry.h b/google/cloud/internal/grpc_opentelemetry.h
@@ -90,9 +90,12 @@ future<T> EndSpan(
     std::shared_ptr<grpc::ClientContext> context,
     opentelemetry::nostd::shared_ptr<opentelemetry::trace::Span> span,
     future<T> fut) {
-  return fut.then([c = std::move(context), s = std::move(span)](auto f) {
+  return fut.then([oc = opentelemetry::context::RuntimeContext::GetCurrent(),
+                   c = std::move(context), s = std::move(span)](auto f) {
+    auto t = f.get();
     ExtractAttributes(*c, *s);
-    return EndSpan(*s, f.get());
+    DetachOTelContext(oc);
+    return EndSpan(*s, std::move(t));
   });
 }
 

diff --git a/google/cloud/internal/grpc_opentelemetry_test.cc b/google/cloud/internal/grpc_opentelemetry_test.cc
@@ -140,6 +140,33 @@ TEST(OpenTelemetry, EndSpanFuture) {
           SpanHasAttributes(OTelAttribute<std::string>("grpc.peer", _)))));
 }
 
+TEST(OpenTelemetry, EndSpanFutureDetachesContext) {
+  auto span_catcher = InstallSpanCatcher();
+
+  // Set the `OTelContext` like we do in `AsyncOperation`s
+  auto c = opentelemetry::context::Context("key", true);
+  ScopedOTelContext scope({c});
+  EXPECT_EQ(c, opentelemetry::context::RuntimeContext::GetCurrent());
+
+  promise<Status> p;
+  auto f =
+      EndSpan(std::make_shared<grpc::ClientContext>(),
+              MakeSpanGrpc("google.cloud.foo.v1.Foo", "GetBar"), p.get_future())
+          .then([](auto f) {
+            auto s = f.get();
+            // The `OTelContext` should be cleared by the time we exit
+            // `EndSpan()`.
+            EXPECT_EQ(opentelemetry::context::Context{},
+                      opentelemetry::context::RuntimeContext::GetCurrent());
+            return s;
+          });
+
+  p.set_value(Status());
+  EXPECT_STATUS_OK(f.get());
+  EXPECT_THAT(span_catcher->GetSpans(),
+              ElementsAre(SpanNamed("google.cloud.foo.v1.Foo/GetBar")));
+}
+
 TEST(OpenTelemetry, TracedAsyncBackoffEnabled) {
   auto span_catcher = InstallSpanCatcher();
 

diff --git a/google/cloud/internal/opentelemetry.h b/google/cloud/internal/opentelemetry.h
@@ -16,6 +16,7 @@
 #define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_INTERNAL_OPENTELEMETRY_H
 
 #include "google/cloud/future.h"
+#include "google/cloud/internal/opentelemetry_context.h"
 #include "google/cloud/options.h"
 #include "google/cloud/status.h"
 #include "google/cloud/status_or.h"
@@ -178,8 +179,12 @@ template <typename T>
 future<T> EndSpan(
     opentelemetry::nostd::shared_ptr<opentelemetry::trace::Span> span,
     future<T> fut) {
-  return fut.then(
-      [s = std::move(span)](auto f) { return EndSpan(*s, f.get()); });
+  return fut.then([oc = opentelemetry::context::RuntimeContext::GetCurrent(),
+                   s = std::move(span)](auto f) {
+    auto t = f.get();
+    DetachOTelContext(oc);
+    return EndSpan(*s, std::move(t));
+  });
 }
 
 /**

diff --git a/google/cloud/internal/opentelemetry_test.cc b/google/cloud/internal/opentelemetry_test.cc
@@ -16,6 +16,7 @@
 #include "google/cloud/internal/make_status.h"
 #include "google/cloud/opentelemetry_options.h"
 #include "google/cloud/testing_util/opentelemetry_matchers.h"
+#include "google/cloud/testing_util/status_matchers.h"
 #include <gmock/gmock.h>
 #ifdef GOOGLE_CLOUD_CPP_HAVE_OPENTELEMETRY
 #include <opentelemetry/trace/default_span.h>
@@ -269,6 +270,28 @@ TEST(OpenTelemetry, EndSpanFutureStatusOr) {
                   SpanWithStatus(opentelemetry::trace::StatusCode::kError)));
 }
 
+TEST(OpenTelemetry, EndSpanFutureDetachesContext) {
+  auto span_catcher = InstallSpanCatcher();
+
+  // Set the `OTelContext` like we do in `AsyncOperation`s
+  auto c = opentelemetry::context::Context("key", true);
+  ScopedOTelContext scope({c});
+  EXPECT_EQ(c, opentelemetry::context::RuntimeContext::GetCurrent());
+
+  promise<Status> p;
+  auto f = EndSpan(MakeSpan("span"), p.get_future()).then([](auto f) {
+    auto s = f.get();
+    // The `OTelContext` should be cleared by the time we exit `EndSpan()`.
+    EXPECT_EQ(opentelemetry::context::Context{},
+              opentelemetry::context::RuntimeContext::GetCurrent());
+    return s;
+  });
+
+  p.set_value(Status());
+  EXPECT_STATUS_OK(f.get());
+  EXPECT_THAT(span_catcher->GetSpans(), ElementsAre(SpanNamed("span")));
+}
+
 TEST(OpenTelemetry, EndSpanVoid) {
   auto span_catcher = InstallSpanCatcher();