ref(logs): move Logger instances to Hubs

Author: Flash0ver

src/Sentry/Extensibility/DisabledHub.cs

@@ -1,3 +1,4 @@
+using Sentry.Infrastructure;
 using Sentry.Internal;
 using Sentry.Protocol.Envelopes;
 using Sentry.Protocol.Metrics;
@@ -21,6 +22,7 @@ public class DisabledHub : IHub, IDisposable
 
     private DisabledHub()
     {
+        Logger = new SentryStructuredLogger(this);
     }
 
     /// <summary>
@@ -228,4 +230,11 @@ public void CaptureUserFeedback(UserFeedback userFeedback)
     /// No-Op.
     /// </summary>
     public SentryId LastEventId => SentryId.Empty;
+
+    /// <summary>
+    /// Disabled Logger.
+    /// <para>This API is experimental and it may change in the future.</para>
+    /// </summary>
+    [Experimental(DiagnosticId.ExperimentalFeature)]
+    public SentryStructuredLogger Logger { get; }
 }

src/Sentry/Extensibility/HubAdapter.cs

@@ -32,6 +32,13 @@ private HubAdapter() { }
     /// </summary>
     public SentryId LastEventId { [DebuggerStepThrough] get => SentrySdk.LastEventId; }
 
+    /// <summary>
+    /// Forwards the call to <see cref="SentrySdk"/>.
+    /// <para>This API is experimental and it may change in the future.</para>
+    /// </summary>
+    [Experimental(DiagnosticId.ExperimentalFeature)]
+    public SentryStructuredLogger Logger { [DebuggerStepThrough] get => SentrySdk.Logger; }
+
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>

src/Sentry/IHub.cs

@@ -1,3 +1,5 @@
+using Sentry.Infrastructure;
+
 namespace Sentry;
 
 /// <summary>
@@ -17,6 +19,20 @@ public interface IHub : ISentryClient, ISentryScopeManager
     /// </summary>
     public SentryId LastEventId { get; }
 
+    /// <summary>
+    /// Creates and sends logs to Sentry.
+    /// <para>This API is experimental and it may change in the future.</para>
+    /// </summary>
+    /// <remarks>
+    /// Available options:
+    /// <list type="bullet">
+    /// <item><see cref="Sentry.SentryOptions.EnableLogs"/></item>
+    /// <item><see cref="Sentry.SentryOptions.SetBeforeSendLog(System.Func{Sentry.Protocol.SentryLog, Sentry.Protocol.SentryLog})"/></item>
+    /// </list>
+    /// </remarks>
+    [Experimental(DiagnosticId.ExperimentalFeature)]
+    public SentryStructuredLogger Logger { get; }
+
     /// <summary>
     /// Starts a transaction.
     /// </summary>

src/Sentry/Internal/Hub.cs

@@ -57,6 +57,7 @@ internal Hub(
         client ??= new SentryClient(options, randomValuesFactory: _randomValuesFactory, sessionManager: _sessionManager);
 
         ScopeManager = scopeManager ?? new SentryScopeManager(options, client);
+        Logger = new SentryStructuredLogger(this);
 
         if (!options.IsGlobalModeEnabled)
         {
@@ -755,4 +756,7 @@ public void Dispose()
     }
 
     public SentryId LastEventId => CurrentScope.LastEventId;
+
+    [Experimental(DiagnosticId.ExperimentalFeature)]
+    public SentryStructuredLogger Logger { get; }
 }

src/Sentry/Protocol/SentryLog.cs

@@ -77,6 +77,13 @@ public required SentryLogLevel Level
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public ImmutableArray<object> Parameters { get; init; }
 
+    /// <summary>
+    /// The span id of the span that was active when the log was collected.
+    /// <para>This API is experimental and it may change in the future.</para>
+    /// </summary>
+    [Experimental(DiagnosticId.ExperimentalFeature)]
+    public SpanId? ParentSpanId { get; init; }
+
     /// <summary>
     /// Gets the attribute value associated with the specified key when of type <see cref="string"/>.
     /// <para>This API is experimental and it may change in the future.</para>
@@ -201,7 +208,7 @@ public void SetAttribute(string key, double value)
         _attributes[key] = new SentryAttribute(value, "double");
     }
 
-    internal void SetAttributes(SentryOptions options, SpanId? parentSpanId)
+    internal void SetAttributes(SentryOptions options)
     {
         var environment = options.SettingLocator.GetEnvironment();
         SetAttribute("sentry.environment", environment);
@@ -212,9 +219,9 @@ internal void SetAttributes(SentryOptions options, SpanId? parentSpanId)
             SetAttribute("sentry.release", release);
         }
 
-        if (parentSpanId.HasValue)
+        if (ParentSpanId.HasValue)
         {
-            SetAttribute("sentry.trace.parent_span_id", parentSpanId.Value.ToString());
+            SetAttribute("sentry.trace.parent_span_id", ParentSpanId.Value.ToString());
         }
 
         SetAttribute("sentry.sdk.name", Constants.SdkName);

src/Sentry/SentrySdk.cs

@@ -280,19 +280,9 @@ public void Dispose()
     /// </summary>
     public static bool IsEnabled { [DebuggerStepThrough] get => CurrentHub.IsEnabled; }
 
-    /// <summary>
-    /// Creates and sends logs to Sentry.
-    /// <para>This API is experimental and it may change in the future.</para>
-    /// </summary>
-    /// <remarks>
-    /// Available options:
-    /// <list type="bullet">
-    /// <item><see cref="Sentry.SentryOptions.EnableLogs"/></item>
-    /// <item><see cref="Sentry.SentryOptions.SetBeforeSendLog(System.Func{Sentry.Protocol.SentryLog, Sentry.Protocol.SentryLog})"/></item>
-    /// </list>
-    /// </remarks>
+    /// <inheritdoc cref="IHub.Logger" />
     [Experimental(DiagnosticId.ExperimentalFeature)]
-    public static SentryStructuredLogger Logger { get; } = new SentryStructuredLogger();
+    public static SentryStructuredLogger Logger { [DebuggerStepThrough] get => CurrentHub.Logger; }
 
     /// <summary>
     /// Creates a new scope that will terminate when disposed.

src/Sentry/SentryStructuredLogger.cs

@@ -13,25 +13,42 @@ namespace Sentry;
 [Experimental(DiagnosticId.ExperimentalFeature)]
 public sealed class SentryStructuredLogger
 {
+    private readonly IHub _hub;
     private readonly ISystemClock _clock;
 
-    internal SentryStructuredLogger()
-        : this(SystemClock.Clock)
+    private readonly SentryOptions? _options;
+    private readonly IInternalScopeManager? _scopeManager;
+
+    internal SentryStructuredLogger(IHub hub)
+        : this(hub, SystemClock.Clock)
+    {
+    }
+
+    internal SentryStructuredLogger(IHub hub, ISystemClock clock)
+        : this(hub, (hub as Hub)?.ScopeManager, hub.GetSentryOptions(), clock)
     {
     }
 
-    internal SentryStructuredLogger(ISystemClock clock)
+    internal SentryStructuredLogger(IHub hub, IInternalScopeManager? scopeManager, SentryOptions? options, ISystemClock clock)
     {
+        _hub = hub;
         _clock = clock;
+
+        _options = options;
+        _scopeManager = scopeManager;
+        IsEnabled = options is { EnableLogs: true };
     }
 
+    [MemberNotNullWhen(true, nameof(_options))]
+    private bool IsEnabled { get; }
+
     /// <summary>
     /// 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())
+        if (IsEnabled)
         {
             CaptureLog(SentryLogLevel.Trace, template, parameters, configureLog);
         }
@@ -44,7 +61,7 @@ public void LogTrace(string template, object[]? parameters = null, Action<Sentry
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogDebug(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
-        if (IsEnabled())
+        if (IsEnabled)
         {
             CaptureLog(SentryLogLevel.Debug, template, parameters, configureLog);
         }
@@ -57,7 +74,7 @@ public void LogDebug(string template, object[]? parameters = null, Action<Sentry
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogInfo(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
-        if (IsEnabled())
+        if (IsEnabled)
         {
             CaptureLog(SentryLogLevel.Info, template, parameters, configureLog);
         }
@@ -70,7 +87,7 @@ public void LogInfo(string template, object[]? parameters = null, Action<SentryL
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogWarning(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
-        if (IsEnabled())
+        if (IsEnabled)
         {
             CaptureLog(SentryLogLevel.Warning, template, parameters, configureLog);
         }
@@ -83,7 +100,7 @@ public void LogWarning(string template, object[]? parameters = null, Action<Sent
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogError(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
-        if (IsEnabled())
+        if (IsEnabled)
         {
             CaptureLog(SentryLogLevel.Error, template, parameters, configureLog);
         }
@@ -96,57 +113,37 @@ public void LogError(string template, object[]? parameters = null, Action<Sentry
     [Experimental(DiagnosticId.ExperimentalFeature)]
     public void LogFatal(string template, object[]? parameters = null, Action<SentryLog>? configureLog = null)
     {
-        if (IsEnabled())
+        if (IsEnabled)
         {
             CaptureLog(SentryLogLevel.Fatal, template, parameters, configureLog);
         }
     }
 
-    private bool IsEnabled()
-    {
-        var hub = SentrySdk.CurrentHub;
-
-        if (hub.GetSentryOptions() is { } options)
-        {
-            return options.EnableLogs;
-        }
-
-        return false;
-    }
-
     private void CaptureLog(SentryLogLevel level, string template, object[]? parameters, Action<SentryLog>? configureLog)
     {
-        var timestamp = _clock.GetUtcNow();
-
-        var hub = SentrySdk.CurrentHub;
-
-        if (hub.GetSentryOptions() is not { EnableLogs: true } options)
-        {
-            return;
-        }
+        Debug.Assert(_options is not null);
 
-        var scopeManager = (hub as Hub)?.ScopeManager;
+        var timestamp = _clock.GetUtcNow();
 
-        if (!TryGetTraceId(hub, scopeManager, out var traceId))
+        if (!TryGetTraceId(_hub, _scopeManager, out var traceId))
         {
-            options.DiagnosticLogger?.LogWarning("TraceId not found");
+            _options.DiagnosticLogger?.LogWarning("TraceId not found");
         }
 
-        _ = TryGetParentSpanId(hub, scopeManager, out var parentSpanId);
+        _ = TryGetParentSpanId(_hub, _scopeManager, out var parentSpanId);
 
-        var message = string.Format(template, parameters ?? []);
+        var message = string.Format(CultureInfo.InvariantCulture, template, parameters ?? []);
         SentryLog log = new(timestamp, traceId, level, message)
         {
             Template = template,
             Parameters = ImmutableArray.Create(parameters),
+            ParentSpanId = parentSpanId,
         };
-        log.SetAttributes(options, parentSpanId);
+        log.SetAttributes(_options);
 
-        SentryLog? configuredLog;
         try
         {
             configureLog?.Invoke(log);
-            configuredLog = options.BeforeSendLogInternal?.Invoke(log);
         }
         catch (Exception e)
         {
@@ -156,11 +153,27 @@ private void CaptureLog(SentryLogLevel level, string template, object[]? paramet
             return;
         }
 
+        var configuredLog = log;
+        if (_options.BeforeSendLogInternal is { } beforeSendLog)
+        {
+            try
+            {
+                configuredLog = beforeSendLog.Invoke(log);
+            }
+            catch (Exception e)
+            {
+                //TODO: change to Diagnostic Logger (if enabled)
+                // see https://github.com/getsentry/sentry-dotnet/issues/4132
+                Console.WriteLine(e);
+                return;
+            }
+        }
+
         if (configuredLog is not null)
         {
             //TODO: enqueue in Batch-Processor / Background-Worker
             // see https://github.com/getsentry/sentry-dotnet/issues/4132
-            _ = hub.CaptureEnvelope(Envelope.FromLog(configuredLog));
+            _ = _hub.CaptureEnvelope(Envelope.FromLog(configuredLog));
         }
     }