chore: Logging tweaks (#4622)

Author: bitsandfoxes

src/Sentry/GlobalSessionManager.cs

@@ -118,7 +118,7 @@ private void DeletePersistedSession()
                 try
                 {
                     var contents = _options.FileSystem.ReadAllTextFromFile(filePath);
-                    _options.LogDebug("Deleting persisted session file with contents: {0}", contents);
+                    _options.LogDebug("Deleting persisted session file with contents: '{0}'", contents);
                 }
                 catch (Exception ex)
                 {

src/Sentry/Internal/BackgroundWorker.cs

@@ -177,7 +177,7 @@ private async Task DoWorkAsync()
                     }
                     finally
                     {
-                        _options.LogDebug("De-queueing event {0}", eventId);
+                        _options.LogDebug("De-queueing event '{0}'", eventId);
                         _queue.TryDequeue(out _);
                         Interlocked.Decrement(ref _currentItems);
                         OnFlushObjectReceived?.Invoke(envelope, EventArgs.Empty);

src/Sentry/Internal/DebugStackTrace.cs

@@ -82,7 +82,7 @@ internal void MergeDebugImagesInto(SentryEvent @event)
         // Frame indexes may be changed as well as _debugImageIndexByModule becoming invalid.
         if (_debugImagesMerged)
         {
-            _options.LogWarning("Cannot call MergeDebugImagesInto multiple times. Event: {0}", @event.EventId);
+            _options.LogWarning("Cannot call MergeDebugImagesInto multiple times. Event: '{0}'", @event.EventId);
             return;
         }
         _debugImagesMerged = true;

src/Sentry/Internal/DuplicateEventDetectionEventProcessor.cs

@@ -15,7 +15,7 @@ internal class DuplicateEventDetectionEventProcessor : ISentryEventProcessor
         {
             if (_capturedObjects.TryGetValue(@event, out _))
             {
-                _options.LogDebug("Same event instance detected and discarded. EventId: {0}", @event.EventId);
+                _options.LogDebug("Same event instance detected and discarded. EventId: '{0}'", @event.EventId);
                 return null;
             }
             _capturedObjects.Add(@event, null);
@@ -38,7 +38,7 @@ private bool IsDuplicate(Exception ex, SentryId eventId, bool debugLog)
             {
                 if (debugLog)
                 {
-                    _options.LogDebug("Duplicate Exception: 'SameExceptionInstance'. Event {0} will be discarded.", eventId);
+                    _options.LogDebug("Duplicate Exception: 'SameExceptionInstance'. Event '{0}' will be discarded.", eventId);
                 }
                 return true;
             }
@@ -52,7 +52,7 @@ private bool IsDuplicate(Exception ex, SentryId eventId, bool debugLog)
             var result = aex.InnerExceptions.Any(e => IsDuplicate(e, eventId, false));
             if (result)
             {
-                _options.LogDebug("Duplicate Exception: 'AggregateException'. Event {0} will be discarded.", eventId);
+                _options.LogDebug("Duplicate Exception: 'AggregateException'. Event '{0}' will be discarded.", eventId);
             }
 
             return result;
@@ -63,7 +63,7 @@ private bool IsDuplicate(Exception ex, SentryId eventId, bool debugLog)
         {
             if (IsDuplicate(ex.InnerException, eventId, false))
             {
-                _options.LogDebug("Duplicate Exception: 'SameExceptionInstance'. Event {0} will be discarded.", eventId);
+                _options.LogDebug("Duplicate Exception: 'SameExceptionInstance'. Event '{0}' will be discarded.", eventId);
                 return true;
             }
         }

src/Sentry/Internal/Http/CachingTransport.cs

@@ -343,15 +343,15 @@ private async Task InnerProcessCacheAsync(string file, CancellationToken cancell
 
                     try
                     {
-                        _options.LogDebug("Sending cached envelope: {0}",
+                        _options.LogDebug("Sending cached envelope: '{0}'",
                             envelope.TryGetEventId(_options.DiagnosticLogger));
 
                         await _innerTransport.SendEnvelopeAsync(envelope, cancellation).ConfigureAwait(false);
                     }
                     // OperationCancel should not log an error
                     catch (OperationCanceledException ex)
                     {
-                        _options.LogDebug("Canceled sending cached envelope: {0}, retrying after a delay.", ex, file);
+                        _options.LogDebug("Canceled sending cached envelope: '{0}', retrying after a delay.", ex, file);
                         // Let the worker catch, log, wait a bit and retry.
                         throw;
                     }

src/Sentry/Internal/Hub.cs

@@ -505,7 +505,7 @@ private void AddBreadcrumbForException(SentryEvent evt, Scope scope)
         }
         catch (Exception e)
         {
-            _options.LogError(e, "Failure to store breadcrumb for exception event: {0}", evt.EventId);
+            _options.LogError(e, "Failure to store breadcrumb for exception event: '{0}'", evt.EventId);
         }
     }
 

src/Sentry/Internal/MainSentryEventProcessor.cs

@@ -34,7 +34,7 @@ public MainSentryEventProcessor(
 
     public SentryEvent Process(SentryEvent @event)
     {
-        _options.LogDebug("Running main event processor on: Event {0}", @event.EventId);
+        _options.LogDebug("Running main event processor on: Event '{0}'", @event.EventId);
 
         if (TimeZoneInfo.Local is { } timeZoneInfo)
         {

src/Sentry/Internal/SentryEventHelper.cs

@@ -37,7 +37,7 @@ internal static class SentryEventHelper
             return @event;
         }
 
-        options.LogDebug("Calling the BeforeSend callback");
+        options.LogDebug("Calling the BeforeSend callback.");
         try
         {
             @event = options.BeforeSendInternal?.Invoke(@event, hint);

src/Sentry/SentryClient.cs

@@ -79,7 +79,7 @@ public SentryId CaptureEvent(SentryEvent? @event, Scope? scope = null, SentryHin
         }
         catch (Exception e)
         {
-            _options.LogError(e, "An error occurred when capturing the event {0}.", @event.EventId);
+            _options.LogError(e, "An error occurred when capturing the event '{0}'.", @event.EventId);
             return SentryId.Empty;
         }
     }
@@ -445,7 +445,7 @@ public bool CaptureEnvelope(Envelope envelope)
         }
 
         _options.LogWarning(
-            "The attempt to queue the event failed. Items in queue: {0}",
+            "The attempt to queue the event failed. Items in queue: '{0}'",
             Worker.QueuedItems);
 
         return false;

src/Sentry/SentryPropagationContext.cs

@@ -15,7 +15,7 @@ public DynamicSamplingContext GetOrCreateDynamicSamplingContext(SentryOptions op
     {
         if (_dynamicSamplingContext is null)
         {
-            options.LogDebug("Creating the Dynamic Sampling Context from the Propagation Context");
+            options.LogDebug("Creating the Dynamic Sampling Context from the Propagation Context.");
             _dynamicSamplingContext = this.CreateDynamicSamplingContext(options, replaySession);
         }