Implement tracing API #37

iRevive · 2022-07-30T13:57:44Z

The implementation of the tracing API using the OpenTelemetry java library.

Notable changes:

The methods from the Span trait moved to the Scala-specific SpanMacro
Preserved laziness via macro
The tracing scope is stored in the IOLocal

Currently, the scope is stored in IOLocal. This approach has several drawbacks:

# Conflicts: # core/src/main/scala/org/typelevel/otel4s/trace/Span.scala

# Conflicts: # core/src/main/scala/org/typelevel/otel4s/trace/SpanFinalizer.scala

# Conflicts: # build.sbt

# Conflicts: # build.sbt # core/src/main/scala/org/typelevel/otel4s/trace/Span.scala

# Conflicts: # build.sbt

# Conflicts: # .github/workflows/ci.yml # build.sbt # core/tracing/src/main/scala/org/typelevel/otel4s/trace/SamplingDecision.scala # core/tracing/src/main/scala/org/typelevel/otel4s/trace/Span.scala # core/tracing/src/main/scala/org/typelevel/otel4s/trace/SpanBuilder.scala # core/tracing/src/main/scala/org/typelevel/otel4s/trace/SpanContext.scala # core/tracing/src/main/scala/org/typelevel/otel4s/trace/SpanFinalizer.scala # core/tracing/src/main/scala/org/typelevel/otel4s/trace/Tracer.scala

rossabaker

It seems to me that most of the implementation could be private[java], which would give us a lot more flexibility to refactor once bincompat constraints become a thing.

build.sbt

java/tracing/src/main/scala/org/typelevel/otel4s/java/trace/SpanBackendImpl.scala

java/tracing/src/main/scala/org/typelevel/otel4s/java/trace/SpanBuilderImpl.scala

java/tracing/src/test/scala/org/typelevel/otel4s/java/trace/SpanNode.scala

iRevive · 2022-10-18T08:07:31Z

java/tracing/src/main/scala/org/typelevel/otel4s/java/trace/SpanBuilderImpl.scala

+  ): SpanBuilder[F] =
+    copy(finalizationStrategy = strategy)
+
+  def createManual: F[Span[F]] = {


Is this naming make sense since we do not have Span.Auto and Span.Manual anymore?

Since it's a builder, the create part somewhat makes sense. On the other hand, the side effect of a starting span is happening under the hood.

From my point of view, we should advertise the fully managed lifecycle of a span Resource[F, Span[F]] as a preferred option.

Some options:

start: Resource[F, Span[F]] and startUnmanaged: F[Span[F]]

create: Resource[F, Span[F]] and createUnmanaged: F[Span[F]]

I think I like start and startUnmanaged, for the verbal symmetry with end.

Thanks for the feedback. I renamed the methods.

# Conflicts: # .github/workflows/ci.yml # build.sbt

…teManual` -> `SpanBuilder.startUnmanaged`

rossabaker

This is wonderful!

I'm making Otel a top priority at $WORK. I would love to do a preview release this week so more people can start instrumenting and see what feels good and what still needs work.

rossabaker · 2023-01-23T05:40:35Z

The module name is tracing and the package is trace. These should probably be the same?

iRevive · 2023-01-23T07:44:52Z

The module name is tracing and the package is trace. These should probably be the same?

Good catch. I renamed sbt modules.

* Define tracing API * Add `spanBuilder` to `Tracer`. Better naming of `SpanContext` members * Rename `SamplingStrategy` -> `SamplingDecision` * Update scaladoc. Add `SpanFinalizer` * Fix scaladoc * Implement tracing API * Improve Scaladoc * Improve Scaladoc * Better phrasing * Docs cleanup * Properly handle 'noop' scope * Hide implementation of `SpanFinalizer` * Docs update * Replace `asChildOf` with `childScope` and `withParent` * Add `withParent` to `SpanBuilder` * Replace `childOf` with `childScope` in `Tracer` * Make `Span` always return `SpanContext` * Test propagation of trace info over stream scopes * Make `Span` always have a `SpanContext` * Add `setAttribute` method to `Span` * Use `IO.to` syntax * Update layout * Run `sbt githubWorkflowGenerate` * Update layout * Revert redundant changes * Cleanup * Run `sbt githubWorkflowGenerate` * Update layout * run `scalafixAll` * Implement `Span#setAttribute` via macro * Fix method name * Update implementation * Minor cleanup of `build.sbt` * Remove duplicated `munit` dependency * Discard statement instead of calling `void` * Hide implementation details behind `package[java]` * Rename `withAttribute` -> `addAttribute` * Merge upstream * Rename `SpanBuilder.create` -> `SpanBuilder.start`, `SpanBuilder.createManual` -> `SpanBuilder.startUnmanaged` * Rename sbt modules `tracing` -> `trace` Co-authored-by: Ross A. Baker <ross@rossabaker.com>

iRevive added 6 commits July 29, 2022 21:01

Define tracing API

ff8ed12

Add spanBuilder to Tracer. Better naming of SpanContext members

9f05624

Rename SamplingStrategy -> SamplingDecision

e77a192

Update scaladoc. Add SpanFinalizer

9ab5d68

Fix scaladoc

42cdd4b

Implement tracing API

7f0846f

iRevive changed the title ~~Implement tracing API~~ Draft: Implement tracing API Jul 30, 2022

iRevive mentioned this pull request Jul 30, 2022

[Do not merge] Trace API playground #35

Closed

7 tasks

iRevive added 22 commits July 31, 2022 12:10

Improve Scaladoc

a7a390f

Merge branch 'tracing-api' into tracing-api-impl

87c23ee

# Conflicts: # core/src/main/scala/org/typelevel/otel4s/trace/Span.scala

Improve Scaladoc

b53d00c

Better phrasing

bbe21d7

Merge branch 'tracing-api' into tracing-api-impl

94a1fe6

Docs cleanup

bc95fba

Properly handle 'noop' scope

2cc0cae

Hide implementation of SpanFinalizer

8f74413

Merge branch 'tracing-api' into tracing-api-impl

c4046f0

# Conflicts: # core/src/main/scala/org/typelevel/otel4s/trace/SpanFinalizer.scala

Docs update

5fdb830

Replace asChildOf with childScope and withParent

f000a93

Add withParent to SpanBuilder

13d4ebb

Replace childOf with childScope in Tracer

6d3f38f

Make Span always return SpanContext

1e56fc8

Merge branch 'main' into tracing-api-impl

461f3b5

# Conflicts: # build.sbt

Test propagation of trace info over stream scopes

d70a57d

Make Span always have a SpanContext

3a14e52

Merge branch 'main' into tracing-api

3d51acb

# Conflicts: # build.sbt

Merge branch 'tracing-api' into tracing-api-impl

9ce4cfe

# Conflicts: # build.sbt # core/src/main/scala/org/typelevel/otel4s/trace/Span.scala

Add setAttribute method to Span

b1d4b15

Use IO.to syntax

95f3fc4

Merge branch 'main' into tracing-api

a9b5f30

# Conflicts: # build.sbt

iRevive added 7 commits September 25, 2022 15:51

Update layout

5ec119f

run scalafixAll

b963f03

Implement Span#setAttribute via macro

fe1fbea

Fix method name

0d25702

Update implementation

d1a5a84

Minor cleanup of build.sbt

9ff15db

iRevive marked this pull request as ready for review October 17, 2022 16:07

iRevive changed the title ~~Draft: Implement tracing API~~ Implement tracing API Oct 17, 2022

rossabaker reviewed Oct 17, 2022

View reviewed changes

iRevive added 4 commits October 18, 2022 10:41

Remove duplicated munit dependency

d9fb79d

Discard statement instead of calling void

851aeab

Hide implementation details behind package[java]

45e312e

Rename withAttribute -> addAttribute

fadef2b

iRevive commented Oct 18, 2022

View reviewed changes

iRevive added 2 commits October 18, 2022 11:10

Merge branch 'main' into tracing-api-impl

b17d7cd

# Conflicts: # .github/workflows/ci.yml # build.sbt

Merge upstream

f3c1c3b

iRevive mentioned this pull request Oct 25, 2022

Add Span and Tracer macro implementations #56

Closed

rossabaker and others added 2 commits January 17, 2023 16:58

Merge branch 'main' into tracing-api-impl

2ce752b

Rename SpanBuilder.create -> SpanBuilder.start, `SpanBuilder.crea…

9ec2b1a

…teManual` -> `SpanBuilder.startUnmanaged`

rossabaker approved these changes Jan 23, 2023

View reviewed changes

rossabaker mentioned this pull request Jan 23, 2023

A Natchez-like "continuation" API to avoid MonadCancelThrow leakage? #85

Closed

Rename sbt modules tracing -> trace

7501d01

iRevive merged commit c1e9cfd into typelevel:main Jan 23, 2023

rossabaker mentioned this pull request Jan 23, 2023

Does tracing work well without IOLocal? Should it? #88

Closed

iRevive mentioned this pull request Jan 27, 2023

SpanBuilder: replace startResource with wrapResource #86

Merged

iRevive deleted the tracing-api-impl branch January 30, 2023 14:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement tracing API #37

Implement tracing API #37

iRevive commented Jul 30, 2022 •

edited

Loading

rossabaker left a comment

iRevive Oct 18, 2022

rossabaker Jan 20, 2023

iRevive Jan 21, 2023

rossabaker left a comment

rossabaker commented Jan 23, 2023

iRevive commented Jan 23, 2023

Implement tracing API #37

Implement tracing API #37

Conversation

iRevive commented Jul 30, 2022 • edited Loading

rossabaker left a comment

Choose a reason for hiding this comment

iRevive Oct 18, 2022

Choose a reason for hiding this comment

rossabaker Jan 20, 2023

Choose a reason for hiding this comment

iRevive Jan 21, 2023

Choose a reason for hiding this comment

rossabaker left a comment

Choose a reason for hiding this comment

rossabaker commented Jan 23, 2023

iRevive commented Jan 23, 2023

iRevive commented Jul 30, 2022 •

edited

Loading