Skip to content

feat(otel): add otel tracing for standalone activities. #647

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

Open
cconstable wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(otel): add otel tracing for standalone activities. #647

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e52b86f
feat(otel): add otel tracing for standalone activities.
cconstable Apr 22, 2026
58ec4f7
style(tests): using discard variable to signal intent
cconstable Apr 23, 2026
6b5fa88
fix(tests): use two activities for testing cancel and terminate activ…
cconstable Apr 23, 2026
0e7a4f4
Merge branch 'main' into cc/standalone-activity-tracing
cconstable May 1, 2026
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
121 changes: 121 additions & 0 deletions src/Temporalio.Extensions.OpenTelemetry/TracingInterceptor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,21 @@ protected virtual IDictionary<string, string> HeadersFromContext(
return ret;
}

/// <summary>
/// Create tag collection for the given standalone activity ID.
/// </summary>
/// <param name="activityId">Standalone activity ID.</param>
/// <returns>Tags.</returns>
protected virtual IEnumerable<KeyValuePair<string, object?>> CreateStandaloneActivityTags(
string activityId)
{
if (Options.TagNameActivityId is string name)
{
return new KeyValuePair<string, object?>[] { new(name, activityId) };
}
return Enumerable.Empty<KeyValuePair<string, object?>>();
}

private static void RecordExceptionWithStatus(Activity? activity, Exception exception)
{
// If the exception is a benign exception, we do not consider the status an error. Note,
Expand Down Expand Up @@ -395,6 +410,112 @@ public override async Task<WorkflowUpdateHandle<TResult>> StartWorkflowUpdateAsy
}
}

public override async Task<ActivityHandle<TResult>> StartActivityAsync<TResult>(
StartActivityInput input)
{
using (var activity = ClientSource.StartActivity(
$"StartActivity:{input.Activity}",
kind: ActivityKind.Client,
parentContext: default,
tags: input.Options.Id is string id ? root.CreateStandaloneActivityTags(id) : null))
Copy link
Copy Markdown
Contributor Author

@cconstable cconstable Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

input.Options.Id is optional because it uses the shared StartActivityInput. AFAICT, it will never be null for standalone activities.

{
if (HeadersFromContext(input.Headers) is Dictionary<string, Payload> headers)
{
input = input with { Headers = headers };
}
try
{
return await base.StartActivityAsync<TResult>(input).ConfigureAwait(false);
}
catch (Exception e)
{
RecordExceptionWithStatus(activity, e);
throw;
}
}
}

public override async Task<ActivityExecutionDescription> DescribeActivityAsync(
DescribeActivityInput input)
{
using (var activity = ClientSource.StartActivity(
$"DescribeActivity:{input.Id}",
kind: ActivityKind.Client,
parentContext: default,
tags: root.CreateStandaloneActivityTags(input.Id)))
{
try
{
return await base.DescribeActivityAsync(input).ConfigureAwait(false);
}
catch (Exception e)
{
RecordExceptionWithStatus(activity, e);
throw;
}
}
}

public override async Task CancelActivityAsync(CancelActivityInput input)
{
using (var activity = ClientSource.StartActivity(
$"CancelActivity:{input.Id}",
kind: ActivityKind.Client,
parentContext: default,
tags: root.CreateStandaloneActivityTags(input.Id)))
{
try
{
await base.CancelActivityAsync(input).ConfigureAwait(false);
}
catch (Exception e)
{
RecordExceptionWithStatus(activity, e);
throw;
}
}
}

public override async Task TerminateActivityAsync(TerminateActivityInput input)
{
using (var activity = ClientSource.StartActivity(
$"TerminateActivity:{input.Id}",
kind: ActivityKind.Client,
parentContext: default,
tags: root.CreateStandaloneActivityTags(input.Id)))
{
try
{
await base.TerminateActivityAsync(input).ConfigureAwait(false);
}
catch (Exception e)
{
RecordExceptionWithStatus(activity, e);
throw;
}
}
}

public override async Task<ActivityExecutionCount> CountActivitiesAsync(
CountActivitiesInput input)
{
using (var activity = ClientSource.StartActivity(
"CountActivities",
kind: ActivityKind.Client,
parentContext: default))
{
try
{
return await base.CountActivitiesAsync(input).ConfigureAwait(false);
}
catch (Exception e)
{
RecordExceptionWithStatus(activity, e);
throw;
}
}
}

/// <summary>
/// Serialize current context to headers if one exists.
/// </summary>
Expand Down
39 changes: 38 additions & 1 deletion tests/Temporalio.Tests/Extensions/OpenTelemetry/TracingInterceptorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -797,6 +797,43 @@ public async Task TracingInterceptor_Nexus_HasTracing()
"RunWorkflow:TracingWorkflow"));
}

[Fact]
public async Task TracingInterceptor_StandaloneActivity_HasProperSpans()
{
var cancelId = $"act-cancel-{Guid.NewGuid()}";
var terminateId = $"act-terminate-{Guid.NewGuid()}";
var spans = await WithTracingWorkerAsync(async (client, _) =>
{
var taskQueue = $"standalone-tq-{Guid.NewGuid()}";

var cancelHandle = await client.StartActivityAsync(
"StandaloneActivity",
Array.Empty<object?>(),
new(cancelId, taskQueue) { ScheduleToCloseTimeout = TimeSpan.FromMinutes(5) });
await cancelHandle.DescribeAsync();
await cancelHandle.CancelAsync();

var terminateHandle = await client.StartActivityAsync(
"StandaloneActivity",
Array.Empty<object?>(),
new(terminateId, taskQueue) { ScheduleToCloseTimeout = TimeSpan.FromMinutes(5) });
await terminateHandle.TerminateAsync();

await client.CountActivitiesAsync($"TaskQueue = '{taskQueue}'");
});

var cancelTags = new[] { ActivityAssertion.TagEqual("temporalActivityID", cancelId) };
var terminateTags = new[] { ActivityAssertion.TagEqual("temporalActivityID", terminateId) };
AssertActivities(
spans,
new("StartActivity:StandaloneActivity", Parent: null, Tags: cancelTags),
new("DescribeActivity:" + cancelId, Parent: null, Tags: cancelTags),
new("CancelActivity:" + cancelId, Parent: null, Tags: cancelTags),
new("StartActivity:StandaloneActivity", Parent: null, Tags: terminateTags),
new("TerminateActivity:" + terminateId, Parent: null, Tags: terminateTags),
ActivityAssertion.NameAndParent("CountActivities", null));
}

private static void AssertActivities(
IReadOnlyCollection<Activity> activities, params ActivityAssertion[] assertions)
{
Expand Down Expand Up @@ -886,7 +923,7 @@ private async Task<IReadOnlyCollection<Activity>> WithTracingWorkerAsync(
var activities = new List<Activity>();

// Setup provider
using var tracerProvider = global::OpenTelemetry.Sdk.CreateTracerProviderBuilder().
using var _ = global::OpenTelemetry.Sdk.CreateTracerProviderBuilder().
Copy link
Copy Markdown
Contributor Author

@cconstable cconstable Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took me a second to realize that tracerProvider was not actually being used we were just using using for lifetime management. Swapped to discard variable instead which preserves lifetime management but better signals intent.

AddSource(
TracingInterceptor.ClientSource.Name,
TracingInterceptor.WorkflowsSource.Name,
Expand Down
Loading