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

Jump to bottom

Doc fix for RecordException #5143

Merged
merged 6 commits into from
Dec 8, 2023
Merged

Doc fix for RecordException #5143

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
17cba6b
Doc fix for RecordException
cijothomas Dec 7, 2023
114f6ff
href
cijothomas Dec 7, 2023
4d7fd66
method
cijothomas Dec 7, 2023
5443c81
t
cijothomas Dec 7, 2023
6db0fc2
fix link rendering
cijothomas Dec 8, 2023
1074390
Merge branch 'main' into cijothomas/activity-exception-doc-fix
cijothomas Dec 8, 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
10 changes: 8 additions & 2 deletions src/OpenTelemetry.Api/Trace/ActivityExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,26 @@ public static Status GetStatus(this Activity activity)
}

/// <summary>
/// Adds an activity event containing information from the specified exception.
/// Adds an <see cref="ActivityEvent"/> containing information from the specified exception.
/// </summary>
/// <param name="activity">Activity instance.</param>
/// <param name="ex">Exception to be recorded.</param>
/// <remarks> The exception is recorded as per https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/exceptions.md.
cijothomas marked this conversation as resolved.
Show resolved Hide resolved
/// "exception.stacktrace" is represented using the value of https://learn.microsoft.com/dotnet/api/system.exception.tostring.
cijothomas marked this conversation as resolved.
Show resolved Hide resolved
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void RecordException(this Activity activity, Exception? ex)
=> RecordException(activity, ex, default);

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