Skip to content

Export Activity.StatusDescription as otel.status_description custom property #54032

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+123 −0
Draft

Export Activity.StatusDescription as otel.status_description custom property #54032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c60ba5c
Initial plan
Copilot Nov 19, 2025
cc28739
Add support for Activity.StatusDescription export as otel.status_desc…
Copilot Nov 19, 2025
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
7 changes: 7 additions & 0 deletions ...or/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/Models/RemoteDependencyData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@ public RemoteDependencyData(int version, Activity activity, ref ActivityTagsProc
}

TraceHelper.AddActivityLinksToProperties(activity, ref activityTagsProcessor.UnMappedTags);

// Add StatusDescription as a custom property if present
if (!string.IsNullOrEmpty(activity.StatusDescription))
{
TraceHelper.AddKvpToDictionary(Properties, "otel.status_description", activity.StatusDescription!);
}

TraceHelper.AddPropertiesToTelemetry(Properties, ref activityTagsProcessor.UnMappedTags);
}

Expand Down
6 changes: 6 additions & 0 deletions sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/Models/RequestData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ public RequestData(int version, Activity activity, ref ActivityTagsProcessor act
TraceHelper.AddActivityLinksToProperties(activity, ref activityTagsProcessor.UnMappedTags);
}

// Add StatusDescription as a custom property if present
if (!string.IsNullOrEmpty(activity.StatusDescription))
{
TraceHelper.AddKvpToDictionary(Properties, "otel.status_description", activity.StatusDescription!);
}

TraceHelper.AddPropertiesToTelemetry(Properties, ref activityTagsProcessor.UnMappedTags);
}

Expand Down
56 changes: 56 additions & 0 deletions ...ry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/RemoteDependencyDataTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,5 +266,61 @@ public void VerifyAllDependenciesSetTargetViaServerAddressAndPort()

Assert.Equal("unitTestAddress:unitTestPort", remoteDependencyData.Target);
}

[Fact]
public void ValidateRemoteDependencyDataWithStatusDescription()
{
using ActivitySource activitySource = new ActivitySource(ActivitySourceName);
using var activity = activitySource.StartActivity(
ActivityName,
ActivityKind.Client,
parentContext: new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded),
startTime: DateTime.UtcNow);

Assert.NotNull(activity);
activity.Stop();

var httpUrl = "https://www.foo.bar/search";
var statusDescription = "Dependency call failed due to network error";
activity.SetStatus(ActivityStatusCode.Error, statusDescription);
activity.SetTag(SemanticConventions.AttributeHttpMethod, "GET");
activity.SetTag(SemanticConventions.AttributeHttpUrl, httpUrl);
activity.SetTag(SemanticConventions.AttributeHttpStatusCode, "503");

var activityTagsProcessor = TraceHelper.EnumerateActivityTags(activity);

var remoteDependencyData = new RemoteDependencyData(2, activity, ref activityTagsProcessor);

Assert.False(remoteDependencyData.Success);
Assert.True(remoteDependencyData.Properties.ContainsKey("otel.status_description"));
Assert.Equal(statusDescription, remoteDependencyData.Properties["otel.status_description"]);
}

[Fact]
public void ValidateRemoteDependencyDataWithoutStatusDescription()
{
using ActivitySource activitySource = new ActivitySource(ActivitySourceName);
using var activity = activitySource.StartActivity(
ActivityName,
ActivityKind.Client,
parentContext: new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded),
startTime: DateTime.UtcNow);

Assert.NotNull(activity);
activity.Stop();

var httpUrl = "https://www.foo.bar/search";
activity.SetStatus(ActivityStatusCode.Error); // No description
activity.SetTag(SemanticConventions.AttributeHttpMethod, "GET");
activity.SetTag(SemanticConventions.AttributeHttpUrl, httpUrl);
activity.SetTag(SemanticConventions.AttributeHttpStatusCode, "503");

var activityTagsProcessor = TraceHelper.EnumerateActivityTags(activity);

var remoteDependencyData = new RemoteDependencyData(2, activity, ref activityTagsProcessor);

Assert.False(remoteDependencyData.Success);
Assert.False(remoteDependencyData.Properties.ContainsKey("otel.status_description"));
}
}
}
54 changes: 54 additions & 0 deletions ...enTelemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/RequestDataTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,60 @@ public void RequestDataTimeSinceEnqueuedInvalidEmqueuedTime()
Assert.False(requestData.Measurements.TryGetValue("timeSinceEnqueued", out var timeInQueue));
}

[Fact]
public void ValidateRequestDataWithStatusDescription()
{
using ActivitySource activitySource = new ActivitySource(ActivitySourceName);
using var activity = activitySource.StartActivity(
ActivityName,
ActivityKind.Server,
parentContext: new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded),
startTime: DateTime.UtcNow);
Assert.NotNull(activity);
activity.Stop();

var httpUrl = "https://www.foo.bar/search";
var statusDescription = "Request failed due to timeout";
activity.SetStatus(ActivityStatusCode.Error, statusDescription);
activity.SetTag(SemanticConventions.AttributeHttpMethod, "GET");
activity.SetTag(SemanticConventions.AttributeHttpUrl, httpUrl);
activity.SetTag(SemanticConventions.AttributeHttpStatusCode, "500");

var activityTagsProcessor = TraceHelper.EnumerateActivityTags(activity);

var requestData = new RequestData(2, activity, ref activityTagsProcessor);

Assert.False(requestData.Success);
Assert.True(requestData.Properties.ContainsKey("otel.status_description"));
Assert.Equal(statusDescription, requestData.Properties["otel.status_description"]);
}

[Fact]
public void ValidateRequestDataWithoutStatusDescription()
{
using ActivitySource activitySource = new ActivitySource(ActivitySourceName);
using var activity = activitySource.StartActivity(
ActivityName,
ActivityKind.Server,
parentContext: new ActivityContext(ActivityTraceId.CreateRandom(), ActivitySpanId.CreateRandom(), ActivityTraceFlags.Recorded),
startTime: DateTime.UtcNow);
Assert.NotNull(activity);
activity.Stop();

var httpUrl = "https://www.foo.bar/search";
activity.SetStatus(ActivityStatusCode.Error); // No description
activity.SetTag(SemanticConventions.AttributeHttpMethod, "GET");
activity.SetTag(SemanticConventions.AttributeHttpUrl, httpUrl);
activity.SetTag(SemanticConventions.AttributeHttpStatusCode, "500");

var activityTagsProcessor = TraceHelper.EnumerateActivityTags(activity);

var requestData = new RequestData(2, activity, ref activityTagsProcessor);

Assert.False(requestData.Success);
Assert.False(requestData.Properties.ContainsKey("otel.status_description"));
}

private ActivityLink AddActivityLink(long enqueuedTime)
{
ActivityTagsCollection tags = new ActivityTagsCollection
Expand Down
Loading