Add RecordException overload accepting additional tags #3433

alanwest · 2022-07-07T22:53:50Z

Adds RecordException overload accepting additional tags to add to the exception event.

public static void RecordException(this Activity activity, Exception ex, TagList tags)

codecov · 2022-07-07T23:06:22Z

Codecov Report

Merging #3433 (80e6ef2) into main (ab10e11) will increase coverage by 0.18%.
The diff coverage is 100.00%.

❗ Current head 80e6ef2 differs from pull request most recent head 6c50cf6. Consider uploading reports for the commit 6c50cf6 to get more accurate results

@@            Coverage Diff             @@
##             main    #3433      +/-   ##
==========================================
+ Coverage   86.21%   86.39%   +0.18%     
==========================================
  Files         265      265              
  Lines        9598     9602       +4     
==========================================
+ Hits         8275     8296      +21     
+ Misses       1323     1306      -17

Impacted Files	Coverage Δ
src/OpenTelemetry.Api/Trace/ActivityExtensions.cs	`95.23% <100.00%> (+1.12%)`	⬆️
...ter.ZPages/Implementation/ZPagesActivityTracker.cs	`97.14% <0.00%> (-2.86%)`	⬇️
...Telemetry/Internal/SelfDiagnosticsEventListener.cs	`97.65% <0.00%> (+0.78%)`	⬆️
...metryProtocol/Implementation/ActivityExtensions.cs	`94.50% <0.00%> (+3.29%)`	⬆️
...emetry.Api/Internal/OpenTelemetryApiEventSource.cs	`82.35% <0.00%> (+8.82%)`	⬆️
...xporter.OpenTelemetryProtocol/OtlpTraceExporter.cs	`77.27% <0.00%> (+18.18%)`	⬆️
...entation/ExportClient/OtlpGrpcTraceExportClient.cs	`78.57% <0.00%> (+28.57%)`	⬆️

CodeBlanch · 2022-07-08T16:37:23Z

@alanwest Could we use TagList?

Reasons...

Allocation free up to 8 tags.
Allocation free foreach.
Slightly nicer syntax (debatable 🤣) you can new it up using collection initializer like...
```
activity.RecordException(ex, new() { new("myTag", "myValue") })
```

If you do decide to go with TagList it could be large so we should probably use in modifier:

 public static void RecordException(this Activity activity, Exception ex, in TagList tags)

alanwest · 2022-07-11T20:49:54Z

Could we use TagList?

I agree with the benefits, but I guess the reason I didn't reach for TagList is that it is not used by any of the existing Activity APIs (might fact check me on this...). I was inclined to consider ActivityTagsCollection since that is what the ActivityEvent constructor takes and RecordException is effectively a specialized form of adding an event... but by and large most Activity APIs that take a list of tags accept IEnumerable<KeyValuePair<string, object>>, so I was trying not to make this API a unicorn 🦄.

Also, one might argue that RecordException should be offered by .NET itself since it is part of the spec and not as an extension method offered by us. So, in this sense I was trying to get into the heads of the .NET team and ask my self WWDND (what would .NET do)?

TagList implements IEnumerable<KeyValuePair<string, object>>, so it could still be used - albeit not with the sugary syntax. Could RecordException do a tags is TagList enumerateMeForFree to get the perf benefit? I guess there's probably a boxing in passing it to RecordException, but then would there still be a benefit when enumerating?

cijothomas · 2022-07-11T21:14:59Z

Also, one might argue that RecordException should be offered by .NET itself since it is part of the spec and not as an extension method offered by us.

The spec is not marked stable for the Exceptions part.!

cijothomas · 2022-07-11T21:18:14Z

I didn't reach for TagList is that it is not used by any of the existing Activity APIs (might fact check me on this...)

IIRC, TagList was added while adding Metrics. It was intentionally not placed in .Metrics namespace, to re-use it in the future for Tracing as well. Its something we need to ask to be supported by StartActivity overloads. (We have a good use-case now - spec is recommending to add all available attributes at span creation. One good way to do it alloc-free would be to add more overloads to StartActivity, accepting TagList...

CodeBlanch · 2022-07-11T21:25:21Z

I agree with the benefits, but I guess the reason I didn't reach for TagList is that it is not used by any of the existing Activity APIs

Ya like @cijothomas said I think that is just because it came later 😄

Also, one might argue that RecordException should be offered by .NET itself since it is part of the spec and not as an extension method offered by us.

I think someday it will get there 😄 dotnet/runtime#53641

TagList implements IEnumerable<KeyValuePair<string, object>>, so it could still be used - albeit not with the sugary syntax. Could RecordException do a tags is TagList enumerateMeForFree to get the perf benefit? I guess there's probably a boxing in passing it to RecordException, but then would there still be a benefit when enumerating?

You mean have the method accept the interface and let user pass in TagList if they so-desire? Yes, possible, but allocates + copies so probably worse for perf!

If you made it RecordException<T>(Exception ex, T tags) where T : IEnumerable<KeyValuePair<string, object>> you could probably avoid the boxing and then use is TagList in the implementation to avoid the enumerator.

alanwest · 2022-07-11T21:38:10Z

The spec is not marked stable for the Exceptions part.!

and

I think someday it will get there 😄 dotnet/runtime#53641

Understood - though wasn't aware of the already open issue. The thing I was unsure of was whether once it was part of the Activity API what type would be used. Sounds like it's expected that TagList will be used. If so, then yes makes complete sense to use TagList.

utpilla · 2022-07-13T23:47:42Z

src/OpenTelemetry.Api/Trace/ActivityExtensions.cs

@@ -92,6 +104,11 @@ public static void RecordException(this Activity activity, Exception ex)
                tagsCollection.Add(SemanticConventions.AttributeExceptionMessage, ex.Message);
            }

+            foreach (var tag in tags)


Add a null check for activity in the beginning to return if the activity is null and avoid creating tagsCollection and copying from tagList.

Added null check.

This brought my attention to a somewhat interesting question: what if ex is null, but tags is not?

One might argue that the only reason someone would call RecordException is if they had a non-null exception and that if they just wanted to add an event then they'd call Activity.AddEvent.

But what do folks think? Should we add an event anyways even though no exception related attributes may end up on the event?

Should we add an event anyways even though no exception related attributes may end up on the event?

It doesn't sound right to me. I assume most people would use this in the catch block or some callback for when an exception occurs. So, it should not be a common scenario. I would say, as you mentioned, they should just use Activity.AddEvent if it has nothing to do with an actual exception.

utpilla

Left a suggestion. Looks good overall.

…elemetry-dotnet into alanwest/record-exception

src/OpenTelemetry.Api/Trace/ActivityExtensions.cs

…elemetry-dotnet into alanwest/record-exception

cijothomas · 2022-07-16T01:24:51Z

src/OpenTelemetry.Api/Trace/ActivityExtensions.cs

+        /// <param name="ex">Exception to be recorded.</param>
+        /// <param name="tags">Additional tags to record on the event.</param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public static void RecordException(this Activity activity, Exception ex, in TagList tags)


unless Activity.AddEvent/team also accepts TagList, the benefits of using TagList in this API is nil, as we anyway have to allocate the ActivityTagsCollection.

Hopefully if/when the spec is stable, we can bring this up.

I think the idea is that the consumer can still avoid some allocations when using TagList, but yea the benefit would be greater if AddEvent accepted TagList as well.

cijothomas

Please update the PR description with the final shape of the API.

Add RecordException overload accepting additional tags

ffbb9df

alanwest requested a review from a team as a code owner July 7, 2022 22:53

alanwest added 2 commits July 7, 2022 15:56

Update changelog

e1594df

Update public api

53d404d

Merge branch 'main' into alanwest/record-exception

995ee76

alanwest added 5 commits July 11, 2022 14:54

Use TagList

c763866

Update public API

18b0d53

Update public API

e8b6d27

Merge branch 'main' into alanwest/record-exception

9b0ac03

Merge branch 'main' into alanwest/record-exception

0173bff

utpilla reviewed Jul 13, 2022

View reviewed changes

utpilla approved these changes Jul 13, 2022

View reviewed changes

alanwest added 2 commits July 14, 2022 16:33

Check if activity is null

09e8533

Merge branch 'alanwest/record-exception' of github.com:alanwest/opent…

58a1d43

…elemetry-dotnet into alanwest/record-exception

utpilla reviewed Jul 15, 2022

View reviewed changes

src/OpenTelemetry.Api/Trace/ActivityExtensions.cs Outdated Show resolved Hide resolved

utpilla approved these changes Jul 15, 2022

View reviewed changes

utpilla and others added 4 commits July 14, 2022 23:19

Merge branch 'main' into alanwest/record-exception

1265c25

-?

0ae7a0d

Merge branch 'alanwest/record-exception' of github.com:alanwest/opent…

a6890ae

…elemetry-dotnet into alanwest/record-exception

Merge branch 'main' into alanwest/record-exception

6ce4144

utpilla approved these changes Jul 15, 2022

View reviewed changes

cijothomas reviewed Jul 16, 2022

View reviewed changes

cijothomas approved these changes Jul 16, 2022

View reviewed changes

alanwest added 2 commits July 18, 2022 13:27

Merge branch 'main' into alanwest/record-exception

80e6ef2

Merge branch 'main' into alanwest/record-exception

6c50cf6

alanwest merged commit 5c9a5c6 into open-telemetry:main Jul 19, 2022

alanwest deleted the alanwest/record-exception branch July 19, 2022 21:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RecordException overload accepting additional tags #3433

Add RecordException overload accepting additional tags #3433

alanwest commented Jul 7, 2022 •

edited

Loading

codecov bot commented Jul 7, 2022 •

edited

Loading

CodeBlanch commented Jul 8, 2022

alanwest commented Jul 11, 2022 •

edited

Loading

cijothomas commented Jul 11, 2022

cijothomas commented Jul 11, 2022

CodeBlanch commented Jul 11, 2022

alanwest commented Jul 11, 2022

utpilla Jul 13, 2022

alanwest Jul 14, 2022

utpilla Jul 15, 2022

utpilla left a comment

cijothomas Jul 16, 2022

alanwest Jul 18, 2022

cijothomas left a comment

Add RecordException overload accepting additional tags #3433

Add RecordException overload accepting additional tags #3433

Conversation

alanwest commented Jul 7, 2022 • edited Loading

codecov bot commented Jul 7, 2022 • edited Loading

Codecov Report

CodeBlanch commented Jul 8, 2022

alanwest commented Jul 11, 2022 • edited Loading

cijothomas commented Jul 11, 2022

cijothomas commented Jul 11, 2022

CodeBlanch commented Jul 11, 2022

alanwest commented Jul 11, 2022

utpilla Jul 13, 2022

Choose a reason for hiding this comment

alanwest Jul 14, 2022

Choose a reason for hiding this comment

utpilla Jul 15, 2022

Choose a reason for hiding this comment

utpilla left a comment

Choose a reason for hiding this comment

cijothomas Jul 16, 2022

Choose a reason for hiding this comment

alanwest Jul 18, 2022

Choose a reason for hiding this comment

cijothomas left a comment

Choose a reason for hiding this comment

alanwest commented Jul 7, 2022 •

edited

Loading

codecov bot commented Jul 7, 2022 •

edited

Loading

alanwest commented Jul 11, 2022 •

edited

Loading