Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stateful tracing, revisted #108

Closed
wants to merge 4 commits into from
Closed

Stateful tracing, revisted #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e3ea876
Stateful tracing, revisted
rossabaker Feb 3, 2023
5a7a771
Quelle horreur
rossabaker Feb 3, 2023
f6ed698
Golf down createScope
rossabaker Feb 5, 2023
b452518
Golf without cheating
rossabaker Feb 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions build.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ lazy val examples = project
.settings(
name := "otel4s-examples",
libraryDependencies ++= Seq(
"co.fs2" %% "fs2-core" % FS2Version,
"io.opentelemetry" % "opentelemetry-exporter-otlp" % OpenTelemetryVersion,
"io.opentelemetry" % "opentelemetry-sdk" % OpenTelemetryVersion,
"io.opentelemetry" % "opentelemetry-sdk-extension-autoconfigure" % s"${OpenTelemetryVersion}-alpha"
Expand Down
30 changes: 23 additions & 7 deletions examples/src/main/scala/TracingExample.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,21 @@ import cats.effect.Resource
import cats.effect.std.Console
import cats.syntax.all._
import io.opentelemetry.api.GlobalOpenTelemetry
import org.typelevel.otel4s.Attribute
import org.typelevel.otel4s.java.OtelJava
import org.typelevel.otel4s.trace.Tracer

trait Work[F[_]] {
def doWork: F[Unit]
def doWork(i: Int): F[Unit]
}

object Work {
def apply[F[_]: MonadCancelThrow: Tracer: Console]: Work[F] =
new Work[F] {
def doWork: F[Unit] =
def doWork(i: Int): F[Unit] =
Tracer[F].span("Work.DoWork").use { span =>
span.addEvent("Starting the work.") *>
span.addAttribute(Attribute("number", i.toLong)) *>
span.addEvent("Starting the work.") *>
doWorkInternal *>
span.addEvent("Finished working.")
}
Expand All @@ -50,9 +52,23 @@ object TracingExample extends IOApp.Simple {
.evalMap(OtelJava.forSync[IO])
.evalMap(_.tracerProvider.tracer("Example").get)

def run: IO[Unit] = {
def run: IO[Unit] =
tracerResource.use { implicit tracer: Tracer[IO] =>
Work[IO].doWork
}
}
tracer
.span("outer")
.surround(
IO.both(
tracer
.span("left")
.surround(
tracer.span("left-worker").use_.replicateA(10)
),
tracer
.span("right")
.surround(
tracer.span("right-worker").use_.replicateA(10)
)
)
)
}.void
}
118 changes: 63 additions & 55 deletions java/trace/src/main/scala/org/typelevel/otel4s/java/trace/TraceScope.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ package org.typelevel.otel4s.java.trace

import cats.effect.IOLocal
import cats.effect.LiftIO
import cats.effect.Ref
import cats.effect.Resource
import cats.effect.Sync
import cats.syntax.functor._
import cats.syntax.all._
import io.opentelemetry.api.trace.{Span => JSpan}
import io.opentelemetry.context.{Context => JContext}
import org.typelevel.otel4s.trace.SpanContext
Expand Down Expand Up @@ -52,60 +53,67 @@ private[java] object TraceScope {
): F[TraceScope[F]] = {
val scopeRoot = Scope.Root(default)

IOLocal[Scope](scopeRoot).to[F].map { local =>
new TraceScope[F] {
val root: F[Scope.Root] =
Sync[F].pure(scopeRoot)

def current: F[Scope] =
local.get.to[F]

def makeScope(span: JSpan): Resource[F, Unit] =
for {
current <- Resource.eval(current)
_ <- createScope(nextScope(current, span))
} yield ()

def rootScope: Resource[F, Unit] =
Resource.eval(current).flatMap {
case Scope.Root(_) =>
createScope(scopeRoot)

case Scope.Span(_, _, _) =>
createScope(scopeRoot)

case Scope.Noop =>
createScope(Scope.Noop)
}

def noopScope: Resource[F, Unit] =
createScope(Scope.Noop)

private def createScope(scope: Scope): Resource[F, Unit] =
Resource
.make(local.getAndSet(scope).to[F])(p => local.set(p).to[F])
.void

private def nextScope(scope: Scope, span: JSpan): Scope =
scope match {
case Scope.Root(ctx) =>
Scope.Span(
ctx.`with`(span),
span,
WrappedSpanContext(span.getSpanContext)
)

case Scope.Span(ctx, _, _) =>
Scope.Span(
ctx.`with`(span),
span,
WrappedSpanContext(span.getSpanContext)
)

case Scope.Noop =>
Scope.Noop
}

Ref.of[F, Scope](scopeRoot).flatMap { ref =>
IOLocal[Ref[F, Scope]](ref).to[F].map { local =>
new TraceScope[F] {
val root: F[Scope.Root] =
Sync[F].pure(scopeRoot)

def current: F[Scope] =
local.get.to[F].flatMap(_.get)

def makeScope(span: JSpan): Resource[F, Unit] =
for {
current <- Resource.eval(current)
_ <- createScope(nextScope(current, span))
} yield ()

def rootScope: Resource[F, Unit] =
Resource.eval(current).flatMap {
case Scope.Root(_) =>
createScope(scopeRoot)

case Scope.Span(_, _, _) =>
createScope(scopeRoot)

case Scope.Noop =>
createScope(Scope.Noop)
}

def noopScope: Resource[F, Unit] =
createScope(Scope.Noop)

private def createScope(scope: Scope): Resource[F, Unit] =
for {
oldRef <- Resource.eval(local.get.to[F])
newRef <- Resource.eval(oldRef.get.map(Ref.unsafe[F, Scope]))
_ <- Resource
.make(local.set(newRef).to[F])(_ => local.set(oldRef).to[F])
ref <- Resource.eval(local.get.to[F])
Comment on lines +90 to +92
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ref is not guaranteed to be newRef!

_ <- Resource.make(ref.getAndSet(scope))(ref.set)
} yield ()

private def nextScope(scope: Scope, span: JSpan): Scope =
scope match {
case Scope.Root(ctx) =>
Scope.Span(
ctx.`with`(span),
span,
WrappedSpanContext(span.getSpanContext)
)

case Scope.Span(ctx, _, _) =>
Scope.Span(
ctx.`with`(span),
span,
WrappedSpanContext(span.getSpanContext)
)

case Scope.Noop =>
Scope.Noop
}

}
}
}
}
Expand Down
45 changes: 45 additions & 0 deletions java/trace/src/test/scala/org/typelevel/otel4s/java/trace/TracerSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,51 @@ class TracerSuite extends CatsEffectSuite {
}
}

test("propagate trace info over interrupted stream scopes") {
def expected(now: FiniteDuration) =
SpanNode(
"span",
now,
now,
List(
SpanNode("span-3", now, now, Nil),
SpanNode("span-2", now, now, Nil)
)
)

def flow(tracer: Tracer[IO]): Stream[IO, Unit] =
for {
span <- Stream.resource(tracer.span("span"))
_ <- Stream.eval(
tracer.currentSpanContext.assertEquals(Some(span.context))
)
span2 <- Stream.resource(tracer.span("span-2"))
_ <- Stream.eval(
tracer.currentSpanContext.assertEquals(Some(span2.context))
)
span3 <- Stream.resource(
tracer.spanBuilder("span-3").withParent(span.context).start
)
_ <- Stream.eval(
tracer.currentSpanContext.assertEquals(Some(span3.context))
)
} yield ()

TestControl.executeEmbed {
for {
now <- IO.monotonic.delayBy(1.second) // otherwise returns 0
sdk <- makeSdk()
tracer <- sdk.provider.tracer("tracer").get
_ <- tracer.currentSpanContext.assertEquals(None)
_ <- flow(tracer).interruptScope.compile.drain
_ <- tracer.currentSpanContext.assertEquals(None)
spans <- sdk.finishedSpans
tree <- IO.pure(SpanNode.fromSpans(spans))
// _ <- IO.println(tree.map(SpanNode.render).mkString("\n"))
} yield assertEquals(tree, List(expected(now)))
}
}

private def assertIdsNotEqual(s1: Span[IO], s2: Span[IO]): Unit = {
assertNotEquals(s1.context.traceIdHex, s2.context.traceIdHex)
assertNotEquals(s1.context.spanIdHex, s2.context.spanIdHex)
Expand Down