Skip to content

Commit 93fd7d3

Browse files
authored
Doc fix for RecordException (#5143)
1 parent 58e8f24 commit 93fd7d3

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/OpenTelemetry.Api/Trace/ActivityExtensions.cs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,26 @@ public static Status GetStatus(this Activity activity)
5757
}
5858

5959
/// <summary>
60-
/// Adds an activity event containing information from the specified exception.
60+
/// Adds an <see cref="ActivityEvent"/> containing information from the specified exception.
6161
/// </summary>
6262
/// <param name="activity">Activity instance.</param>
6363
/// <param name="ex">Exception to be recorded.</param>
64+
/// <remarks> The exception is recorded as per <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/exceptions.md">specification</a>.
65+
/// "exception.stacktrace" is represented using the value of <a href="https://learn.microsoft.com/dotnet/api/system.exception.tostring">Exception.ToString</a>.
66+
/// </remarks>
6467
[MethodImpl(MethodImplOptions.AggressiveInlining)]
6568
public static void RecordException(this Activity activity, Exception? ex)
6669
=> RecordException(activity, ex, default);
6770

6871
/// <summary>
69-
/// Adds an activity event containing information from the specified exception and additional tags.
72+
/// Adds an <see cref="ActivityEvent"/> containing information from the specified exception and additional tags.
7073
/// </summary>
7174
/// <param name="activity">Activity instance.</param>
7275
/// <param name="ex">Exception to be recorded.</param>
7376
/// <param name="tags">Additional tags to record on the event.</param>
77+
/// <remarks> The exception is recorded as per <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/exceptions.md">specification</a>.
78+
/// "exception.stacktrace" is represented using the value of <a href="https://learn.microsoft.com/dotnet/api/system.exception.tostring">Exception.ToString</a>.
79+
/// </remarks>
7480
[MethodImpl(MethodImplOptions.AggressiveInlining)]
7581
public static void RecordException(this Activity activity, Exception? ex, in TagList tags)
7682
{

0 commit comments

Comments
 (0)