RUM-3397 (otel-tracer) update otel instrumentation guide for Android by mariusc83 · Pull Request #23389 · DataDog/documentation

mariusc83 · 2024-05-28T11:17:39Z

What does this PR do? What is the motivation?

This is part of supporting OTel APIs for dd-sdk-android-trace.

Merge instructions

Please merge after reviewing

Additional notes

github-actions · 2024-05-28T11:20:01Z

Preview links (active after the `build_preview` check completes)

New or renamed files

Modified Files

ganeshnj

Looks great. Could you add some changes that I did recently in the iOS

add a link in the original Open Tracing API docs that we support Otel APIs as well (check https://docs-staging.datadoghq.com/ganeshnj/feat/otel-tracer-ios/tracing/trace_collection/automatic_instrumentation/dd_libraries/ios/?tab=cocoapods)

ganeshnj · 2024-05-29T08:09:38Z

/informational

We must make sure during the release time, the real version is updated.

ganeshnj · 2024-05-29T08:12:03Z

/comment

Let's cleanup the extra spacing like in {{ and ```

ganeshnj · 2024-05-29T08:12:31Z

Suggested change

4. Datadog tracer implements the [Open Telemetry standard][18]. Create the OpenTelemetryTraceProvider and register the OpenTelemetrySdk as GlobalTelemetry instance in your application's `onCreate()` method.

4. Datadog tracer implements the [Open Telemetry standard][18]. Create the `OpenTelemetryTraceProvider` and register the `OpenTelemetrySdk` as GlobalTelemetry instance in your application's `onCreate()` method.

ganeshnj · 2024-05-29T08:13:09Z

Given the fact, we don't do anything with instrumentationName, let's make it obvious by passing the empty string.

Suggested change

val tracerProvider = GlobalOpenTelemetry.get().getTracer(instrumentationName = "<instrumentation_name>")

val tracerProvider = GlobalOpenTelemetry.get().getTracer(instrumentationName = "")

yes but in this case I want to stay consistent with Otel. Maybe later one we will use it for something. Not sure here

ganeshnj · 2024-05-29T08:13:58Z

Suggested change

final TracerProvider tracerProvider = GlobalOpenTelemetry.get().getTracer("<instrumentation_name>");

final TracerProvider tracerProvider = GlobalOpenTelemetry.get().getTracer("");

ganeshnj · 2024-05-29T08:14:36Z

Suggested change

Note: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the GlobalOpenTelemetry to hold a single instance of the TracerProvider create your own instance of the TracerProvider and use it in your application code as needed.

Note: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the `GlobalOpenTelemetry` to hold a single instance of the `TracerProvider` create your own instance of the `TracerProvider` and use it in your application code as needed.

ganeshnj · 2024-05-29T08:18:35Z

Suggested change

tracer.spanBuilder("<span_name>").setAttribute("<key_name>", <key_value>).startSpan();

tracer.spanBuilder("<span_name>").setAttribute("<key_name>", "<key_value>").startSpan();

nope because if we put it like that will mean that <key_value> should always be a string which is not the case at least in Android API

git-thuerk-done · 2024-05-31T15:39:42Z

Thanks! I have created a card for our team to review further: https://datadoghq.atlassian.net/browse/DOCS-8112

brett0000FF

Thanks for this! I left a few suggestions and comments. Please let me know if you have any questions or need help with anything. 😄 There are some merge conflicts, so I'm waiting to approve.

brett0000FF · 2024-06-04T17:11:58Z

+
+**Note**: If you decide to set the `GlobalOpenTelemetry.set` API you need to make sure that this is only called one single time in your process otherwise OpenTelemetry will throw an exception. In case you want to avoid that you can just create a `TracerProvider` and use it as a singleton in your project.
+
+**Note**: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the `GlobalOpenTelemetry` to hold a single instance of the `TracerProvider` create your own instance and use it in your application code as needed.


Suggested change

**Note**: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the `GlobalOpenTelemetry` to hold a single instance of the `TracerProvider` create your own instance and use it in your application code as needed.

I think this note is duplicated?

will double check, tks !!

I did not find any duplicate, can you please double check it on your end ?

Hey, apologies for not being clearer. I was referring to the overlap between the note on line 382 and 384. Perhaps these could be combined?

Ensure the GlobalOpenTelemetry.set API is called only once per process. The setService method is used to set the service name for the tracer provider, which identifies the application in Datadog. You have two options for managing the TracerProvider instance: - Use GlobalOpenTelemetry to hold a single instance of the TracerProvider. This ensures that the GlobalOpenTelemetry.set API is called only once per process. - Create your own instance of the TracerProvider and use it as a singleton in your project. This allows you to manage the instance directly in your application code as needed.

brett0000FF · 2024-06-04T17:16:32Z

@@ -0,0 +1,327 @@
+---
+title: iOS and tvOS Custom Instrumentation using OpenTelemetry API


We recently published a page for this content: https://docs.datadoghq.com/tracing/trace_collection/custom_instrumentation/ios?tab=cocoapods.

I'm not sure which is most relevant, but we should reconcile these.

yes I need to rebase this ...this is because it was part of @ganeshnj PR that was merged.

rebase done

rtrieu

Hi @mariusc83, a few minor suggestions from me!

…dd_libraries/android.md Co-authored-by: Brett Blue <[email protected]>

…dd_libraries/ios.md Co-authored-by: Brett Blue <[email protected]>

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

rtrieu

A few more things!

…roid/otel.md Co-authored-by: Rosa Trieu <[email protected]>

brett0000FF

Thanks! Just a few minor comments from my end.

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

rtrieu

Looks great, thanks!

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

MaelNamNam · 2024-06-20T10:01:59Z

/merge

dd-devflow · 2024-06-20T10:02:11Z

🚂 MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

Use /merge -c to cancel this operation!

dd-devflow · 2024-06-20T13:59:15Z

🚂 MergeQueue: This merge request was already merged

This pull request was merged directly.

github-actions Bot added the Architecture Everything related to the Doc backend label May 28, 2024

mariusc83 force-pushed the marius/feat/otel-tracer-android branch 2 times, most recently from 4e76793 to 58234e9 Compare May 28, 2024 13:17

ganeshnj suggested changes May 29, 2024

View reviewed changes

mariusc83 force-pushed the marius/feat/otel-tracer-android branch 4 times, most recently from f598d2f to 3f9a200 Compare May 31, 2024 12:42

mariusc83 marked this pull request as ready for review May 31, 2024 13:27

mariusc83 requested a review from a team as a code owner May 31, 2024 13:27

git-thuerk-done added the editorial review Waiting on a more in-depth review label May 31, 2024

Base automatically changed from ganeshnj/feat/otel-tracer-ios to master June 3, 2024 16:42

rtrieu requested a review from a team as a code owner June 3, 2024 16:42

brett0000FF reviewed Jun 4, 2024

View reviewed changes

rtrieu requested changes Jun 4, 2024

View reviewed changes

Comment thread content/en/tracing/trace_collection/custom_instrumentation/android/otel.md Outdated

Comment thread content/en/tracing/trace_collection/custom_instrumentation/android/otel.md Outdated

Comment thread content/en/tracing/trace_collection/custom_instrumentation/android/otel.md Outdated

mariusc83 force-pushed the marius/feat/otel-tracer-android branch from 3f9a200 to 2279085 Compare June 5, 2024 13:59

mariusc83 mentioned this pull request Jun 6, 2024

RUM-3438 Add the OkHttp Otel extensions module DataDog/dd-sdk-android#2073

Merged

3 tasks

mariusc83 force-pushed the marius/feat/otel-tracer-android branch 3 times, most recently from 25c7395 to 282b505 Compare June 7, 2024 09:42

mariusc83 and others added 8 commits June 11, 2024 14:52

RUM-3397 (otel-tracer) update otel instrumentation guide for Android

4fcc1d1

Update content/en/tracing/trace_collection/automatic_instrumentation/…

a72f4f2

…dd_libraries/android.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/automatic_instrumentation/…

c151921

…dd_libraries/ios.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

2d52550

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

5e00e8b

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

36c9a62

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

8012ad3

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

0e2f223

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

mariusc83 force-pushed the marius/feat/otel-tracer-android branch from 282b505 to 16b6771 Compare June 11, 2024 12:52

mariusc83 requested review from brett0000FF, ganeshnj and rtrieu June 11, 2024 13:50

rtrieu requested changes Jun 11, 2024

View reviewed changes

mariusc83 and others added 6 commits June 11, 2024 16:21

Update content/en/tracing/trace_collection/custom_instrumentation/and…

60b7185

…roid/otel.md Co-authored-by: Rosa Trieu <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

00feac7

…roid/otel.md Co-authored-by: Rosa Trieu <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

108da9c

…roid/otel.md Co-authored-by: Rosa Trieu <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

8bac20d

…roid/otel.md Co-authored-by: Rosa Trieu <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

8469f91

…roid/otel.md Co-authored-by: Rosa Trieu <[email protected]>

Add the dd-sdk-android-trace and trace-otel links

1a7b2d9

brett0000FF approved these changes Jun 11, 2024

View reviewed changes

Comment thread content/en/tracing/trace_collection/custom_instrumentation/android/otel.md Outdated

Comment thread content/en/tracing/trace_collection/custom_instrumentation/android/otel.md Outdated

Comment thread content/en/tracing/trace_collection/custom_instrumentation/android/otel.md

mariusc83 and others added 2 commits June 12, 2024 11:29

Update content/en/tracing/trace_collection/custom_instrumentation/and…

4cdb8fc

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

Update content/en/tracing/trace_collection/custom_instrumentation/and…

1195da0

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

mariusc83 requested a review from rtrieu June 12, 2024 09:30

mariusc83 self-assigned this Jun 12, 2024

rtrieu approved these changes Jun 12, 2024

View reviewed changes

mariusc83 and others added 2 commits June 13, 2024 09:43

Update content/en/tracing/trace_collection/custom_instrumentation/and…

7b6e554

…roid/otel.md Co-authored-by: Brett Blue <[email protected]>

Update the release version

296a786

mariusc83 force-pushed the marius/feat/otel-tracer-android branch from 5f86c32 to 296a786 Compare June 13, 2024 08:12

ganeshnj approved these changes Jun 13, 2024

View reviewed changes

dd-devflow Bot added the mergequeue-status: waiting label Jun 20, 2024

Merge branch 'master' into marius/feat/otel-tracer-android

ddad7ab

rtrieu merged commit 603bd34 into master Jun 20, 2024

rtrieu deleted the marius/feat/otel-tracer-android branch June 20, 2024 13:59

dd-devflow Bot added mergequeue-status: done and removed mergequeue-status: waiting labels Jun 20, 2024

	4. Datadog tracer implements the [Open Telemetry standard][18]. Create the OpenTelemetryTraceProvider and register the OpenTelemetrySdk as GlobalTelemetry instance in your application's `onCreate()` method.
	4. Datadog tracer implements the [Open Telemetry standard][18]. Create the `OpenTelemetryTraceProvider` and register the `OpenTelemetrySdk` as GlobalTelemetry instance in your application's `onCreate()` method.

	val tracerProvider = GlobalOpenTelemetry.get().getTracer(instrumentationName = "<instrumentation_name>")
	val tracerProvider = GlobalOpenTelemetry.get().getTracer(instrumentationName = "")

	final TracerProvider tracerProvider = GlobalOpenTelemetry.get().getTracer("<instrumentation_name>");
	final TracerProvider tracerProvider = GlobalOpenTelemetry.get().getTracer("");

	Note: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the GlobalOpenTelemetry to hold a single instance of the TracerProvider create your own instance of the TracerProvider and use it in your application code as needed.
	Note: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the `GlobalOpenTelemetry` to hold a single instance of the `TracerProvider` create your own instance of the `TracerProvider` and use it in your application code as needed.

	tracer.spanBuilder("<span_name>").setAttribute("<key_name>", <key_value>).startSpan();
	tracer.spanBuilder("<span_name>").setAttribute("<key_name>", "<key_value>").startSpan();


		Note: If you decide to set the `GlobalOpenTelemetry.set` API you need to make sure that this is only called one single time in your process otherwise OpenTelemetry will throw an exception. In case you want to avoid that you can just create a `TracerProvider` and use it as a singleton in your project.

		Note: The `setService` method is used to set the service name for the tracer provider. The service name is used to identify the application in the Datadog UI. You can either use the `GlobalOpenTelemetry` to hold a single instance of the `TracerProvider` create your own instance and use it in your application code as needed.

		@@ -0,0 +1,327 @@
		---
		title: iOS and tvOS Custom Instrumentation using OpenTelemetry API

Uh oh!

Conversation

mariusc83 commented May 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do? What is the motivation?

Merge instructions

Additional notes

Uh oh!

github-actions Bot commented May 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

Uh oh!

ganeshnj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

git-thuerk-done commented May 31, 2024

Uh oh!

brett0000FF left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rtrieu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rtrieu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brett0000FF left a comment

Choose a reason for hiding this comment

mariusc83 commented May 28, 2024 •

edited

Loading

github-actions Bot commented May 28, 2024 •

edited

Loading

Preview links (active after the `build_preview` check completes)