feat: Check-In Upserts (#3330)

CHANGELOG.md

@@ -19,6 +19,7 @@
 
 ### Features
 
+- The SDK now supports monitor upserting. You can programmatically set up your monitors via the options callback in `SentrySdk.CaptureCheckIn` ([#3330](https://github.com/getsentry/sentry-dotnet/pull/3330))
 - Added an `SentrySdk.RunAsyncVoid` helper method that lets you capture exceptions from `async void` methods ([#3379](https://github.com/getsentry/sentry-dotnet/pull/3379))
 
 ### Fixes

src/Sentry/Extensibility/DiagnosticLoggerExtensions.cs

@@ -252,6 +252,15 @@ public static class DiagnosticLoggerExtensions
         string message)
         => logger.LogIfEnabled(SentryLevel.Error, null, message);
 
+    /// <summary>
+    /// Log an error message.
+    /// </summary>
+    public static void LogError<TArg>(
+        this IDiagnosticLogger logger,
+        string message,
+        TArg arg)
+        => logger.LogIfEnabled(SentryLevel.Error, null, message, arg);
+
     /// <summary>
     /// Log an exception with an error message.
     /// </summary>

src/Sentry/Extensibility/DisabledHub.cs

@@ -183,8 +183,13 @@ public void CaptureSession(SessionUpdate sessionUpdate)
     /// <summary>
     /// No-Op
     /// </summary>
-    public SentryId CaptureCheckIn(string monitorSlug, CheckInStatus status, SentryId? sentryId = null,
-        TimeSpan? duration = null, Scope? scope = null)
+    public SentryId CaptureCheckIn(
+        string monitorSlug,
+        CheckInStatus status,
+        SentryId? sentryId = null,
+        TimeSpan? duration = null,
+        Scope? scope = null,
+        Action<SentryMonitorOptions>? configureMonitorOptions = null)
         => SentryId.Empty;
 
     /// <summary>

src/Sentry/Extensibility/HubAdapter.cs

@@ -270,9 +270,14 @@ public void CaptureSession(SessionUpdate sessionUpdate)
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>
-    public SentryId CaptureCheckIn(string monitorSlug, CheckInStatus status, SentryId? sentryId = null,
-        TimeSpan? duration = null, Scope? scope = null)
-        => SentrySdk.CaptureCheckIn(monitorSlug, status, sentryId, duration);
+    public SentryId CaptureCheckIn(
+        string monitorSlug,
+        CheckInStatus status,
+        SentryId? sentryId = null,
+        TimeSpan? duration = null,
+        Scope? scope = null,
+        Action<SentryMonitorOptions>? monitorOptions = null)
+        => SentrySdk.CaptureCheckIn(monitorSlug, status, sentryId, duration, scope, monitorOptions);
 
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>

src/Sentry/ISentryClient.cs

@@ -79,8 +79,13 @@ public interface ISentryClient
     /// <param name="sentryId"></param>
     /// <param name="duration"></param>
     /// <param name="scope"></param>
-    SentryId CaptureCheckIn(string monitorSlug, CheckInStatus status, SentryId? sentryId = null,
-        TimeSpan? duration = null, Scope? scope = null);
+    /// <param name="configureMonitorOptions">The optional monitor config used to create a Check-In programmatically.</param>
+    SentryId CaptureCheckIn(string monitorSlug,
+        CheckInStatus status,
+        SentryId? sentryId = null,
+        TimeSpan? duration = null,
+        Scope? scope = null,
+        Action<SentryMonitorOptions>? configureMonitorOptions = null);
 
     /// <summary>
     /// Flushes the queue of captured events until the timeout is reached.

src/Sentry/Internal/Hub.cs

@@ -561,9 +561,13 @@ public void CaptureSession(SessionUpdate sessionUpdate)
         }
     }
 
-    public SentryId CaptureCheckIn(string monitorSlug, CheckInStatus status, SentryId? sentryId = null,
+    public SentryId CaptureCheckIn(
+        string monitorSlug,
+        CheckInStatus status,
+        SentryId? sentryId = null,
         TimeSpan? duration = null,
-        Scope? scope = null)
+        Scope? scope = null,
+        Action<SentryMonitorOptions>? configureMonitorOptions = null)
     {
         if (!IsEnabled)
         {
@@ -580,7 +584,7 @@ public void CaptureSession(SessionUpdate sessionUpdate)
                 scope = currentScope;
             }
 
-            return _ownedClient.CaptureCheckIn(monitorSlug, status, sentryId, duration, scope);
+            return _ownedClient.CaptureCheckIn(monitorSlug, status, sentryId, duration, scope, configureMonitorOptions);
         }
         catch (Exception e)
         {

src/Sentry/SentryCheckIn.cs

@@ -4,7 +4,7 @@
 namespace Sentry;
 
 /// <summary>
-/// The Checkin Status
+/// The Check-In Status
 /// </summary>
 public enum CheckInStatus
 {
@@ -25,13 +25,13 @@ public enum CheckInStatus
 }
 
 /// <summary>
-/// Sentry Checkin
+/// Sentry Check-In
 /// </summary>
 // https://develop.sentry.dev/sdk/check-ins/
 public class SentryCheckIn : ISentryJsonSerializable
 {
     /// <summary>
-    /// CheckIn ID
+    /// Check-In ID
     /// </summary>
     public SentryId Id { get; }
 
@@ -40,13 +40,14 @@ public class SentryCheckIn : ISentryJsonSerializable
     /// </summary>
     public string MonitorSlug { get; }
 
+
     /// <summary>
-    /// The status of the Checkin
+    /// The status of the Check-In
     /// </summary>
     public CheckInStatus Status { get; }
 
     /// <summary>
-    /// The duration of the check-in in seconds. Will only take effect if the status is ok or error.
+    /// The duration of the Check-In in seconds. Will only take effect if the status is ok or error.
     /// </summary>
     public TimeSpan? Duration { get; set; }
 
@@ -65,6 +66,11 @@ public class SentryCheckIn : ISentryJsonSerializable
     /// </summary>
     internal SentryId? TraceId { get; set; }
 
+    /// <summary>
+    /// The Monitor Config
+    /// </summary>
+    internal SentryMonitorOptions? MonitorOptions { get; set; }
+
     /// <summary>
     /// Initializes a new instance of <see cref="SentryCheckIn"/>.
     /// </summary>
@@ -103,6 +109,8 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
             writer.WriteEndObject();
         }
 
+        MonitorOptions?.WriteTo(writer, logger);
+
         writer.WriteEndObject();
     }
 

src/Sentry/SentryClient.cs

@@ -220,7 +220,13 @@ public void CaptureSession(SessionUpdate sessionUpdate)
         => CaptureEnvelope(Envelope.FromSession(sessionUpdate));
 
     /// <inheritdoc />
-    public SentryId CaptureCheckIn(string monitorSlug, CheckInStatus status, SentryId? sentryId = null, TimeSpan? duration = null, Scope? scope = null)
+    public SentryId CaptureCheckIn(
+        string monitorSlug,
+        CheckInStatus status,
+        SentryId? sentryId = null,
+        TimeSpan? duration = null,
+        Scope? scope = null,
+        Action<SentryMonitorOptions>? configureMonitorOptions = null)
     {
         scope ??= new Scope(_options);
 
@@ -234,9 +240,16 @@ public SentryId CaptureCheckIn(string monitorSlug, CheckInStatus status, SentryI
         var checkIn = new SentryCheckIn(monitorSlug, status, sentryId)
         {
             Duration = duration,
-            TraceId = traceId
+            TraceId = traceId,
         };
 
+        if (configureMonitorOptions is not null)
+        {
+            var monitorOptions = new SentryMonitorOptions();
+            configureMonitorOptions.Invoke(monitorOptions);
+            checkIn.MonitorOptions = monitorOptions;
+        }
+
         _enricher.Apply(checkIn);
 
         return CaptureEnvelope(Envelope.FromCheckIn(checkIn))