Skip to content

Add small getting started for distributed tracing #1013

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

Merged
jviau merged 2 commits into from
Dec 7, 2023
Merged

Add small getting started for distributed tracing #1013

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34ec12f
Add small getting started for distributed tracing
jviau Dec 7, 2023
67c3a03
Add distinction to getting started
jviau Dec 7, 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
26 changes: 26 additions & 0 deletions docs/telemetry/traces/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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.

> ⚠ 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

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<ITelemetryModule, DurableTelemetryModule>());`

See [sample](../../../samples/DistributedTraceSample/ApplicationInsights)