WIP: Sentry Logs

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

@@ -9,6 +9,7 @@
  */
 
 using System.Net.Http;
+using Sentry.Experimental;
 using static System.Console;
 
 // Initialize the Sentry SDK.  (It is not necessary to dispose it.)
@@ -35,6 +36,18 @@
     options.TracesSampleRate = 1.0;
 });
 
+#pragma warning disable SENTRY0002
+SentrySdk.Logger.Trace("Hello, World!", null, log => log.SetAttribute("trace", "trace"));
+SentrySdk.Logger.Debug("Hello, .NET!", null, log => log.SetAttribute("trace", "trace"));
+SentrySdk.Logger.Info("Information", null, log => log.SetAttribute("trace", "trace"));
+SentrySdk.Logger.Warn("Warning with one {0}", ["parameter"], log => log.SetAttribute("trace", "trace"));
+SentrySdk.Logger.Error("Error with {0} {1}", [2, "parameters"], log => log.SetAttribute("trace", "trace"));
+SentrySdk.Logger.Fatal("Fatal {0} and {1}", [true, false], log => log.SetAttribute("trace", "trace"));
+#pragma warning restore SENTRY0002
+
+await Task.Delay(5_000);
+
+/*
 // This starts a new transaction and attaches it to the scope.
 var transaction = SentrySdk.StartTransaction("Program Main", "function");
 SentrySdk.ConfigureScope(scope => scope.Transaction = transaction);
@@ -96,3 +109,4 @@ async Task ThirdFunction()
         span.Finish();
     }
 }
+*/

src/Sentry/Experimental/SentryLog.cs

@@ -0,0 +1,155 @@
+using Sentry.Extensibility;
+using Sentry.Infrastructure;
+using Sentry.Internal.Extensions;
+
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace Sentry.Experimental;
+
+[Experimental(DiagnosticId.ExperimentalSentryLogs)]
+public sealed class SentryLog : ISentryJsonSerializable
+{
+    private Dictionary<string, ValueTypePair>? _attributes;
+    private int _severityNumber = -1;
+
+    [SetsRequiredMembers]
+    internal SentryLog(SentrySeverity level, string message, object[]? parameters = null)
+    {
+        Timestamp = DateTimeOffset.UtcNow;
+        TraceId = SentryId.Empty;
+        Level = level;
+        Message = message;
+        Parameters = parameters;
+    }
+
+    public required DateTimeOffset Timestamp { get; init; }
+
+    public required SentryId TraceId { get; init; }
+
+    public SentrySeverity Level
+    {
+        get => SentrySeverityExtensions.FromSeverityNumber(_severityNumber);
+        set => _severityNumber = SentrySeverityExtensions.ToSeverityNumber(value);
+    }
+
+    public required string Message { get; init; }
+
+    //public Dictionary<string, object>? Attributes { get { return _attributes; } }
+
+    public string? Template { get; init; }
+
+    public object[]? Parameters { get; init; }
+
+    public required int SeverityNumber
+    {
+        get => _severityNumber;
+        set
+        {
+            //
+            SentrySeverityExtensions.ThrowIfOutOfRange(value);
+            _severityNumber = value;
+        }
+    }
+
+    public void SetAttribute(string key, string value)
+    {
+        _attributes ??= new Dictionary<string, ValueTypePair>();
+        _attributes[key] = new ValueTypePair(value, "string");
+    }
+
+    public void SetAttribute(string key, bool value)
+    {
+        _attributes ??= new Dictionary<string, ValueTypePair>();
+        _attributes[key] = new ValueTypePair(value, "boolean");
+    }
+
+    public void SetAttribute(string key, int value)
+    {
+        _attributes ??= new Dictionary<string, ValueTypePair>();
+        _attributes[key] = new ValueTypePair(value, "integer");
+    }
+
+    public void SetAttribute(string key, double value)
+    {
+        _attributes ??= new Dictionary<string, ValueTypePair>();
+        _attributes[key] = new ValueTypePair(value, "double");
+    }
+
+    public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
+    {
+        _attributes = new Dictionary<string, ValueTypePair>
+        {
+            { "sentry.environment", new ValueTypePair("production", "string")},
+            { "sentry.release", new ValueTypePair("1.0.0", "string")},
+            { "sentry.trace.parent_span_id", new ValueTypePair("b0e6f15b45c36b12", "string")},
+        };
+
+        writer.WriteStartObject();
+        writer.WriteStartArray("items");
+        writer.WriteStartObject();
+
+        writer.WriteNumber("timestamp", Timestamp.ToUnixTimeSeconds());
+        writer.WriteString("trace_id", TraceId);
+        writer.WriteString("level", Level.ToLogString());
+        writer.WriteString("body", Message);
+
+        writer.WritePropertyName("attributes");
+        writer.WriteStartObject();
+
+        if (Template is not null)
+        {
+            writer.WriteSerializable("sentry.message.template", new ValueTypePair(Template, "string"), null);
+        }
+
+        if (Parameters is not null)
+        {
+            for (var index = 0; index < Parameters.Length; index++)
+            {
+                var type = "string";
+                writer.WriteSerializable($"sentry.message.parameters.{index}", new ValueTypePair(Parameters[index], type), null);
+            }
+        }
+
+        if (_attributes is not null)
+        {
+            foreach (var attribute in _attributes)
+            {
+                writer.WriteSerializable(attribute.Key, attribute.Value, null);
+            }
+        }
+
+        writer.WriteEndObject();
+
+        if (SeverityNumber != -1)
+        {
+            writer.WriteNumber("severity_number", SeverityNumber);
+        }
+
+        writer.WriteEndObject();
+        writer.WriteEndArray();
+        writer.WriteEndObject();
+    }
+}
+
+//TODO: remove? perhaps a simple System.ValueTuple`2 suffices
+internal readonly struct ValueTypePair : ISentryJsonSerializable
+{
+    public ValueTypePair(object value, string type)
+    {
+        Value = value.ToString()!;
+        Type = type;
+    }
+
+    public string Value { get; }
+    public string Type { get; }
+
+    public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
+    {
+        writer.WriteStartObject();
+
+        writer.WriteString("value", Value);
+        writer.WriteString("type", Type);
+
+        writer.WriteEndObject();
+    }
+}

src/Sentry/Experimental/SentrySeverity.cs

@@ -0,0 +1,74 @@
+using Sentry.Infrastructure;
+
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
+namespace Sentry.Experimental;
+
+//TODO: QUESTION: not sure about the name
+// this is a bit different to Sentry.SentryLevel and Sentry.BreadcrumbLevel
+[Experimental(DiagnosticId.ExperimentalSentryLogs)]
+public enum SentrySeverity : short
+{
+    Trace,
+    Debug,
+    Info,
+    Warn,
+    Error,
+    Fatal,
+}
+
+[Experimental(DiagnosticId.ExperimentalSentryLogs)]
+internal static class SentrySeverityExtensions
+{
+    internal static string ToLogString(this SentrySeverity severity)
+    {
+        return severity switch
+        {
+            SentrySeverity.Trace => "trace",
+            SentrySeverity.Debug => "debug",
+            SentrySeverity.Info => "info",
+            SentrySeverity.Warn => "warn",
+            SentrySeverity.Error => "error",
+            SentrySeverity.Fatal => "fatal",
+            _ => throw new ArgumentOutOfRangeException(nameof(severity), severity, null),
+        };
+    }
+
+    internal static SentrySeverity FromSeverityNumber(int severityNumber)
+    {
+        ThrowIfOutOfRange(severityNumber);
+
+        return severityNumber switch
+        {
+            >= 1 and <= 4 => SentrySeverity.Trace,
+            >= 5 and <= 8 => SentrySeverity.Debug,
+            >= 9 and <= 12 => SentrySeverity.Info,
+            >= 13 and <= 16 => SentrySeverity.Warn,
+            >= 17 and <= 20 => SentrySeverity.Error,
+            >= 21 and <= 24 => SentrySeverity.Fatal,
+            _ => throw new UnreachableException(),
+        };
+    }
+
+    internal static int ToSeverityNumber(SentrySeverity severity)
+    {
+        return severity switch
+        {
+            SentrySeverity.Trace => 1,
+            SentrySeverity.Debug => 5,
+            SentrySeverity.Info => 9,
+            SentrySeverity.Warn => 13,
+            SentrySeverity.Error => 17,
+            SentrySeverity.Fatal => 21,
+            _ => throw new ArgumentOutOfRangeException(nameof(severity), severity, null)
+        };
+    }
+
+    internal static void ThrowIfOutOfRange(int severityNumber)
+    {
+        if (severityNumber is < 1 or > 24)
+        {
+            throw new ArgumentOutOfRangeException(nameof(severityNumber), severityNumber, "SeverityNumber must be between 1 (inclusive) and 24 (inclusive).");
+        }
+    }
+}

src/Sentry/Experimental/System.Diagnostics.CodeAnalysis.ExperimentalAttribute.cs

@@ -0,0 +1,29 @@
+#if !NET8_0_OR_GREATER
+// ReSharper disable CheckNamespace
+// ReSharper disable ConvertToPrimaryConstructor
+namespace System.Diagnostics.CodeAnalysis;
+
+[AttributeUsage(AttributeTargets.Assembly |
+                AttributeTargets.Module |
+                AttributeTargets.Class |
+                AttributeTargets.Struct |
+                AttributeTargets.Enum |
+                AttributeTargets.Constructor |
+                AttributeTargets.Method |
+                AttributeTargets.Property |
+                AttributeTargets.Field |
+                AttributeTargets.Event |
+                AttributeTargets.Interface |
+                AttributeTargets.Delegate, Inherited = false)]
+internal sealed class ExperimentalAttribute : Attribute
+{
+    public ExperimentalAttribute(string diagnosticId)
+    {
+        DiagnosticId = diagnosticId;
+    }
+
+    public string DiagnosticId { get; }
+
+    public string? UrlFormat { get; set; }
+}
+#endif

src/Sentry/Experimental/System.Diagnostics.UnreachableException.cs

@@ -0,0 +1,22 @@
+#if !NET7_0_OR_GREATER
+// ReSharper disable CheckNamespace
+namespace System.Diagnostics;
+
+internal sealed class UnreachableException : Exception
+{
+    public UnreachableException()
+        : base("The program executed an instruction that was thought to be unreachable.")
+    {
+    }
+
+    public UnreachableException(string? message)
+        : base(message ?? "The program executed an instruction that was thought to be unreachable.")
+    {
+    }
+
+    public UnreachableException(string? message, Exception? innerException)
+        : base(message ?? "The program executed an instruction that was thought to be unreachable.", innerException)
+    {
+    }
+}
+#endif

src/Sentry/Infrastructure/DiagnosticId.cs

@@ -8,4 +8,13 @@ internal static class DiagnosticId
     /// </summary>
     internal const string ExperimentalFeature = "SENTRY0001";
 #endif
+
+    //TODO: QUESTION: Should we re-use the above for all [Experimental] features or have one ID per experimental feature?
+    internal const string ExperimentalSentryLogs = "SENTRY0002";
+}
+
+//TODO: not sure about this type name
+internal static class UrlFormats
+{
+    internal const string ExperimentalSentryLogs = "https://github.com/getsentry/sentry-dotnet/issues/4132";
 }

src/Sentry/Internal/Extensions/JsonExtensions.cs

@@ -472,6 +472,17 @@ public static void WriteSerializable(
         writer.WriteSerializableValue(value, logger);
     }
 
+    public static void WriteSerializable<TValue>(
+        this Utf8JsonWriter writer,
+        string propertyName,
+        TValue value,
+        IDiagnosticLogger? logger)
+        where TValue : struct, ISentryJsonSerializable
+    {
+        writer.WritePropertyName(propertyName);
+        value.WriteTo(writer, logger);
+    }
+
     public static void WriteDynamicValue(
         this Utf8JsonWriter writer,
         object? value,

src/Sentry/Protocol/Envelopes/Envelope.cs

@@ -1,3 +1,4 @@
+using Sentry.Experimental;
 using Sentry.Extensibility;
 using Sentry.Infrastructure;
 using Sentry.Internal;
@@ -445,6 +446,19 @@ internal static Envelope FromClientReport(ClientReport clientReport)
         return new Envelope(header, items);
     }
 
+    [Experimental(DiagnosticId.ExperimentalSentryLogs)]
+    internal static Envelope FromLog(SentryLog log)
+    {
+        var header = DefaultHeader;
+
+        var items = new[]
+        {
+            EnvelopeItem.FromLog(log)
+        };
+
+        return new Envelope(header, items);
+    }
+
     private static async Task<IReadOnlyDictionary<string, object?>> DeserializeHeaderAsync(
         Stream stream,
         CancellationToken cancellationToken = default)