Renamed Sentry.Span to Sentry.SentrySpan (#3021)

getsentry · Jan 10, 2024 · ac356dc · ac356dc
1 parent fd1b704
commit ac356dc
Show file tree

Hide file tree

Showing 8 changed files with 118 additions and 117 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 
 - Class renamed `Sentry.User` to `Sentry.SentryUser` ([#3015](https://github.com/getsentry/sentry-dotnet/pull/3015))
 - Class renamed `Sentry.Runtime` to `Sentry.SentryRuntime` ([#3016](https://github.com/getsentry/sentry-dotnet/pull/3016))
+- Class renamed `Sentry.Span` to `Sentry.SentrySpan` ([#3021](https://github.com/getsentry/sentry-dotnet/pull/3021))
 
 ### Dependencies
 

diff --git a/src/Sentry/Span.cs → src/Sentry/SentrySpan.cs b/src/Sentry/Span.cs → src/Sentry/SentrySpan.cs
@@ -9,7 +9,7 @@ namespace Sentry;
 /// <summary>
 /// Transaction span.
 /// </summary>
-public class Span : ISpanData, IJsonSerializable
+public class SentrySpan : ISpanData, IJsonSerializable
 {
     /// <inheritdoc />
     public SpanId SpanId { get; private set; }
@@ -75,9 +75,9 @@ public void SetExtra(string key, object? value) =>
         (_extra ??= new Dictionary<string, object?>())[key] = value;
 
     /// <summary>
-    /// Initializes an instance of <see cref="Span"/>.
+    /// Initializes an instance of <see cref="SentrySpan"/>.
     /// </summary>
-    public Span(SpanId? parentSpanId, string operation)
+    public SentrySpan(SpanId? parentSpanId, string operation)
     {
         SpanId = SpanId.Create();
         ParentSpanId = parentSpanId;
@@ -86,9 +86,9 @@ public Span(SpanId? parentSpanId, string operation)
     }
 
     /// <summary>
-    /// Initializes an instance of <see cref="Span"/>.
+    /// Initializes an instance of <see cref="SentrySpan"/>.
     /// </summary>
-    public Span(ISpan tracer)
+    public SentrySpan(ISpan tracer)
         : this(tracer.ParentSpanId, tracer.Operation)
     {
         SpanId = tracer.SpanId;
@@ -141,7 +141,7 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
     /// <summary>
     /// Parses a span from JSON.
     /// </summary>
-    public static Span FromJson(JsonElement json)
+    public static SentrySpan FromJson(JsonElement json)
     {
         var spanId = json.GetPropertyOrNull("span_id")?.Pipe(SpanId.FromJson) ?? SpanId.Empty;
         var parentSpanId = json.GetPropertyOrNull("parent_span_id")?.Pipe(SpanId.FromJson);
@@ -156,7 +156,7 @@ public static Span FromJson(JsonElement json)
         var measurements = json.GetPropertyOrNull("measurements")?.GetDictionaryOrNull(Measurement.FromJson);
         var data = json.GetPropertyOrNull("data")?.GetDictionaryOrNull()?.ToDict();
 
-        return new Span(parentSpanId, operation)
+        return new SentrySpan(parentSpanId, operation)
         {
             SpanId = spanId,
             TraceId = traceId,

diff --git a/src/Sentry/Transaction.cs b/src/Sentry/Transaction.cs
@@ -184,12 +184,12 @@ public IReadOnlyList<string> Fingerprint
     public IReadOnlyDictionary<string, string> Tags => _tags;
 
     // Not readonly because of deserialization
-    private Span[] _spans = Array.Empty<Span>();
+    private SentrySpan[] _spans = Array.Empty<SentrySpan>();
 
     /// <summary>
     /// Flat list of spans within this transaction.
     /// </summary>
-    public IReadOnlyCollection<Span> Spans => _spans;
+    public IReadOnlyCollection<SentrySpan> Spans => _spans;
 
     /// <inheritdoc />
     public bool IsFinished => EndTimestamp is not null;
@@ -265,7 +265,7 @@ public Transaction(ITransactionTracer tracer)
         _tags = tracer.Tags.ToDict();
         _spans = tracer.Spans
             .Where(s => s is not SpanTracer { IsSentryRequest: true }) // Filter sentry requests created by Sentry.OpenTelemetry.SentrySpanProcessor
-            .Select(s => new Span(s)).ToArray();
+            .Select(s => new SentrySpan(s)).ToArray();
         _measurements = tracer.Measurements.ToDict();
 
         // Some items are not on the interface, but we only ever pass in a TransactionTracer anyway.
@@ -383,7 +383,7 @@ public static Transaction FromJson(JsonElement json)
         var measurements = json.GetPropertyOrNull("measurements")?
             .GetDictionaryOrNull(Measurement.FromJson) ?? new();
         var spans = json.GetPropertyOrNull("spans")?
-            .EnumerateArray().Select(Span.FromJson).ToArray() ?? Array.Empty<Span>();
+            .EnumerateArray().Select(SentrySpan.FromJson).ToArray() ?? Array.Empty<SentrySpan>();
 
         return new Transaction(name, nameSource)
         {

diff --git a/test/Sentry.Testing/VerifyExtensions.cs b/test/Sentry.Testing/VerifyExtensions.cs
@@ -41,9 +41,9 @@ public static SettingsTask IgnoreStandardSentryMembers(this SettingsTask setting
             .IgnoreStackTrace();
     }
 
-    private class SpansConverter : WriteOnlyJsonConverter<IReadOnlyCollection<Span>>
+    private class SpansConverter : WriteOnlyJsonConverter<IReadOnlyCollection<SentrySpan>>
     {
-        public override void Write(VerifyJsonWriter writer, IReadOnlyCollection<Span> spans)
+        public override void Write(VerifyJsonWriter writer, IReadOnlyCollection<SentrySpan> spans)
         {
             var ordered = spans
                 .OrderBy(x => x.StartTimestamp)

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt
@@ -771,6 +771,31 @@ namespace Sentry
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }
     }
+    public class SentrySpan : Sentry.IHasExtra, Sentry.IHasTags, Sentry.IJsonSerializable, Sentry.ISpanData, Sentry.Protocol.ITraceContext
+    {
+        public SentrySpan(Sentry.ISpan tracer) { }
+        public SentrySpan(Sentry.SpanId? parentSpanId, string operation) { }
+        public string? Description { get; set; }
+        public System.DateTimeOffset? EndTimestamp { get; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
+        public bool IsFinished { get; }
+        public bool? IsSampled { get; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, Sentry.Protocol.Measurement> Measurements { get; }
+        public string Operation { get; set; }
+        public Sentry.SpanId? ParentSpanId { get; }
+        public Sentry.SpanId SpanId { get; }
+        public System.DateTimeOffset StartTimestamp { get; }
+        public Sentry.SpanStatus? Status { get; set; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }
+        public Sentry.SentryId TraceId { get; }
+        public Sentry.SentryTraceHeader GetTraceHeader() { }
+        public void SetExtra(string key, object? value) { }
+        public void SetMeasurement(string name, Sentry.Protocol.Measurement measurement) { }
+        public void SetTag(string key, string value) { }
+        public void UnsetTag(string key) { }
+        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
+        public static Sentry.SentrySpan FromJson(System.Text.Json.JsonElement json) { }
+    }
     public sealed class SentryStackFrame : Sentry.IJsonSerializable
     {
         public SentryStackFrame() { }
@@ -879,31 +904,6 @@ namespace Sentry
         public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
         public static Sentry.SessionUpdate FromJson(System.Text.Json.JsonElement json) { }
     }
-    public class Span : Sentry.IHasExtra, Sentry.IHasTags, Sentry.IJsonSerializable, Sentry.ISpanData, Sentry.Protocol.ITraceContext
-    {
-        public Span(Sentry.ISpan tracer) { }
-        public Span(Sentry.SpanId? parentSpanId, string operation) { }
-        public string? Description { get; set; }
-        public System.DateTimeOffset? EndTimestamp { get; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
-        public bool IsFinished { get; }
-        public bool? IsSampled { get; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, Sentry.Protocol.Measurement> Measurements { get; }
-        public string Operation { get; set; }
-        public Sentry.SpanId? ParentSpanId { get; }
-        public Sentry.SpanId SpanId { get; }
-        public System.DateTimeOffset StartTimestamp { get; }
-        public Sentry.SpanStatus? Status { get; set; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }
-        public Sentry.SentryId TraceId { get; }
-        public Sentry.SentryTraceHeader GetTraceHeader() { }
-        public void SetExtra(string key, object? value) { }
-        public void SetMeasurement(string name, Sentry.Protocol.Measurement measurement) { }
-        public void SetTag(string key, string value) { }
-        public void UnsetTag(string key) { }
-        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
-        public static Sentry.Span FromJson(System.Text.Json.JsonElement json) { }
-    }
     public class SpanContext : Sentry.Protocol.ITraceContext
     {
         public SpanContext(string operation, Sentry.SpanId? spanId = default, Sentry.SpanId? parentSpanId = default, Sentry.SentryId? traceId = default, string? description = null, Sentry.SpanStatus? status = default, bool? isSampled = default) { }
@@ -1054,7 +1054,7 @@ namespace Sentry
         public double? SampleRate { get; }
         public Sentry.SdkVersion Sdk { get; }
         public Sentry.SpanId SpanId { get; }
-        public System.Collections.Generic.IReadOnlyCollection<Sentry.Span> Spans { get; }
+        public System.Collections.Generic.IReadOnlyCollection<Sentry.SentrySpan> Spans { get; }
         public System.DateTimeOffset StartTimestamp { get; }
         public Sentry.SpanStatus? Status { get; }
         public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt
@@ -771,6 +771,31 @@ namespace Sentry
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }
     }
+    public class SentrySpan : Sentry.IHasExtra, Sentry.IHasTags, Sentry.IJsonSerializable, Sentry.ISpanData, Sentry.Protocol.ITraceContext
+    {
+        public SentrySpan(Sentry.ISpan tracer) { }
+        public SentrySpan(Sentry.SpanId? parentSpanId, string operation) { }
+        public string? Description { get; set; }
+        public System.DateTimeOffset? EndTimestamp { get; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
+        public bool IsFinished { get; }
+        public bool? IsSampled { get; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, Sentry.Protocol.Measurement> Measurements { get; }
+        public string Operation { get; set; }
+        public Sentry.SpanId? ParentSpanId { get; }
+        public Sentry.SpanId SpanId { get; }
+        public System.DateTimeOffset StartTimestamp { get; }
+        public Sentry.SpanStatus? Status { get; set; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }
+        public Sentry.SentryId TraceId { get; }
+        public Sentry.SentryTraceHeader GetTraceHeader() { }
+        public void SetExtra(string key, object? value) { }
+        public void SetMeasurement(string name, Sentry.Protocol.Measurement measurement) { }
+        public void SetTag(string key, string value) { }
+        public void UnsetTag(string key) { }
+        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
+        public static Sentry.SentrySpan FromJson(System.Text.Json.JsonElement json) { }
+    }
     public sealed class SentryStackFrame : Sentry.IJsonSerializable
     {
         public SentryStackFrame() { }
@@ -879,31 +904,6 @@ namespace Sentry
         public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
         public static Sentry.SessionUpdate FromJson(System.Text.Json.JsonElement json) { }
     }
-    public class Span : Sentry.IHasExtra, Sentry.IHasTags, Sentry.IJsonSerializable, Sentry.ISpanData, Sentry.Protocol.ITraceContext
-    {
-        public Span(Sentry.ISpan tracer) { }
-        public Span(Sentry.SpanId? parentSpanId, string operation) { }
-        public string? Description { get; set; }
-        public System.DateTimeOffset? EndTimestamp { get; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
-        public bool IsFinished { get; }
-        public bool? IsSampled { get; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, Sentry.Protocol.Measurement> Measurements { get; }
-        public string Operation { get; set; }
-        public Sentry.SpanId? ParentSpanId { get; }
-        public Sentry.SpanId SpanId { get; }
-        public System.DateTimeOffset StartTimestamp { get; }
-        public Sentry.SpanStatus? Status { get; set; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }
-        public Sentry.SentryId TraceId { get; }
-        public Sentry.SentryTraceHeader GetTraceHeader() { }
-        public void SetExtra(string key, object? value) { }
-        public void SetMeasurement(string name, Sentry.Protocol.Measurement measurement) { }
-        public void SetTag(string key, string value) { }
-        public void UnsetTag(string key) { }
-        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
-        public static Sentry.Span FromJson(System.Text.Json.JsonElement json) { }
-    }
     public class SpanContext : Sentry.Protocol.ITraceContext
     {
         public SpanContext(string operation, Sentry.SpanId? spanId = default, Sentry.SpanId? parentSpanId = default, Sentry.SentryId? traceId = default, string? description = null, Sentry.SpanStatus? status = default, bool? isSampled = default) { }
@@ -1054,7 +1054,7 @@ namespace Sentry
         public double? SampleRate { get; }
         public Sentry.SdkVersion Sdk { get; }
         public Sentry.SpanId SpanId { get; }
-        public System.Collections.Generic.IReadOnlyCollection<Sentry.Span> Spans { get; }
+        public System.Collections.Generic.IReadOnlyCollection<Sentry.SentrySpan> Spans { get; }
         public System.DateTimeOffset StartTimestamp { get; }
         public Sentry.SpanStatus? Status { get; }
         public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt
@@ -772,6 +772,31 @@ namespace Sentry
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, Sentry.SentryTraceHeader traceHeader) { }
         public static Sentry.ITransactionTracer StartTransaction(string name, string operation, string? description) { }
     }
+    public class SentrySpan : Sentry.IHasExtra, Sentry.IHasTags, Sentry.IJsonSerializable, Sentry.ISpanData, Sentry.Protocol.ITraceContext
+    {
+        public SentrySpan(Sentry.ISpan tracer) { }
+        public SentrySpan(Sentry.SpanId? parentSpanId, string operation) { }
+        public string? Description { get; set; }
+        public System.DateTimeOffset? EndTimestamp { get; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
+        public bool IsFinished { get; }
+        public bool? IsSampled { get; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, Sentry.Protocol.Measurement> Measurements { get; }
+        public string Operation { get; set; }
+        public Sentry.SpanId? ParentSpanId { get; }
+        public Sentry.SpanId SpanId { get; }
+        public System.DateTimeOffset StartTimestamp { get; }
+        public Sentry.SpanStatus? Status { get; set; }
+        public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }
+        public Sentry.SentryId TraceId { get; }
+        public Sentry.SentryTraceHeader GetTraceHeader() { }
+        public void SetExtra(string key, object? value) { }
+        public void SetMeasurement(string name, Sentry.Protocol.Measurement measurement) { }
+        public void SetTag(string key, string value) { }
+        public void UnsetTag(string key) { }
+        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
+        public static Sentry.SentrySpan FromJson(System.Text.Json.JsonElement json) { }
+    }
     public sealed class SentryStackFrame : Sentry.IJsonSerializable
     {
         public SentryStackFrame() { }
@@ -880,31 +905,6 @@ namespace Sentry
         public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
         public static Sentry.SessionUpdate FromJson(System.Text.Json.JsonElement json) { }
     }
-    public class Span : Sentry.IHasExtra, Sentry.IHasTags, Sentry.IJsonSerializable, Sentry.ISpanData, Sentry.Protocol.ITraceContext
-    {
-        public Span(Sentry.ISpan tracer) { }
-        public Span(Sentry.SpanId? parentSpanId, string operation) { }
-        public string? Description { get; set; }
-        public System.DateTimeOffset? EndTimestamp { get; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
-        public bool IsFinished { get; }
-        public bool? IsSampled { get; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, Sentry.Protocol.Measurement> Measurements { get; }
-        public string Operation { get; set; }
-        public Sentry.SpanId? ParentSpanId { get; }
-        public Sentry.SpanId SpanId { get; }
-        public System.DateTimeOffset StartTimestamp { get; }
-        public Sentry.SpanStatus? Status { get; set; }
-        public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }
-        public Sentry.SentryId TraceId { get; }
-        public Sentry.SentryTraceHeader GetTraceHeader() { }
-        public void SetExtra(string key, object? value) { }
-        public void SetMeasurement(string name, Sentry.Protocol.Measurement measurement) { }
-        public void SetTag(string key, string value) { }
-        public void UnsetTag(string key) { }
-        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
-        public static Sentry.Span FromJson(System.Text.Json.JsonElement json) { }
-    }
     public class SpanContext : Sentry.Protocol.ITraceContext
     {
         public SpanContext(string operation, Sentry.SpanId? spanId = default, Sentry.SpanId? parentSpanId = default, Sentry.SentryId? traceId = default, string? description = null, Sentry.SpanStatus? status = default, bool? isSampled = default) { }
@@ -1055,7 +1055,7 @@ namespace Sentry
         public double? SampleRate { get; }
         public Sentry.SdkVersion Sdk { get; }
         public Sentry.SpanId SpanId { get; }
-        public System.Collections.Generic.IReadOnlyCollection<Sentry.Span> Spans { get; }
+        public System.Collections.Generic.IReadOnlyCollection<Sentry.SentrySpan> Spans { get; }
         public System.DateTimeOffset StartTimestamp { get; }
         public Sentry.SpanStatus? Status { get; }
         public System.Collections.Generic.IReadOnlyDictionary<string, string> Tags { get; }