-
Notifications
You must be signed in to change notification settings - Fork 759
/
ActivityExtensions.cs
127 lines (117 loc) · 5.58 KB
/
ActivityExtensions.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
using System.Diagnostics;
using System.Runtime.CompilerServices;
using OpenTelemetry.Internal;
// The Activity class is in the System.Diagnostics namespace.
// These extension methods on Activity are intentionally not placed in the
// same namespace as Activity to prevent name collisions in the future.
// The OpenTelemetry.Trace namespace is used because Activity is analogous
// to Span in OpenTelemetry.
namespace OpenTelemetry.Trace;
/// <summary>
/// Extension methods on Activity.
/// </summary>
public static class ActivityExtensions
{
/// <summary>
/// Sets the status of activity execution.
/// </summary>
/// <remarks>
/// Note: This method is obsolete. Call the <see cref="Activity.SetStatus"/>
/// method instead. For more details see: <see
/// href="https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Api#setting-status"
/// />.
/// </remarks>
/// <param name="activity">Activity instance.</param>
/// <param name="status">Activity execution status.</param>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[Obsolete("Call Activity.SetStatus instead this method will be removed in a future version.")]
public static void SetStatus(this Activity? activity, Status status)
{
if (activity != null)
{
switch (status.StatusCode)
{
case StatusCode.Ok:
activity.SetStatus(ActivityStatusCode.Ok);
break;
case StatusCode.Unset:
activity.SetStatus(ActivityStatusCode.Unset);
break;
case StatusCode.Error:
activity.SetStatus(ActivityStatusCode.Error, status.Description);
break;
}
activity.SetTag(SpanAttributeConstants.StatusCodeKey, StatusHelper.GetTagValueForStatusCode(status.StatusCode));
activity.SetTag(SpanAttributeConstants.StatusDescriptionKey, status.Description);
}
}
/// <summary>
/// Gets the status of activity execution.
/// </summary>
/// <remarks>
/// Note: This method is obsolete. Use the <see cref="Activity.Status"/> and
/// <see cref="Activity.StatusDescription"/> properties instead. For more
/// details see: <see
/// href="https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/src/OpenTelemetry.Api#setting-status"
/// />.
/// </remarks>
/// <param name="activity">Activity instance.</param>
/// <returns>Activity execution status.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[Obsolete("Use Activity.Status and Activity.StatusDescription instead this method will be removed in a future version.")]
public static Status GetStatus(this Activity? activity)
{
if (activity != null)
{
switch (activity.Status)
{
case ActivityStatusCode.Ok:
return Status.Ok;
case ActivityStatusCode.Error:
return new Status(StatusCode.Error, activity.StatusDescription);
}
if (activity.TryGetStatus(out var statusCode, out var statusDescription))
{
return new Status(statusCode, statusDescription);
}
}
return Status.Unset;
}
/// <summary>
/// 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>
/// <para>Note: This method is obsolete. Please use <see cref="Activity.AddException"/> instead.</para>
/// The exception is recorded as per <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/exceptions.md">specification</a>.
/// "exception.stacktrace" is represented using the value of <a href="https://learn.microsoft.com/dotnet/api/system.exception.tostring">Exception.ToString</a>.
/// </remarks>
[Obsolete("Call Activity.AddException instead this method will be removed in a future version.")]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void RecordException(this Activity? activity, Exception? ex)
=> RecordException(activity, ex, default);
/// <summary>
/// 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>
/// <para>Note: This method is obsolete. Please use <see cref="Activity.AddException"/> instead.</para>
/// The exception is recorded as per <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/exceptions.md">specification</a>.
/// "exception.stacktrace" is represented using the value of <a href="https://learn.microsoft.com/dotnet/api/system.exception.tostring">Exception.ToString</a>.
/// </remarks>
[Obsolete("Call Activity.AddException instead this method will be removed in a future version.")]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void RecordException(this Activity? activity, Exception? ex, in TagList tags)
{
if (ex == null || activity == null)
{
return;
}
activity.AddException(ex, in tags);
}
}