Skip to content

[HttpClient and ASP.NET Core] Fix failures due to changes in .NET8.0 stable release #5049

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
utpilla merged 4 commits into from
Nov 14, 2023
Merged

[HttpClient and ASP.NET Core] Fix failures due to changes in .NET8.0 stable release #5049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c6c26ab
fix .net8.0 failures
Nov 14, 2023
75b9fc6
pr link
Nov 14, 2023
ccc04e9
nit
Nov 14, 2023
4a41a41
Update src/OpenTelemetry.Instrumentation.Http/CHANGELOG.md
utpilla Nov 14, 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
4 changes: 4 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 @@ -41,6 +41,10 @@ exception. The attribute value will be set to full name of exception type.
path.
([#5044](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5044))

* Removed `network.protocol.name` from `http.server.request.duration` metric as
per spec.
([#5049](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5049))

## 1.6.0-beta.2

Released 2023-Oct-26
Expand Down
1 change: 0 additions & 1 deletion src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,6 @@ public void OnEventWritten_New(string name, object payload)
TagList tags = default;

// see the spec https://github.com/open-telemetry/semantic-conventions/blob/v1.21.0/docs/http/http-spans.md
tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeNetworkProtocolName, NetworkProtocolName));
tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeNetworkProtocolVersion, HttpTagHelper.GetFlavorTagValueFromProtocol(context.Request.Protocol)));
tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeUrlScheme, context.Request.Scheme));
tags.Add(new KeyValuePair<string, object>(SemanticConventions.AttributeHttpResponseStatusCode, TelemetryHelper.GetBoxedStatusCode(context.Response.StatusCode)));
Expand Down
4 changes: 4 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 @@ -118,6 +118,10 @@ Released 2023-Oct-26
definition.
([#4990](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4990))

* `dns.lookups.duration` metric is renamed to `dns.lookup.duration`. This change
Copy link
Member

@cijothomas cijothomas Nov 14, 2023

Choose a reason for hiding this comment

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

interesting...there is no code change here. Do we plan to keep updating changelog in otel instrumentation, for every change in .net repo? Or this is a one-time thing and we dont expect anything futher?

Copy link
Member Author

@vishweshbankwar vishweshbankwar Nov 14, 2023

Choose a reason for hiding this comment

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

I mentioned this one because we have a changelog entry in previous release with different name. In future, I don't think we need to mention every change. Except when the change might impact users moving from lower version to net8 or above.

Copy link
Contributor

@utpilla utpilla Nov 14, 2023

Choose a reason for hiding this comment

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

Going forward, I think we should simply update the README to point to the Microsoft official docs which lists these metrics and let users track the changes from there.

impacts only users on `.NET8.0` or newer framework.
([#5049](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5049))

## 1.5.1-beta.1

Released 2023-Jul-20
Expand Down
11 changes: 3 additions & 8 deletions test/OpenTelemetry.Instrumentation.AspNetCore.Tests/MetricTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ public async Task RequestMetricIsCaptured_New(string api, string expectedRoute,
expectedRoutes: new List<string> { expectedRoute },
expectedErrorType,
expectedStatusCode,
expectedTagsCount: expectedErrorType == null ? 6 : 7);
expectedTagsCount: expectedErrorType == null ? 5 : 6);
}

[Theory]
Expand Down Expand Up @@ -440,7 +440,7 @@ public async Task RequestMetricIsCaptured_Dup()
expectedRoutes: new List<string> { "api/Values", "api/Values/{id}" },
null,
200,
expectedTagsCount: 6);
expectedTagsCount: 5);
}
#endif

Expand Down Expand Up @@ -565,13 +565,8 @@ private static KeyValuePair<string, object>[] AssertMetricPoint_New(

if (expectedErrorType != null)
{
#if NET8_0_OR_GREATER
// Expected to change in next release
// https://github.com/dotnet/aspnetcore/issues/51029
var errorType = new KeyValuePair<string, object>("exception.type", expectedErrorType);
#else
var errorType = new KeyValuePair<string, object>(SemanticConventions.AttributeErrorType, expectedErrorType);
#endif

Assert.Contains(errorType, attributes);
}

Expand Down
4 changes: 1 addition & 3 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 @@ -189,16 +189,14 @@ public async Task ValidateNet8MetricsAsync(HttpTestData.HttpOutTestCase tc)
meterProvider.Dispose();
}

// dns.lookups.duration is a typo
// https://github.com/dotnet/runtime/issues/92917
var requestMetrics = metrics
.Where(metric =>
metric.Name == "http.client.request.duration" ||
metric.Name == "http.client.active_requests" ||
metric.Name == "http.client.request.time_in_queue" ||
metric.Name == "http.client.connection.duration" ||
metric.Name == "http.client.open_connections" ||
metric.Name == "dns.lookups.duration")
metric.Name == "dns.lookup.duration")
.ToArray();

if (tc.ResponseExpected)
Expand Down