Simplify interop between instrumented java libraries and otel4s

typelevel · Oct 17, 2023 · 1704d78 · 1704d78
1 parent d860aeb
commit 1704d78
Show file tree

Hide file tree

Showing 2 changed files with 114 additions and 3 deletions.
diff --git a/java/all/src/main/scala/org/typelevel/otel4s/java/OtelJava.scala b/java/all/src/main/scala/org/typelevel/otel4s/java/OtelJava.scala
@@ -16,14 +16,17 @@
 
 package org.typelevel.otel4s.java
 
+import cats.MonadThrow
 import cats.effect.Async
 import cats.effect.IOLocal
 import cats.effect.LiftIO
 import cats.effect.Resource
 import cats.effect.Sync
+import cats.mtl.Local
 import cats.syntax.all._
 import io.opentelemetry.api.{OpenTelemetry => JOpenTelemetry}
 import io.opentelemetry.api.GlobalOpenTelemetry
+import io.opentelemetry.context.{Context => JContext}
 import io.opentelemetry.sdk.{OpenTelemetrySdk => JOpenTelemetrySdk}
 import org.typelevel.otel4s.ContextPropagators
 import org.typelevel.otel4s.Otel4s
@@ -36,12 +39,78 @@ import org.typelevel.otel4s.java.trace.Traces
 import org.typelevel.otel4s.metrics.MeterProvider
 import org.typelevel.otel4s.trace.TracerProvider
 
-sealed class OtelJava[F[_]] private (
+import scala.util.Using
+
+sealed class OtelJava[F[_]: MonadThrow: LocalContext] private (
     val propagators: ContextPropagators[F, Context],
     val meterProvider: MeterProvider[F],
     val tracerProvider: TracerProvider[F],
 ) extends Otel4s[F] {
   type Ctx = Context
+
+  /** Runs the given `fa` with the given `JContext`.
+    *
+    * Can be used to run the effect with the external Open Telemetry Java
+    * context.
+    *
+    * @see
+    *   [[useJContextUnsafe]]
+    *
+    * @param ctx
+    *   the Open Telemetry [[io.opentelemetry.context.Context JContext]]
+    *
+    * @param fa
+    *   the effect to run
+    */
+  def withJContext[A](ctx: JContext)(fa: F[A]): F[A] =
+    Local[F, Context].scope(fa)(Context.wrap(ctx))
+
+  /** Extracts the currently active context and sets it into the thread local
+    * variable.
+    *
+    * Can be used to interop with the Java libraries, that rely on the Open
+    * Telemetry Java context.
+    *
+    * @example
+    *   {{{
+    * import io.opentelemetry.api.trace.{Span => JSpan}
+    * import io.opentelemetry.api.trace.{Tracer => JTracer}
+    * import io.opentelemetry.context.{Context => JContext}
+    *
+    * val jTracer: JTracer = ???
+    * val dispatcher: Dispatcher[IO] = ???
+    * val otel4s: OtelJava[IO] = ???
+    * val otel4sTracer: Tracer[IO] = ???
+    *
+    * val io = otel4sTracer.span("otel4s-span").surround {
+    *   otel4s.useJContextUnsafe { _ =>
+    *     val span = jTracer.spanBuilder("java-span-inside-io").startSpan()
+    *     span.storeInContext(JContext.current()).makeCurrent()
+    *     // invoke java code, e.g. instrumented RabbitMQ Java client
+    *     span.end()
+    *   }
+    * }
+    *
+    * val span = jTracer.span("java-span").startSpan()
+    * span.storeInContext(JContext.current()).makeCurrent() // store span in the context
+    * otel4s.withJContext(JContext.current())(io).unsafeRunSync() // run IO using the external context
+    * span.end()
+    *   }}}
+    *
+    * The hierarchy of spans will be:
+    * {{{
+    * > java-span
+    *   > otel4s-span
+    *     > java-span-inside-io
+    * }}}
+    */
+  def useJContextUnsafe[A](fa: JContext => A): F[A] =
+    Local[F, Context].ask.flatMap { ctx =>
+      MonadThrow[F].fromTry {
+        val jContext = ctx.underlying
+        Using(jContext.makeCurrent())(_ => fa(jContext))
+      }
+    }
 }
 
 object OtelJava {

diff --git a/java/all/src/test/scala/org/typelevel/otel4s/java/OtelJavaSuite.scala b/java/all/src/test/scala/org/typelevel/otel4s/java/OtelJavaSuite.scala
@@ -17,7 +17,12 @@
 package org.typelevel.otel4s.java
 
 import cats.effect.IO
+import io.opentelemetry.api.trace.{Span => JSpan}
+import io.opentelemetry.context.{Context => JContext}
 import io.opentelemetry.sdk.{OpenTelemetrySdk => JOpenTelemetrySdk}
+import io.opentelemetry.sdk.testing.exporter.InMemorySpanExporter
+import io.opentelemetry.sdk.trace.SdkTracerProvider
+import io.opentelemetry.sdk.trace.`export`.SimpleSpanProcessor
 import munit.CatsEffectSuite
 
 class OtelJavaSuite extends CatsEffectSuite {
@@ -26,9 +31,46 @@ class OtelJavaSuite extends CatsEffectSuite {
     val testSdk: JOpenTelemetrySdk = JOpenTelemetrySdk.builder().build()
     OtelJava
       .forAsync[IO](testSdk)
-      .map(testOtel4s => {
+      .map { testOtel4s =>
         val res = testOtel4s.toString()
         assert(clue(res).startsWith("OpenTelemetrySdk"))
-      })
+      }
   }
+
+  test("interop with java") {
+    val sdk = createSdk
+
+    OtelJava
+      .forAsync[IO](sdk)
+      .map { otel4s =>
+        val getCurrentSpan = otel4s.useJContextUnsafe(_ => JSpan.current())
+
+        val jTracer = sdk.getTracer("tracer")
+        val span = jTracer.spanBuilder("test").startSpan()
+
+        span.storeInContext(JContext.current()).makeCurrent()
+
+        val ioSpan = otel4s
+          .withJContext(JContext.current())(getCurrentSpan)
+          .unsafeRunSync()
+
+        span.end()
+
+        assertEquals(span, ioSpan)
+      }
+  }
+
+  private def createSdk: JOpenTelemetrySdk = {
+    val exporter = InMemorySpanExporter.create()
+
+    val builder = SdkTracerProvider
+      .builder()
+      .addSpanProcessor(SimpleSpanProcessor.create(exporter))
+
+    JOpenTelemetrySdk
+      .builder()
+      .setTracerProvider(builder.build())
+      .build()
+  }
+
 }