Rename LogEntry to SentryMessage (#540)

Author: Tyrrrz

CHANGELOG.md

@@ -1,3 +1,7 @@
+# vNext
+
+* Rename `LogEntry` to `SentryMessage`. Change type of `SentryEvent.Message` from `string` to `SentryMessage`.
+
 # 3.0.0-alpha.0
 
 ## What’s Changed

samples/Sentry.Samples.Console.Customized/Program.cs

@@ -161,7 +161,7 @@ await SentrySdk.ConfigureScopeAsync(async scope =>
                 const string msg = "{0} of {1} items we'll wait to flush to Sentry!";
                 SentrySdk.CaptureEvent(new SentryEvent
                 {
-                    LogEntry = new LogEntry
+                    Message = new SentryMessage
                     {
                         Message = msg,
                         Formatted = string.Format(msg, i, count)
@@ -178,7 +178,7 @@ await SentrySdk.ConfigureScopeAsync(async scope =>
             // would get disposed by the container on app shutdown
 
             var evt = new SentryEvent();
-            evt.Message ="Starting new client";
+            evt.Message = "Starting new client";
             evt.AddBreadcrumb("Breadcrumb directly to the event");
             evt.User.Username = "some@user";
             // Group all events with the following fingerprint:

src/Sentry.Extensions.Logging/SentryLogger.cs

@@ -70,8 +70,7 @@ public void Log<TState>(
                         if (property.Key == "{OriginalFormat}" && property.Value is string template)
                         {
                             // Original format found, use Sentry logEntry interface
-                            @event.Message = null;
-                            @event.LogEntry = new LogEntry
+                            @event.Message = new SentryMessage
                             {
                                 Formatted = message,
                                 Message = template

src/Sentry.NLog/SentryTarget.cs

@@ -326,8 +326,7 @@ protected override void Write(LogEventInfo logEvent)
 
                 var evt = new SentryEvent(exception)
                 {
-                    Message = null,
-                    LogEntry = new LogEntry
+                    Message = new SentryMessage
                     {
                         Formatted = formatted,
                         Message = template

src/Sentry.Serilog/SentrySink.cs

@@ -87,8 +87,7 @@ public void Emit(LogEvent logEvent)
                 var evt = new SentryEvent(exception)
                 {
                     Logger = context,
-                    Message = null,
-                    LogEntry = new LogEntry
+                    Message = new SentryMessage
                     {
                         Formatted = formatted,
                         Message = template

src/Sentry/Protocol/SentryEvent.cs

@@ -50,12 +50,6 @@ public class SentryEvent : BaseScope
         [DataMember(Name = "timestamp", EmitDefaultValue = false)]
         public DateTimeOffset Timestamp { get; }
 
-        /// <summary>
-        /// Gets the message that describes this event.
-        /// </summary>
-        [DataMember(Name = "message", EmitDefaultValue = false)]
-        public string? Message { get; set; }
-
         /// <summary>
         /// Gets the structured message that describes this event.
         /// </summary>
@@ -64,11 +58,11 @@ public class SentryEvent : BaseScope
         /// on the template message instead of the result string message.
         /// </remarks>
         /// <example>
-        /// LogEntry will have a template like: 'user {0} logged in'
+        /// SentryMessage will have a template like: 'user {0} logged in'
         /// Or structured logging template: '{user} has logged in'
         /// </example>
         [DataMember(Name = "logentry", EmitDefaultValue = false)]
-        public LogEntry? LogEntry { get; set; }
+        public SentryMessage? Message { get; set; }
 
         /// <summary>
         /// Name of the logger (or source) of the event.

src/Sentry/Protocol/LogEntry.cs renamed to src/Sentry/Protocol/SentryMessage.cs

@@ -17,7 +17,7 @@ namespace Sentry.Protocol
     /// </example>
     /// <seealso href="https://docs.sentry.io/clientdev/interfaces/message/"/>
     [DataContract]
-    public class LogEntry
+    public class SentryMessage
     {
         /// <summary>
         /// The raw message string (un-interpolated).
@@ -39,5 +39,10 @@ public class LogEntry
         /// </summary>
         [DataMember(Name = "formatted", EmitDefaultValue = false)]
         public string? Formatted { get; set; }
+
+        /// <summary>
+        /// Coerces <see cref="System.String"/> into <see cref="SentryMessage"/>.
+        /// </summary>
+        public static implicit operator SentryMessage(string? message) => new SentryMessage {Message = message};
     }
 }

src/Sentry/SentryClientExtensions.cs

@@ -35,14 +35,15 @@ public static SentryId CaptureMessage(
             string message,
             SentryLevel level = SentryLevel.Info)
         {
-            return !client.IsEnabled
-                   || string.IsNullOrWhiteSpace(message)
+            return !client.IsEnabled || string.IsNullOrWhiteSpace(message)
                 ? new SentryId()
-                : client.CaptureEvent(new SentryEvent
-                {
-                    Message = message,
-                    Level = level
-                });
+                : client.CaptureEvent(
+                    new SentryEvent
+                    {
+                        Message = message,
+                        Level = level
+                    }
+                );
         }
     }
 }

test/Sentry.AspNetCore.Tests/IntegrationMockedBackgroundWorker.cs

@@ -75,7 +75,7 @@ public void LogError_ByDefault_EventCaptured()
             var logger = ServiceProvider.GetRequiredService<ILogger<IntegrationMockedBackgroundWorker>>();
             logger.LogError(expectedMessage);
 
-            _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p => p.LogEntry.Formatted == expectedMessage));
+            _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p => p.Message.Formatted == expectedMessage));
         }
 
         [Fact]
@@ -89,8 +89,8 @@ public void LogError_WithFormat_EventCaptured()
             logger.LogError(expectedMessage, param);
 
             _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p =>
-                    p.LogEntry.Formatted == $"Test {param} log"
-                    && p.LogEntry.Message == expectedMessage));
+                    p.Message.Formatted == $"Test {param} log"
+                    && p.Message.Message == expectedMessage));
         }
 
         [Fact]
@@ -119,7 +119,7 @@ public void SentryClient_CaptureMessage_EventCaptured()
             var client = ServiceProvider.GetRequiredService<ISentryClient>();
             _ = client.CaptureMessage(expectedMessage);
 
-            _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p => p.Message == expectedMessage));
+            _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p => p.Message.Message == expectedMessage));
         }
 
         [Fact]
@@ -131,7 +131,7 @@ public void Hub_CaptureMessage_EventCaptured()
             var client = ServiceProvider.GetRequiredService<IHub>();
             _ = client.CaptureMessage(expectedMessage);
 
-            _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p => p.Message == expectedMessage));
+            _ = Worker.Received(1).EnqueueEvent(Arg.Is<SentryEvent>(p => p.Message.Message == expectedMessage));
         }
 
         [Fact]

test/Sentry.Log4Net.Tests/SentryAppenderTests.cs

@@ -123,7 +123,7 @@ public void Append_RenderedMessage_Set()
             sut.DoAppend(evt);
 
             _ = _fixture.Hub.Received(1)
-                    .CaptureEvent(Arg.Is<SentryEvent>(e => e.Message == expected));
+                    .CaptureEvent(Arg.Is<SentryEvent>(e => e.Message.Message == expected));
         }
 
         [Fact]