[ASP.NET Core] Add `error.type` attribute for tracing and metrics #4986

vishweshbankwar · 2023-10-24T20:59:31Z

Fixes #
Design discussion issue #

Changes

Adds error.type attribute to trace and metrics.

https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md
https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md

.NET8.0 implementation of metrics ignores setting error.type to status code value in case of failure as per the spec. I have opened an issue to get this fixed dotnet/aspnetcore#51620. For now, the issue is targeted to be fixed in .NET9.0.

The change in this PR ensures that the value is consistent with how .NET8.0 is setting this attribute in metrics in order to avoid breaking change for users migrating from lower versions to .NET8.0.

This change does not resolve
#4865

Merge requirement checklist

CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

codecov · 2023-10-24T21:24:33Z

Codecov Report

Merging #4986 (b59075c) into main (37481f1) will increase coverage by 0.05%.
The diff coverage is 91.30%.

@@            Coverage Diff             @@
##             main    #4986      +/-   ##
==========================================
+ Coverage   83.38%   83.43%   +0.05%     
==========================================
  Files         296      296              
  Lines       12385    12403      +18     
==========================================
+ Hits        10327    10349      +22     
+ Misses       2058     2054       -4

Flag	Coverage Δ
unittests	`83.43% <91.30%> (+0.05%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...ry.Instrumentation.AspNetCore/AspNetCoreMetrics.cs	`100.00% <100.00%> (ø)`
...tation.AspNetCore/Implementation/HttpInListener.cs	`91.87% <100.00%> (+0.08%)`	⬆️
...AspNetCore/Implementation/HttpInMetricsListener.cs	`86.95% <89.47%> (-0.32%)`	⬇️

... and 5 files with indirect coverage changes

github-actions · 2023-11-01T03:16:42Z

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or Pushing will instruct the bot to automatically remove the label. This bot runs once per day.

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs

TimothyMothra

On the whole looks good. Left some minor comments.

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs

utpilla · 2023-11-02T01:24:30Z

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs

        }
+
+        ctx.Items.Add(ErrorTypeKey, exc.GetType().FullName);


Would the framework create an activity even if only add AspNetCore metrics instrumentation? If yes, then I think we could add this information to Activity.Current. Do you know of any obvious pros and cons to adding this information to HttpContext vs Activity.Current?

yes, the activity will always be there. Perf was the main reason to choose HttpContext.Items. However, we could use custom property as well on activity. Here are the results from benchmarking

Results when trace is also enabled and activity will have additional tags.

Method Mean Error StdDev Median Gen0 Allocated

UseActivityTag 82.36 ns 1.691 ns 1.736 ns 83.06 ns 0.0085 40 B

UseActivityCustomProperty 81.98 ns 1.133 ns 1.004 ns 81.54 ns - -

UseContextItems 81.11 ns 1.656 ns 3.420 ns 79.67 ns - -

Results when only metrics will be enabled and activity will only have one tag

Method Mean Error StdDev Gen0 Allocated

UseActivityTag 55.56 ns 0.572 ns 0.535 ns 0.0085 40 B

UseActivityCustomProperty 80.94 ns 0.538 ns 0.477 ns - -

UseContextItems 80.50 ns 0.901 ns 0.843 ns - -

Based on above, I have updated the implementation to use custom property. We could follow the same thing on HttpClient side where we need to add error.type.

IIRC the first time you add a custom property to activity you pay for an allocation. Are we already adding one somewhere else? Seems a bit odd that the allocation isn't showing in the benchmark.

@CodeBlanch Good catch. The alloc is not showing up in the benchmark as it is getting ignored due to multiple runs. I have switched back to using context.items and it improved the look up as well using the minor tweak on the context key suggested by you. here are the results.

Method Mean Error StdDev Gen0 Allocated

UseActivityTag 56.93 ns 0.572 ns 0.446 ns 0.0085 40 B

UseActivityCustomProperty 83.61 ns 0.546 ns 0.511 ns - -

UseContextItemsObjectKey 68.49 ns 0.429 ns 0.401 ns - -

UseContextItemsStringKey 84.91 ns 1.191 ns 0.994 ns - -

test/OpenTelemetry.Instrumentation.AspNetCore.Tests/MetricTests.cs

…om/vishweshbankwar/opentelemetry-dotnet into vibankwa/add-error-type-aspnetcore

CodeBlanch · 2023-11-03T03:54:47Z

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs

@@ -130,6 +171,7 @@ public void OnEventWritten_Old(string name, object payload)

    public void OnEventWritten_New(string name, object payload)
    {
+        var activity = Activity.Current;


Let's add a Debug.Assert(activity != null) here. I'm paranoid 🤣

we have a check here

CodeBlanch

LGTM

vishweshbankwar and others added 5 commits October 18, 2023 09:02

draft

15fd6ff

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

80ac64f

set error.type for asp.net core

fbe3eb5

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

219519f

rmv using

1d03f34

vishweshbankwar mentioned this pull request Oct 26, 2023

Default set of attributes for ASP.NET Core instrumentation (trace and metric) #4992

Closed

github-actions bot added the Stale Issues and pull requests which have been flagged for closing due to inactivity label Nov 1, 2023

vishweshbankwar added 5 commits November 1, 2023 09:10

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

a7e39de

refactor

e240c6b

changelog

f6a8e42

align

34419b5

property name

6a173ab

vishweshbankwar marked this pull request as ready for review November 1, 2023 19:00

vishweshbankwar requested a review from a team November 1, 2023 19:00

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

2ad4a4a

TimothyMothra reviewed Nov 1, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Show resolved Hide resolved

TimothyMothra reviewed Nov 1, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Outdated Show resolved Hide resolved

TimothyMothra reviewed Nov 1, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Outdated Show resolved Hide resolved

TimothyMothra reviewed Nov 1, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Outdated Show resolved Hide resolved

rmv unused code

386573d

TimothyMothra reviewed Nov 1, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Outdated Show resolved Hide resolved

TimothyMothra approved these changes Nov 1, 2023

View reviewed changes

vishweshbankwar added 2 commits November 1, 2023 13:47

address comment

a84e7a9

fix description

2350dc7

utpilla reviewed Nov 2, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Show resolved Hide resolved

utpilla reviewed Nov 2, 2023

View reviewed changes

src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInMetricsListener.cs Outdated Show resolved Hide resolved

utpilla reviewed Nov 2, 2023

View reviewed changes

test/OpenTelemetry.Instrumentation.AspNetCore.Tests/MetricTests.cs Outdated Show resolved Hide resolved

github-actions bot removed the Stale Issues and pull requests which have been flagged for closing due to inactivity label Nov 2, 2023

vishweshbankwar and others added 9 commits November 2, 2023 14:02

switch to activity tag from context.items

2f44398

use activity custom property

d9a2b19

rmv default param

ef2bdd3

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

ea5e5dc

refactor test

cd73339

Merge branch 'vibankwa/add-error-type-aspnetcore' of https://github.c…

20be1e3

…om/vishweshbankwar/opentelemetry-dotnet into vibankwa/add-error-type-aspnetcore

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

6bf11e0

assert

9777eac

Merge branch 'vibankwa/add-error-type-aspnetcore' of https://github.c…

7927e10

…om/vishweshbankwar/opentelemetry-dotnet into vibankwa/add-error-type-aspnetcore

utpilla approved these changes Nov 2, 2023

View reviewed changes

CodeBlanch reviewed Nov 3, 2023

View reviewed changes

CodeBlanch approved these changes Nov 3, 2023

View reviewed changes

rajkumar-rangaraj approved these changes Nov 3, 2023

View reviewed changes

vishweshbankwar and others added 2 commits November 3, 2023 10:14

switch back to ctx.items

a36104c

Merge branch 'main' into vibankwa/add-error-type-aspnetcore

b59075c

utpilla approved these changes Nov 3, 2023

View reviewed changes

utpilla merged commit d91be77 into open-telemetry:main Nov 3, 2023
70 checks passed

vishweshbankwar mentioned this pull request Nov 9, 2023

[Instrumentation.AspNet] Update semantic conventions for metrics open-telemetry/opentelemetry-dotnet-contrib#1429

Merged

4 tasks

vishweshbankwar mentioned this pull request Nov 21, 2023

[ASP.NET Core] Remove OTEL_SEMCONV_STABILITY_OPT_IN #5066

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ASP.NET Core] Add `error.type` attribute for tracing and metrics #4986

[ASP.NET Core] Add `error.type` attribute for tracing and metrics #4986

vishweshbankwar commented Oct 24, 2023 •

edited

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading

github-actions bot commented Nov 1, 2023

TimothyMothra left a comment

utpilla Nov 2, 2023

vishweshbankwar Nov 2, 2023

CodeBlanch Nov 3, 2023

vishweshbankwar Nov 3, 2023

CodeBlanch Nov 3, 2023

vishweshbankwar Nov 3, 2023

CodeBlanch left a comment

Method	Mean	Error	StdDev	Median	Gen0	Allocated
UseActivityTag	82.36 ns	1.691 ns	1.736 ns	83.06 ns	0.0085	40 B
UseActivityCustomProperty	81.98 ns	1.133 ns	1.004 ns	81.54 ns	-	-
UseContextItems	81.11 ns	1.656 ns	3.420 ns	79.67 ns	-	-

Method	Mean	Error	StdDev	Gen0	Allocated
UseActivityTag	55.56 ns	0.572 ns	0.535 ns	0.0085	40 B
UseActivityCustomProperty	80.94 ns	0.538 ns	0.477 ns	-	-
UseContextItems	80.50 ns	0.901 ns	0.843 ns	-	-

Method	Mean	Error	StdDev	Gen0	Allocated
UseActivityTag	56.93 ns	0.572 ns	0.446 ns	0.0085	40 B
UseActivityCustomProperty	83.61 ns	0.546 ns	0.511 ns	-	-
UseContextItemsObjectKey	68.49 ns	0.429 ns	0.401 ns	-	-
UseContextItemsStringKey	84.91 ns	1.191 ns	0.994 ns	-	-

[ASP.NET Core] Add error.type attribute for tracing and metrics #4986

[ASP.NET Core] Add error.type attribute for tracing and metrics #4986

Conversation

vishweshbankwar commented Oct 24, 2023 • edited Loading

Changes

Merge requirement checklist

codecov bot commented Oct 24, 2023 • edited Loading

Codecov Report

github-actions bot commented Nov 1, 2023

TimothyMothra left a comment

Choose a reason for hiding this comment

utpilla Nov 2, 2023

Choose a reason for hiding this comment

vishweshbankwar Nov 2, 2023

Choose a reason for hiding this comment

CodeBlanch Nov 3, 2023

Choose a reason for hiding this comment

vishweshbankwar Nov 3, 2023

Choose a reason for hiding this comment

CodeBlanch Nov 3, 2023

Choose a reason for hiding this comment

vishweshbankwar Nov 3, 2023

Choose a reason for hiding this comment

CodeBlanch left a comment

Choose a reason for hiding this comment

[ASP.NET Core] Add `error.type` attribute for tracing and metrics #4986

[ASP.NET Core] Add `error.type` attribute for tracing and metrics #4986

vishweshbankwar commented Oct 24, 2023 •

edited

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading