From 17cba6b1baac67785705758bff9e6c5716733b0b Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Thu, 7 Dec 2023 11:27:15 -0800 Subject: [PATCH 1/5] Doc fix for RecordException --- src/OpenTelemetry.Api/Trace/ActivityExtensions.cs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs index 036d8c11a7c..bb8d9e5c75c 100644 --- a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs +++ b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs @@ -57,20 +57,26 @@ public static Status GetStatus(this Activity activity) } /// - /// Adds an activity event containing information from the specified exception. + /// Adds an containing information from the specified exception. /// /// Activity instance. /// Exception to be recorded. + /// 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. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void RecordException(this Activity activity, Exception? ex) => RecordException(activity, ex, default); /// - /// Adds an activity event containing information from the specified exception and additional tags. + /// Adds an containing information from the specified exception and additional tags. /// /// Activity instance. /// Exception to be recorded. /// Additional tags to record on the event. + /// 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. + /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void RecordException(this Activity activity, Exception? ex, in TagList tags) { From 114f6ffbf43823fce05c99a75cbec98c6ab6c2e5 Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Thu, 7 Dec 2023 15:22:13 -0800 Subject: [PATCH 2/5] href --- src/OpenTelemetry.Api/Trace/ActivityExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs index bb8d9e5c75c..c0e8e2b12d1 100644 --- a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs +++ b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs @@ -74,8 +74,8 @@ public static void RecordException(this Activity activity, Exception? ex) /// Activity instance. /// Exception to be recorded. /// Additional tags to record on the event. - /// 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. + /// The exception is recorded as per . + /// "exception.stacktrace" is represented using the value of . /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void RecordException(this Activity activity, Exception? ex, in TagList tags) From 4d7fd66225c627c1abac4b1c6e2b0e305d54a1d8 Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Thu, 7 Dec 2023 15:23:15 -0800 Subject: [PATCH 3/5] method --- src/OpenTelemetry.Api/Trace/ActivityExtensions.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs index c0e8e2b12d1..f30294696b4 100644 --- a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs +++ b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs @@ -75,7 +75,7 @@ public static void RecordException(this Activity activity, Exception? ex) /// Exception to be recorded. /// Additional tags to record on the event. /// The exception is recorded as per . - /// "exception.stacktrace" is represented using the value of . + /// "exception.stacktrace" is represented using the value of Exception.ToString. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void RecordException(this Activity activity, Exception? ex, in TagList tags) From 5443c8180847c864ac868a65f46599d8640b4d1f Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Thu, 7 Dec 2023 15:23:52 -0800 Subject: [PATCH 4/5] t --- src/OpenTelemetry.Api/Trace/ActivityExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs index f30294696b4..a349784d607 100644 --- a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs +++ b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs @@ -61,8 +61,8 @@ public static Status GetStatus(this Activity activity) /// /// Activity instance. /// Exception to be recorded. - /// 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. + /// The exception is recorded as per . + /// "exception.stacktrace" is represented using the value of Exception.ToString. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] public static void RecordException(this Activity activity, Exception? ex) From 6db0fc27bdc37eb4e6a116096e07e81072f85cdd Mon Sep 17 00:00:00 2001 From: Cijo Thomas Date: Thu, 7 Dec 2023 17:19:31 -0800 Subject: [PATCH 5/5] fix link rendering --- src/OpenTelemetry.Api/Trace/ActivityExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs index a349784d607..d8ac769b9c9 100644 --- a/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs +++ b/src/OpenTelemetry.Api/Trace/ActivityExtensions.cs @@ -61,7 +61,7 @@ public static Status GetStatus(this Activity activity) /// /// Activity instance. /// Exception to be recorded. - /// The exception is recorded as per . + /// The exception is recorded as per specification. /// "exception.stacktrace" is represented using the value of Exception.ToString. /// [MethodImpl(MethodImplOptions.AggressiveInlining)] @@ -74,7 +74,7 @@ public static void RecordException(this Activity activity, Exception? ex) /// Activity instance. /// Exception to be recorded. /// Additional tags to record on the event. - /// The exception is recorded as per . + /// The exception is recorded as per specification. /// "exception.stacktrace" is represented using the value of Exception.ToString. /// [MethodImpl(MethodImplOptions.AggressiveInlining)]