Skip to content
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

[AspNetCore] [Http] remove Activity Status Description and update unit tests #5025

Merged
merged 6 commits into from
Nov 9, 2023
Merged

[AspNetCore] [Http] remove Activity Status Description and update unit tests #5025

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5a03661
remove status description and update unit tests
TimothyMothra Nov 3, 2023
8ceb1c8
Merge branch 'main' into 4983_statusDescription
vishweshbankwar Nov 6, 2023
b981ebf
update changelog
TimothyMothra Nov 7, 2023
be21041
updated changelog
TimothyMothra Nov 7, 2023
335f9bb
update changelog
TimothyMothra Nov 7, 2023
a27b093
Merge branch 'main' into 4983_statusDescription
utpilla Nov 9, 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
7 changes: 7 additions & 0 deletions src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## Unreleased

* On Exception, Activity Status is set to Error. The Exception Message
Copy link
Member

@vishweshbankwar vishweshbankwar Nov 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Removed the Activity Status Description that was being set during unhandled exceptions. Activity Status will continue to be reported as Error

something like this would be more clear IMO

has been removed from Activity Status Description to comply with the
[Http spec](https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#status).
This is a **breaking change**. `EnrichWithException` can be leveraged
to restore this behavior.
([#5025](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5025))

* Updated `http.request.method` to match specification guidelines.
* For activity, if the method does not belong to one of the [known
values](https://github.com/open-telemetry/semantic-conventions/blob/v1.22.0/docs/http/http-spans.md#:~:text=http.request.method%20has%20the%20following%20list%20of%20well%2Dknown%20values)
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ public void OnException(Activity activity, object payload)
activity.RecordException(exc);
}

activity.SetStatus(ActivityStatusCode.Error, exc.Message);
activity.SetStatus(ActivityStatusCode.Error);

try
{
Expand Down
7 changes: 7 additions & 0 deletions src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## Unreleased

* On Exception, Activity Status is set to Error. The Exception Message
has been removed from Activity Status Description to comply with the
[Http spec](https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#status).
This is a **breaking change**. `EnrichWithException` can be leveraged
to restore this behavior.
([#5025](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5025))

* Updated `http.request.method` to match specification guidelines.
* For activity, if the method does not belong to one of the [known
values](https://github.com/open-telemetry/semantic-conventions/blob/v1.22.0/docs/http/http-spans.md#:~:text=http.request.method%20has%20the%20following%20list%20of%20well%2Dknown%20values)
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.Instrumentation.Http/Implementation/HttpHandlerDiagnosticListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ public void OnException(Activity activity, object payload)

if (exc is HttpRequestException)
{
activity.SetStatus(ActivityStatusCode.Error, exc.Message);
activity.SetStatus(ActivityStatusCode.Error);
}

try
Expand Down
51 changes: 12 additions & 39 deletions src/OpenTelemetry.Instrumentation.Http/Implementation/HttpWebRequestActivitySource.netfx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,57 +230,30 @@ private static void AddExceptionTags(Exception exception, Activity activity, out
}

ActivityStatusCode status;
string exceptionMessage = null;

if (exception is WebException wexc)
if (exception is WebException wexc && wexc.Response is HttpWebResponse response)
{
if (wexc.Response is HttpWebResponse response)
{
statusCode = response.StatusCode;

if (tracingEmitOldAttributes)
{
activity.SetTag(SemanticConventions.AttributeHttpStatusCode, (int)statusCode);
}
statusCode = response.StatusCode;

if (tracingEmitNewAttributes)
{
activity.SetTag(SemanticConventions.AttributeHttpResponseStatusCode, (int)statusCode);
}

status = SpanHelper.ResolveSpanStatusForHttpStatusCode(activity.Kind, (int)statusCode);
if (tracingEmitOldAttributes)
{
activity.SetTag(SemanticConventions.AttributeHttpStatusCode, (int)statusCode);
}
else

if (tracingEmitNewAttributes)
{
switch (wexc.Status)
{
case WebExceptionStatus.Timeout:
case WebExceptionStatus.RequestCanceled:
status = ActivityStatusCode.Error;
break;
case WebExceptionStatus.SendFailure:
case WebExceptionStatus.ConnectFailure:
case WebExceptionStatus.SecureChannelFailure:
case WebExceptionStatus.TrustFailure:
case WebExceptionStatus.ServerProtocolViolation:
case WebExceptionStatus.MessageLengthLimitExceeded:
status = ActivityStatusCode.Error;
exceptionMessage = exception.Message;
break;
default:
status = ActivityStatusCode.Error;
exceptionMessage = exception.Message;
break;
}
activity.SetTag(SemanticConventions.AttributeHttpResponseStatusCode, (int)statusCode);
}

status = SpanHelper.ResolveSpanStatusForHttpStatusCode(activity.Kind, (int)statusCode);
}
else
{
status = ActivityStatusCode.Error;
exceptionMessage = exception.Message;
}

activity.SetStatus(status, exceptionMessage);
activity.SetStatus(status);

if (TracingOptions.RecordException)
{
activity.RecordException(exception);
Expand Down
9 changes: 1 addition & 8 deletions ....Instrumentation.AspNetCore.Tests/IncomingRequestsCollectionsIsAccordingToTheSpecTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,7 @@ public async Task SuccessfulTemplateControllerCallGeneratesASpan_Old(

// Instrumentation is not expected to set status description
// as the reason can be inferred from SemanticConventions.AttributeHttpStatusCode
if (!urlPath.EndsWith("exception"))
{
Assert.True(string.IsNullOrEmpty(activity.StatusDescription));
}
else
{
Assert.Equal("exception description", activity.StatusDescription);
}
Assert.Null(activity.StatusDescription);

if (recordException)
{
Expand Down
9 changes: 1 addition & 8 deletions ...rumentation.AspNetCore.Tests/IncomingRequestsCollectionsIsAccordingToTheSpecTests_Dupe.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,14 +138,7 @@ public async Task SuccessfulTemplateControllerCallGeneratesASpan_Dupe(

// Instrumentation is not expected to set status description
// as the reason can be inferred from SemanticConventions.AttributeHttpStatusCode
if (!urlPath.EndsWith("exception"))
{
Assert.True(string.IsNullOrEmpty(activity.StatusDescription));
}
else
{
Assert.Equal("exception description", activity.StatusDescription);
}
Assert.Null(activity.StatusDescription);

if (recordException)
{
Expand Down
9 changes: 1 addition & 8 deletions ...trumentation.AspNetCore.Tests/IncomingRequestsCollectionsIsAccordingToTheSpecTests_New.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,7 @@ public async Task SuccessfulTemplateControllerCallGeneratesASpan_New(

// Instrumentation is not expected to set status description
// as the reason can be inferred from SemanticConventions.AttributeHttpStatusCode
if (!urlPath.EndsWith("exception"))
{
Assert.True(string.IsNullOrEmpty(activity.StatusDescription));
}
else
{
Assert.Equal("exception description", activity.StatusDescription);
}
Assert.Null(activity.StatusDescription);

if (recordException)
{
Expand Down
7 changes: 1 addition & 6 deletions test/OpenTelemetry.Instrumentation.Http.Tests/HttpClientTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,12 +337,7 @@ private static async Task HttpOutCallsAreCollectedSuccessfullyBodyAsync(

// Assert.Equal(tc.SpanStatus, d[span.Status.CanonicalCode]);
Assert.Equal(tc.SpanStatus, activity.Status.ToString());

if (tc.SpanStatusHasDescription.HasValue)
{
var desc = activity.StatusDescription;
Assert.Equal(tc.SpanStatusHasDescription.Value, !string.IsNullOrEmpty(desc));
}
Assert.Null(activity.StatusDescription);

var normalizedAttributes = activity.TagObjects.Where(kv => !kv.Key.StartsWith("otel.")).ToDictionary(x => x.Key, x => x.Value.ToString());

Expand Down
2 changes: 0 additions & 2 deletions test/OpenTelemetry.Instrumentation.Http.Tests/HttpTestData.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ public class HttpOutTestCase

public string SpanStatus { get; set; }

public bool? SpanStatusHasDescription { get; set; }

public Dictionary<string, string> SpanAttributes { get; set; }
}
}
6 changes: 3 additions & 3 deletions test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestActivitySourceTests.netfx.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ public async Task TestRequestWithException(string method)
Assert.Equal("Stop", exceptionEvent.Key);

Assert.True(activity.Status != ActivityStatusCode.Unset);
Assert.NotNull(activity.StatusDescription);
Assert.Null(activity.StatusDescription);
}

/// <summary>
Expand Down Expand Up @@ -627,7 +627,7 @@ public async Task TestSecureTransportFailureRequest(string method)
Assert.Equal("Stop", exceptionEvent.Key);

Assert.True(exceptionEvent.Value.Status != ActivityStatusCode.Unset);
Assert.NotNull(exceptionEvent.Value.StatusDescription);
Assert.Null(exceptionEvent.Value.StatusDescription);
}

/// <summary>
Expand Down Expand Up @@ -669,7 +669,7 @@ public async Task TestSecureTransportRetryFailureRequest(string method)
Assert.Equal("Stop", exceptionEvent.Key);

Assert.True(exceptionEvent.Value.Status != ActivityStatusCode.Unset);
Assert.NotNull(exceptionEvent.Value.StatusDescription);
Assert.Null(exceptionEvent.Value.StatusDescription);
}

[Fact]
Expand Down
6 changes: 1 addition & 5 deletions test/OpenTelemetry.Instrumentation.Http.Tests/HttpWebRequestTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,7 @@ public void HttpOutCallsAreCollectedSuccessfully(HttpTestData.HttpOutTestCase tc

if (tag.Key == SpanAttributeConstants.StatusDescriptionKey)
{
if (tc.SpanStatusHasDescription.HasValue)
{
Assert.Equal(tc.SpanStatusHasDescription.Value, !string.IsNullOrEmpty(tagValue));
}

Assert.Null(tagValue);
continue;
}

Expand Down
2 changes: 0 additions & 2 deletions test/OpenTelemetry.Instrumentation.Http.Tests/http-out-test-cases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@
"url": "http://sdlfaldfjalkdfjlkajdflkajlsdjf:{port}/",
"spanName": "HTTP GET",
"spanStatus": "Error",
"spanStatusHasDescription": true,
"responseExpected": false,
"recordException": false,
"spanAttributes": {
Expand All @@ -111,7 +110,6 @@
"url": "http://sdlfaldfjalkdfjlkajdflkajlsdjf:{port}/",
"spanName": "HTTP GET",
"spanStatus": "Error",
"spanStatusHasDescription": true,
"responseExpected": false,
"recordException": true,
"spanAttributes": {
Expand Down