ref(logs): rename LogSeverityLevel to SentryLogLevel

Flash0ver · Flash0ver · commit 2cb306fc6165 · 2025-05-12T17:19:46.000+02:00
diff --git a/samples/Sentry.Samples.Console.Basic/Program.cs b/samples/Sentry.Samples.Console.Basic/Program.cs
@@ -43,7 +43,7 @@
             return null;
         }
 
-        return log.Level is LogSeverityLevel.Error ? log : null;
+        return log.Level is SentryLogLevel.Error ? log : null;
     });
 });
 
diff --git a/src/Sentry/Protocol/SentryLog.cs b/src/Sentry/Protocol/SentryLog.cs
@@ -12,10 +12,10 @@ namespace Sentry.Protocol;
 public sealed class SentryLog : ISentryJsonSerializable
 {
     private readonly Dictionary<string, SentryAttribute> _attributes;
-    private readonly LogSeverityLevel _level;
+    private readonly SentryLogLevel _level;
 
     [SetsRequiredMembers]
-    internal SentryLog(DateTimeOffset timestamp, SentryId traceId, LogSeverityLevel level, string message)
+    internal SentryLog(DateTimeOffset timestamp, SentryId traceId, SentryLogLevel level, string message)
     {
         Timestamp = timestamp;
         TraceId = traceId;
@@ -46,12 +46,12 @@ internal SentryLog(DateTimeOffset timestamp, SentryId traceId, LogSeverityLevel
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     [Experimental(DiagnosticId.ExperimentalFeature)]
-    public required LogSeverityLevel Level
+    public required SentryLogLevel Level
     {
         get => _level;
         init
         {
-            LogSeverityLevelExtensions.ThrowIfOutOfRange(value);
+            SentryLogLevelExtensions.ThrowIfOutOfRange(value);
             _level = value;
         }
     }
diff --git a/src/Sentry/Protocol/SentryLogLevel.cs b/src/Sentry/Protocol/SentryLogLevel.cs
@@ -8,7 +8,7 @@ namespace Sentry.Protocol;
 /// </summary>
 /// <seealso href="https://develop.sentry.dev/sdk/telemetry/logs/"/>
 [Experimental(DiagnosticId.ExperimentalFeature)]
-public enum LogSeverityLevel
+public enum SentryLogLevel
 {
     /// <summary>
     /// A fine-grained debugging event.
@@ -37,9 +37,9 @@ public enum LogSeverityLevel
 }
 
 [Experimental(DiagnosticId.ExperimentalFeature)]
-internal static class LogSeverityLevelExtensions
+internal static class SentryLogLevelExtensions
 {
-    internal static (string, int?) ToSeverityTextAndOptionalSeverityNumber(this LogSeverityLevel level)
+    internal static (string, int?) ToSeverityTextAndOptionalSeverityNumber(this SentryLogLevel level)
     {
         return (int)level switch
         {
@@ -59,7 +59,7 @@ internal static (string, int?) ToSeverityTextAndOptionalSeverityNumber(this LogS
         };
     }
 
-    internal static void ThrowIfOutOfRange(LogSeverityLevel level, [CallerArgumentExpression(nameof(level))] string? paramName = null)
+    internal static void ThrowIfOutOfRange(SentryLogLevel level, [CallerArgumentExpression(nameof(level))] string? paramName = null)
     {
         if ((int)level is < 1 or > 24)
         {
@@ -68,13 +68,13 @@ internal static void ThrowIfOutOfRange(LogSeverityLevel level, [CallerArgumentEx
     }
 
     [DoesNotReturn]
-    private static void ThrowOutOfRange(LogSeverityLevel level, string? paramName)
+    private static void ThrowOutOfRange(SentryLogLevel level, string? paramName)
     {
         throw new ArgumentOutOfRangeException(paramName, level, "Severity must be between 1 (inclusive) and 24 (inclusive).");
     }
 
     [DoesNotReturn]
-    private static T ThrowOutOfRange<T>(LogSeverityLevel level, string? paramName)
+    private static T ThrowOutOfRange<T>(SentryLogLevel level, string? paramName)
     {
         throw new ArgumentOutOfRangeException(paramName, level, "Severity must be between 1 (inclusive) and 24 (inclusive).");
     }
diff --git a/src/Sentry/SentrySdkLogger.cs b/src/Sentry/SentrySdkLogger.cs
@@ -26,79 +26,79 @@ internal SentrySdkLogger(ISystemClock clock)
     }
 
     /// <summary>
-    /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Trace"/>, when enabled and sampled.
+    /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Trace"/>, when enabled and sampled.
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     public void LogTrace(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
         if (IsEnabled())
         {
-            CaptureLog(LogSeverityLevel.Trace, template, parameters, configureLog);
+            CaptureLog(SentryLogLevel.Trace, template, parameters, configureLog);
         }
     }
 
     /// <summary>
-    /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Debug"/>, when enabled and sampled.
+    /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Debug"/>, when enabled and sampled.
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogDebug(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
         if (IsEnabled())
         {
-            CaptureLog(LogSeverityLevel.Debug, template, parameters, configureLog);
+            CaptureLog(SentryLogLevel.Debug, template, parameters, configureLog);
         }
     }
 
     /// <summary>
-    /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Info"/>, when enabled and sampled.
+    /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Info"/>, when enabled and sampled.
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogInfo(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
         if (IsEnabled())
         {
-            CaptureLog(LogSeverityLevel.Info, template, parameters, configureLog);
+            CaptureLog(SentryLogLevel.Info, template, parameters, configureLog);
         }
     }
 
     /// <summary>
-    /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Warning"/>, when enabled and sampled.
+    /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Warning"/>, when enabled and sampled.
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogWarning(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
         if (IsEnabled())
         {
-            CaptureLog(LogSeverityLevel.Warning, template, parameters, configureLog);
+            CaptureLog(SentryLogLevel.Warning, template, parameters, configureLog);
         }
     }
 
     /// <summary>
-    /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Error"/>, when enabled and sampled.
+    /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Error"/>, when enabled and sampled.
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogError(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
         if (IsEnabled())
         {
-            CaptureLog(LogSeverityLevel.Error, template, parameters, configureLog);
+            CaptureLog(SentryLogLevel.Error, template, parameters, configureLog);
         }
     }
 
     /// <summary>
-    /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Fatal"/>, when enabled and sampled.
+    /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Fatal"/>, when enabled and sampled.
     /// <para>This API is experimental and it may change in the future.</para>
     /// </summary>
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogFatal(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
         if (IsEnabled())
         {
-            CaptureLog(LogSeverityLevel.Fatal, template, parameters, configureLog);
+            CaptureLog(SentryLogLevel.Fatal, template, parameters, configureLog);
         }
     }
 
@@ -114,7 +114,7 @@ private bool IsEnabled()
         return false;
     }
 
-    private void CaptureLog(LogSeverityLevel level, string template, object[]? parameters, Action<SentryLog>? configureLog)
+    private void CaptureLog(SentryLogLevel level, string template, object[]? parameters, Action<SentryLog>? configureLog)
     {
         var timestamp = _clock.GetUtcNow();
 

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`return null;`
`44`	`44`	`}`
`45`	`45`
`46`		`- return log.Level is LogSeverityLevel.Error ? log : null;`
	`46`	`+ return log.Level is SentryLogLevel.Error ? log : null;`
`47`	`47`	`});`
`48`	`48`	`});`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,10 @@ namespace Sentry.Protocol;`
`12`	`12`	`public sealed class SentryLog : ISentryJsonSerializable`
`13`	`13`	`{`
`14`	`14`	`private readonly Dictionary<string, SentryAttribute> _attributes;`
`15`		`- private readonly LogSeverityLevel _level;`
	`15`	`+ private readonly SentryLogLevel _level;`
`16`	`16`
`17`	`17`	`[SetsRequiredMembers]`
`18`		`- internal SentryLog(DateTimeOffset timestamp, SentryId traceId, LogSeverityLevel level, string message)`
	`18`	`+ internal SentryLog(DateTimeOffset timestamp, SentryId traceId, SentryLogLevel level, string message)`
`19`	`19`	`{`
`20`	`20`	`Timestamp = timestamp;`
`21`	`21`	`TraceId = traceId;`
`@@ -46,12 +46,12 @@ internal SentryLog(DateTimeOffset timestamp, SentryId traceId, LogSeverityLevel`
`46`	`46`	`/// <para>This API is experimental and it may change in the future.</para>`
`47`	`47`	`/// </summary>`
`48`	`48`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`49`		`- public required LogSeverityLevel Level`
	`49`	`+ public required SentryLogLevel Level`
`50`	`50`	`{`
`51`	`51`	`get => _level;`
`52`	`52`	`init`
`53`	`53`	`{`
`54`		`- LogSeverityLevelExtensions.ThrowIfOutOfRange(value);`
	`54`	`+ SentryLogLevelExtensions.ThrowIfOutOfRange(value);`
`55`	`55`	`_level = value;`
`56`	`56`	`}`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Sentry.Protocol;`
`8`	`8`	`/// </summary>`
`9`	`9`	`/// <seealso href="https://develop.sentry.dev/sdk/telemetry/logs/"/>`
`10`	`10`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`11`		`-public enum LogSeverityLevel`
	`11`	`+public enum SentryLogLevel`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`	`14`	`/// A fine-grained debugging event.`
`@@ -37,9 +37,9 @@ public enum LogSeverityLevel`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`40`		`-internal static class LogSeverityLevelExtensions`
	`40`	`+internal static class SentryLogLevelExtensions`
`41`	`41`	`{`
`42`		`- internal static (string, int?) ToSeverityTextAndOptionalSeverityNumber(this LogSeverityLevel level)`
	`42`	`+ internal static (string, int?) ToSeverityTextAndOptionalSeverityNumber(this SentryLogLevel level)`
`43`	`43`	`{`
`44`	`44`	`return (int)level switch`
`45`	`45`	`{`
`@@ -59,7 +59,7 @@ internal static (string, int?) ToSeverityTextAndOptionalSeverityNumber(this LogS`
`59`	`59`	`};`
`60`	`60`	`}`
`61`	`61`
`62`		`- internal static void ThrowIfOutOfRange(LogSeverityLevel level, [CallerArgumentExpression(nameof(level))] string? paramName = null)`
	`62`	`+ internal static void ThrowIfOutOfRange(SentryLogLevel level, [CallerArgumentExpression(nameof(level))] string? paramName = null)`
`63`	`63`	`{`
`64`	`64`	`if ((int)level is < 1 or > 24)`
`65`	`65`	`{`
`@@ -68,13 +68,13 @@ internal static void ThrowIfOutOfRange(LogSeverityLevel level, [CallerArgumentEx`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`[DoesNotReturn]`
`71`		`- private static void ThrowOutOfRange(LogSeverityLevel level, string? paramName)`
	`71`	`+ private static void ThrowOutOfRange(SentryLogLevel level, string? paramName)`
`72`	`72`	`{`
`73`	`73`	`throw new ArgumentOutOfRangeException(paramName, level, "Severity must be between 1 (inclusive) and 24 (inclusive).");`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`[DoesNotReturn]`
`77`		`- private static T ThrowOutOfRange<T>(LogSeverityLevel level, string? paramName)`
	`77`	`+ private static T ThrowOutOfRange<T>(SentryLogLevel level, string? paramName)`
`78`	`78`	`{`
`79`	`79`	`throw new ArgumentOutOfRangeException(paramName, level, "Severity must be between 1 (inclusive) and 24 (inclusive).");`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,79 +26,79 @@ internal SentrySdkLogger(ISystemClock clock)`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`/// <summary>`
`29`		`- /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Trace"/>, when enabled and sampled.`
	`29`	`+ /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Trace"/>, when enabled and sampled.`
`30`	`30`	`/// <para>This API is experimental and it may change in the future.</para>`
`31`	`31`	`/// </summary>`
`32`	`32`	`public void LogTrace(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)`
`33`	`33`	`{`
`34`	`34`	`if (IsEnabled())`
`35`	`35`	`{`
`36`		`- CaptureLog(LogSeverityLevel.Trace, template, parameters, configureLog);`
	`36`	`+ CaptureLog(SentryLogLevel.Trace, template, parameters, configureLog);`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`/// <summary>`
`41`		`- /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Debug"/>, when enabled and sampled.`
	`41`	`+ /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Debug"/>, when enabled and sampled.`
`42`	`42`	`/// <para>This API is experimental and it may change in the future.</para>`
`43`	`43`	`/// </summary>`
`44`	`44`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`45`	`45`	`public void LogDebug(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)`
`46`	`46`	`{`
`47`	`47`	`if (IsEnabled())`
`48`	`48`	`{`
`49`		`- CaptureLog(LogSeverityLevel.Debug, template, parameters, configureLog);`
	`49`	`+ CaptureLog(SentryLogLevel.Debug, template, parameters, configureLog);`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/// <summary>`
`54`		`- /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Info"/>, when enabled and sampled.`
	`54`	`+ /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Info"/>, when enabled and sampled.`
`55`	`55`	`/// <para>This API is experimental and it may change in the future.</para>`
`56`	`56`	`/// </summary>`
`57`	`57`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`58`	`58`	`public void LogInfo(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)`
`59`	`59`	`{`
`60`	`60`	`if (IsEnabled())`
`61`	`61`	`{`
`62`		`- CaptureLog(LogSeverityLevel.Info, template, parameters, configureLog);`
	`62`	`+ CaptureLog(SentryLogLevel.Info, template, parameters, configureLog);`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/// <summary>`
`67`		`- /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Warning"/>, when enabled and sampled.`
	`67`	`+ /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Warning"/>, when enabled and sampled.`
`68`	`68`	`/// <para>This API is experimental and it may change in the future.</para>`
`69`	`69`	`/// </summary>`
`70`	`70`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`71`	`71`	`public void LogWarning(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)`
`72`	`72`	`{`
`73`	`73`	`if (IsEnabled())`
`74`	`74`	`{`
`75`		`- CaptureLog(LogSeverityLevel.Warning, template, parameters, configureLog);`
	`75`	`+ CaptureLog(SentryLogLevel.Warning, template, parameters, configureLog);`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`/// <summary>`
`80`		`- /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Error"/>, when enabled and sampled.`
	`80`	`+ /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Error"/>, when enabled and sampled.`
`81`	`81`	`/// <para>This API is experimental and it may change in the future.</para>`
`82`	`82`	`/// </summary>`
`83`	`83`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`84`	`84`	`public void LogError(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)`
`85`	`85`	`{`
`86`	`86`	`if (IsEnabled())`
`87`	`87`	`{`
`88`		`- CaptureLog(LogSeverityLevel.Error, template, parameters, configureLog);`
	`88`	`+ CaptureLog(SentryLogLevel.Error, template, parameters, configureLog);`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`/// <summary>`
`93`		`- /// Creates and sends a structured log to Sentry, with severity <see cref="LogSeverityLevel.Fatal"/>, when enabled and sampled.`
	`93`	`+ /// Creates and sends a structured log to Sentry, with severity <see cref="SentryLogLevel.Fatal"/>, when enabled and sampled.`
`94`	`94`	`/// <para>This API is experimental and it may change in the future.</para>`
`95`	`95`	`/// </summary>`
`96`	`96`	`[Experimental(DiagnosticId.ExperimentalFeature)]`
`97`	`97`	`public void LogFatal(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)`
`98`	`98`	`{`
`99`	`99`	`if (IsEnabled())`
`100`	`100`	`{`
`101`		`- CaptureLog(LogSeverityLevel.Fatal, template, parameters, configureLog);`
	`101`	`+ CaptureLog(SentryLogLevel.Fatal, template, parameters, configureLog);`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`
`@@ -114,7 +114,7 @@ private bool IsEnabled()`
`114`	`114`	`return false;`
`115`	`115`	`}`
`116`	`116`
`117`		`- private void CaptureLog(LogSeverityLevel level, string template, object[]? parameters, Action<SentryLog>? configureLog)`
	`117`	`+ private void CaptureLog(SentryLogLevel level, string template, object[]? parameters, Action<SentryLog>? configureLog)`
`118`	`118`	`{`
`119`	`119`	`var timestamp = _clock.GetUtcNow();`
`120`	`120`