Upgrade internal use of tracing to OpenTelemetry #3381

yurishkuro · 2021-11-08T16:00:23Z

This is aimed as an intern project for the LFX Mentorship. Please refer to #4453. Apply here.

Historically, the Jaeger backend used the OpenTracing API, with Jaeger's own Go SDK jaeger-client-go, for instrumenting its own internals for distributed tracing. Since Jaeger's SDKs have been deprecated (#3362), we want to upgrade the Jaeger backend to use the OpenTelemetry tracing API and SDK directly.

Expected Outcome:

Replace the use of OpenTracing API with OpenTelemetry
Remove jaeger-client-go and jaeger-lib as dependencies
Remove opentracing-go and opentracing-contrib/* as dependencies
Switch to standard OpenTelemetry instrumentation libraries where available (e.g. for HTTP, gRPC)
Rethink/rework crossdock integration tests to test end-to-end flow with OpenTelemetry data
Publish a blog post on medium.com/jaegertracing documenting the experience

Proposed approach

I don't think using OTEL-OT Bridge makes sense for this project, since it will create an extra work for adding the bridge, but will not make the actual migration any easier. Instead, I would do this in stages:

Right now various components of the backend take opentracing.Tracer as argument. As a first step, we create a wrapper object that will contain that same tracer, and pass the wrapper object to components. This will be one-time large refactoring but without any functional changes.
Once the first step is done, we can add OTEL Tracer to the same wrapper object.
Then start changing components one by one by switching them to use OTEL instrumentation.
When all of them have been migrated, we can remove the OpenTracing part.

Some related issues:

[OTEL] Process info is missing from the spans #4534

The text was updated successfully, but these errors were encountered:

yurishkuro · 2023-04-29T23:56:05Z

Filed as a project for LFX Mentorship cncf/mentoring#947

swastik959 · 2023-05-01T17:26:47Z

@yurishkuro hi I am new to this org and want to work on this issue I have worked on some kubernetes sigs and has a knowledge of golang

yurishkuro · 2023-05-01T18:09:24Z

@swastik959 I prefer to reserve this project for the LFX Mentorship program (otherwise I won't have a project there). You can either apply there or please pick other help-wanted issues in this repo.

swastik959 · 2023-05-02T01:02:43Z

@yurishkuro can you guide me through its process of getting selected

yurishkuro · 2023-05-02T02:20:29Z

I don't know all details yet, I assume the process will be documented here https://github.com/cncf/mentoring/tree/main/programs/lfx-mentorship/2023/02-Jun-Aug

yurishkuro · 2023-05-02T02:21:02Z

There are guidelines here https://github.com/cncf/mentoring/blob/main/programs/lfx-mentorship/README.md#program-guidelines

octonawish-akcodes · 2023-05-02T05:19:54Z

I am interested in this issue under lfx mentorship

rhzx3519 · 2023-05-02T15:11:42Z

@yurishkuro Hi, I'm very interested in this task, and I'm familiar with Golang and have contributed to some cloud-native projects.

Shubham4359 · 2023-05-02T22:44:20Z

Hi @yurishkuro, i would love to work on this issue during the upcoming LFX mentorship.
I have previously worked in Golang and have also Contributed to other CNCF organisations Like Thanos.
Can you please provide some starting material to work on this issue also any other things to keep in mind.
Thanks

Swapnil-2502 · 2023-05-04T10:12:31Z

Filed as a project for LFX Mentorship cncf/mentoring#947

Yeah I just saw it will be applying for the LFX Mentorship.

shashankiitbhu · 2023-05-14T13:03:20Z

Hi, I am very interested in this task and would like to work on this under LFX mentorship program.

yurishkuro · 2023-05-14T22:39:06Z

Applicants interested in this project: please see #4453

haanhvu · 2023-05-15T06:08:20Z

For anyone looking for guide/resources to study this project:

Just google "migrate from OpenTracing to OpenTelemetry". This is actually a prominent issue generally.
Some Jaeger-related resources:
https://www.timescale.com/blog/how-to-successfully-migrate-from-jaeger-to-opentelemetry-tracing/
https://medium.com/jaegertracing/experiment-migrating-opentracing-based-application-in-go-to-use-the-opentelemetry-sdk-29b09fe2fbc4

yurishkuro · 2023-06-01T16:03:28Z

@afzal442 will be working on this as part of LFX Mentorship program.

…TEL in the future [part 1] (#4529) ## Which problem is this PR solving? Part of #3381 ## Short description of the changes - This refactors the code by introducing a new wrapper object `JTracer` to wrap that interface Signed-off-by: afzal442 <afzal442@gmail.com>

## Which problem is this PR solving? Related to #3380 Part of #3381 - This adds `OTEL tracerProvider` and removes `OT tracer` for Redis service hotROD app Before: ![r2](https://github.com/jaegertracing/jaeger/assets/11625672/446d03b9-2da0-47b2-9312-b8bc86c7e78a) After: ![r1](https://github.com/jaegertracing/jaeger/assets/11625672/ed3f2ca6-7a01-4ab2-a13c-56c1f3388fe6) --------- Signed-off-by: afzal442 <afzal442@gmail.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

…TEL in the future [part 1] (jaegertracing#4529) ## Which problem is this PR solving? Part of jaegertracing#3381 ## Short description of the changes - This refactors the code by introducing a new wrapper object `JTracer` to wrap that interface Signed-off-by: afzal442 <afzal442@gmail.com> Signed-off-by: KevinSchneider <kevin.schneider@target.com>

## Which problem is this PR solving? Related to jaegertracing#3380 Part of jaegertracing#3381 - This adds `OTEL tracerProvider` and removes `OT tracer` for Redis service hotROD app Before: ![r2](https://github.com/jaegertracing/jaeger/assets/11625672/446d03b9-2da0-47b2-9312-b8bc86c7e78a) After: ![r1](https://github.com/jaegertracing/jaeger/assets/11625672/ed3f2ca6-7a01-4ab2-a13c-56c1f3388fe6) --------- Signed-off-by: afzal442 <afzal442@gmail.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Signed-off-by: KevinSchneider <kevin.schneider@target.com>

## Which problem is this PR solving? Related to #3380 Part of #3381 ## Short description of the changes - This PR adds OTEL instrumentation to customer svc --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com>

## Which problem is this PR solving? Related to jaegertracing#3380 Part of jaegertracing#3381 ## Short description of the changes - This PR adds OTEL instrumentation to customer svc --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com>

## Which problem is this PR solving? * Part of #3381 * This PR adds OTEL Provider to jtracer pkg ## Short description of the changes - Upgrades jaeger tracing to support `otel tracer` --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com> Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

#4595) ## Which problem is this PR solving? * Part of #3381 * This PR adds OTEL Provider to metrics reader component ## Short description of the changes - Replaces OT tracer with OTEL tracer to support jtracer pkg --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com>

## Which problem is this PR solving? * Part of #3381 * This PR adds OTEL Provider to es-spanstore component ## Short description of the changes - Replaces OT tracer with OTEL tracer to support jtracer pkg --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com> Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

) ## Which problem is this PR solving? * Part of #3381 * This PR adds `otel trace` spans type to span model ## Short description of the changes - Replace OT trace with `otel trace` spans type i.e. `ext.SpanKind..` with `trace.SpanKind..` --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com> Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

…e plugin (#4611) ## Which problem is this PR solving? * Part of #3381 * This PR adds `otelgrpc` plugin to storage ## Short description of the changes - Replaces `otgrpc` plugin storage with otel grpc interceptors --------- Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

## Which problem is this PR solving? * Part of #3381 * This PR adds `otel trace` spans type to span model ## Short description of the changes - Replace OT const with `otel trace` spans const i.e. `ext.SpanKind..` with `trace.SpanKind..` --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com> Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

## Which problem is this PR solving? * Part of #3381 * This PR adds `otel trace` spans const type to domain model ## Short description of the changes - Replace OT const with `otel trace` spans const i.e. `ext.SpanKind..` with `trace.SpanKind..` Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

## Which problem is this PR solving? * Part of #3381 * This PR adds `otel` traces and removes deprecated `jaeger-client-go` api ## Short description of the changes - Replace OT tracer with OTEL --------- Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

## Which problem is this PR solving? * Part of #3381 * This PR adds `otel` traces and const to hotROD test file ## Short description of the changes - Replace OT const with `otel trace` spans const i.e. `ext.SpanKind..` with `trace.SpanKind..` and its trace API --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com> Signed-off-by: Afzal <94980910+afzalbin64@users.noreply.github.com> Co-authored-by: Afzal <94980910+afzalbin64@users.noreply.github.com>

## Which problem is this PR solving? * Part of #3381 * This PR removes `opentracing pkg` from jtracer pkg and go.mod file ## Short description of the changes - Removes `opentracing pkg` from `jaeger module` and modifies README file to rmv OT support. --------- Signed-off-by: Afzal Ansari <afzal442@gmail.com>

## Which problem is this PR solving? * Part of #3381 * This PR removes `jaeger-client` pkg constant and replaces it with const variable --------- Signed-off-by: afzal442 <afzal442@gmail.com>

## Which problem is this PR solving? - Part of #3381 ## Description of the changes - Remove internal unused package `jlibadapter` - Remove unnecessary dependency on jaeger-lib in the tests ## How was this change tested? - Unit tests Signed-off-by: Yuri Shkuro <github@ysh.us>

yurishkuro · 2023-09-28T15:58:59Z

This can be considered complete. We still import jaeger-client-go, but only in tests.

$ grx jaeger-client-go .
./crossdock/services/tracehandler_test.go:31:	"github.com/uber/jaeger-client-go"
./crossdock/services/tracehandler.go:29:	"github.com/uber/jaeger-client-go"
./cmd/collector/app/handler/http_thrift_handler_test.go:32:	jaegerClient "github.com/uber/jaeger-client-go"
./cmd/collector/app/handler/http_thrift_handler_test.go:33:	"github.com/uber/jaeger-client-go/transport"
./go.mod:50:	github.com/uber/jaeger-client-go v2.30.0+incompatible

yurishkuro added the help wanted Features that maintainers are willing to accept but do not have cycles to implement label Nov 8, 2021

yurishkuro mentioned this issue Nov 8, 2021

🌇 Sunsetting Jaeger clients 🏁 #3362

Closed

9 tasks

yurishkuro mentioned this issue Jun 21, 2022

Remove dependency on jaeger-lib #3766

Open

5 tasks

yurishkuro mentioned this issue Jan 29, 2023

Use OpenTelemetry SDK in HotROD 🚗 #4187

Merged

yurishkuro mentioned this issue May 14, 2023

Jaeger's LFX Mentorship Jun-Aug-2023 Projects #4453

Closed

yurishkuro added mentorship and removed help wanted Features that maintainers are willing to accept but do not have cycles to implement labels Jun 14, 2023

yurishkuro mentioned this issue Jun 14, 2023

Pass a wrapper instead of opentracing.Tracer to ease migration to OTEL in the future [part 1] #4529

Merged

afzal442 mentioned this issue Jun 17, 2023

feat: Added OTEL TracerProvider instead of opentracing.Tracer for hotROD example app service (Redis) #4533

Merged

This was referenced Jul 2, 2023

[hotROD] Replace gRPC instrumentation with OTEL #4558

Merged

[hotROD] Add OTEL instrumentation to customer svc #4559

Merged

afzal442 mentioned this issue Jul 7, 2023

Replace Jaeger SDK with OTEL SDK + OT Bridge #4574

Merged

This was referenced Jul 23, 2023

feat: Add OTEL tracer to metricsstore reader component #4595

Merged

Replace es-spanstore tracing instrumentation with OpenTelemetry #4596

Merged

Replace cassandra-spanstore tracing instrumentation withOTEL #4599

Merged

This was referenced Jul 31, 2023

Replace OpenTracing instrumentation with OpenTelemetry in grpc storage plugin #4611

Merged

Replace usage of OpenTracing constants with OpenTelemetry in the domain model #4614

Merged

afzal442 mentioned this issue Aug 4, 2023

[test] Replace OT const with OTEL #4624

Merged

afzal442 mentioned this issue Aug 4, 2023

[zipkin] Replace OT constants with OTEL #4625

Merged

This was referenced Aug 7, 2023

[hotrod/observer_test] Switch to OpenTelemetry #4635

Merged

[memstore-plugin]Replace ot with otel sdk #4643

Merged

afzal442 mentioned this issue Aug 13, 2023

Removes opentracing pkg from jaeger module #4654

Merged

This was referenced Aug 14, 2023

[hotROD] Upgrade hotrod to support otel tracer #4548

Merged

[zipkin] Replace zipkin exporter from jaeger sdk with otel zipkin exp #4674

Merged

[chore] Stop using constants from jaeger-client-go #4681

Merged

yurishkuro mentioned this issue Sep 4, 2023

[chore] Remove direct dependency on jaeger-lib #4721

Merged

yurishkuro closed this as completed Sep 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade internal use of tracing to OpenTelemetry #3381

Upgrade internal use of tracing to OpenTelemetry #3381

yurishkuro commented Nov 8, 2021 •

edited

yurishkuro commented Apr 29, 2023

swastik959 commented May 1, 2023

yurishkuro commented May 1, 2023

swastik959 commented May 2, 2023

yurishkuro commented May 2, 2023

yurishkuro commented May 2, 2023

octonawish-akcodes commented May 2, 2023

rhzx3519 commented May 2, 2023

Shubham4359 commented May 2, 2023

Swapnil-2502 commented May 4, 2023

shashankiitbhu commented May 14, 2023

yurishkuro commented May 14, 2023

haanhvu commented May 15, 2023

yurishkuro commented Jun 1, 2023

yurishkuro commented Sep 28, 2023

Upgrade internal use of tracing to OpenTelemetry #3381

Upgrade internal use of tracing to OpenTelemetry #3381

Comments

yurishkuro commented Nov 8, 2021 • edited

Expected Outcome:

Proposed approach

yurishkuro commented Apr 29, 2023

swastik959 commented May 1, 2023

yurishkuro commented May 1, 2023

swastik959 commented May 2, 2023

yurishkuro commented May 2, 2023

yurishkuro commented May 2, 2023

octonawish-akcodes commented May 2, 2023

rhzx3519 commented May 2, 2023

Shubham4359 commented May 2, 2023

Swapnil-2502 commented May 4, 2023

shashankiitbhu commented May 14, 2023

yurishkuro commented May 14, 2023

haanhvu commented May 15, 2023

yurishkuro commented Jun 1, 2023

yurishkuro commented Sep 28, 2023

yurishkuro commented Nov 8, 2021 •

edited