From 34ec12f140438cfb4a5d6f78c0f9d9a9aeb661c8 Mon Sep 17 00:00:00 2001 From: Jacob Viau Date: Thu, 7 Dec 2023 09:40:57 -0800 Subject: [PATCH 1/2] Add small getting started for distributed tracing --- docs/telemetry/traces/getting_started.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/telemetry/traces/getting_started.md diff --git a/docs/telemetry/traces/getting_started.md b/docs/telemetry/traces/getting_started.md new file mode 100644 index 000000000..6347e5a52 --- /dev/null +++ b/docs/telemetry/traces/getting_started.md @@ -0,0 +1,24 @@ +# Getting Started - Distributed Tracing + +> ⚠ Important: durable task distributed tracing is currently [experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md). The schema is subject to changes until it is marked as stable. These changes may occur in any package update. + +Distributed tracing in DurableTask uses the `ActivitySource` approach, it is both OpenTelemetry and Application Insights compatible. + +## OpenTelemetry + +Add the `"DurableTask.Core"` source to the OTel trace builder. + +``` CSharp +Sdk.CreateTracerProviderBuilder() + .AddSource("DurableTask.Core") + .Build(); +``` + +See [sample](../../../samples/DistributedTraceSample/OpenTelemetry) + +## Application Insights + +1. Add reference to [Microsoft.Azure.DurableTask.ApplicationInsights](https://www.nuget.org/packages/Microsoft.Azure.DurableTask.ApplicationInsights) +2. Add the `DurableTelemetryModule` to AppInsights: `services.TryAddEnumerable(ServiceDescriptor.Singleton());` + +See [sample](../../../samples/DistributedTraceSample/ApplicationInsights) From 67c3a0361fc8563be0de5307fde2991b5e4b96b0 Mon Sep 17 00:00:00 2001 From: Jacob Viau Date: Thu, 7 Dec 2023 14:08:05 -0800 Subject: [PATCH 2/2] Add distinction to getting started --- .../traces/{getting_started.md => getting-started.md} | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) rename docs/telemetry/traces/{getting_started.md => getting-started.md} (81%) diff --git a/docs/telemetry/traces/getting_started.md b/docs/telemetry/traces/getting-started.md similarity index 81% rename from docs/telemetry/traces/getting_started.md rename to docs/telemetry/traces/getting-started.md index 6347e5a52..6ba72e786 100644 --- a/docs/telemetry/traces/getting_started.md +++ b/docs/telemetry/traces/getting-started.md @@ -2,6 +2,8 @@ > ⚠ Important: durable task distributed tracing is currently [experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md). The schema is subject to changes until it is marked as stable. These changes may occur in any package update. +> ⚠ Important: this guide only applies DurableTask users. For Durable Functions, please see [here](https://github.com/Azure/azure-functions-durable-extension/blob/dev/samples/distributed-tracing/v2/DistributedTracingSample/README.md) + Distributed tracing in DurableTask uses the `ActivitySource` approach, it is both OpenTelemetry and Application Insights compatible. ## OpenTelemetry @@ -11,7 +13,7 @@ Add the `"DurableTask.Core"` source to the OTel trace builder. ``` CSharp Sdk.CreateTracerProviderBuilder() .AddSource("DurableTask.Core") - .Build(); + .Build() ``` See [sample](../../../samples/DistributedTraceSample/OpenTelemetry)