Documentation review

Snippets/CustomChecks/CustomChecks_3/CustomChecks.cs

@@ -67,4 +67,79 @@ public void CustomCheck_Configure_ServiceControl()
             timeToLive: TimeSpan.FromSeconds(10));
         #endregion
     }
+
+    #region CustomCheckFailed
+    public class CustomCheckFailed
+    {
+        /// <summary>
+        /// The id for the custom check provided by the user.
+        /// </summary>
+        public string CustomCheckId { get; set; }
+
+        /// <summary>
+        /// The custom check category provided by the user.
+        /// </summary>
+        public string Category { get; set; }
+
+        /// <summary>
+        /// The reason provided by the user for the failure.
+        /// </summary>
+        public string FailureReason { get; set; }
+
+        /// <summary>
+        /// The date and time the check failed.
+        /// </summary>
+        public DateTime FailedAt { get; set; }
+
+        /// <summary>
+        /// The name of the endpoint
+        /// </summary>
+        public string EndpointName { get; set; }
+
+        /// <summary>
+        /// The unique identifier for the host that runs the endpoint
+        /// </summary>
+        public Guid HostId { get; set; }
+
+        /// <summary>
+        /// The name of the host
+        /// </summary>
+        public string Host { get; set; }
+    }
+    #endregion
+
+    #region CustomCheckSucceeded
+    public class CustomCheckSucceeded
+    {
+        /// <summary>
+        /// The id for the custom check provided by the user.
+        /// </summary>
+        public string CustomCheckId { get; set; }
+
+        /// <summary>
+        /// The custom check category provided by the user.
+        /// </summary>
+        public string Category { get; set; }
+
+        /// <summary>
+        /// The date and time the check passed.
+        /// </summary>
+        public DateTime SucceededAt { get; set; }
+
+        /// <summary>
+        /// The name of the endpoint
+        /// </summary>
+        public string EndpointName { get; set; }
+
+        /// <summary>
+        /// The unique identifier for the host that runs the endpoint
+        /// </summary>
+        public Guid HostId { get; set; }
+
+        /// <summary>
+        /// The name of the host
+        /// </summary>
+        public string Host { get; set; }
+    }
+    #endregion
 }

Snippets/CustomChecks/CustomChecks_4/CustomChecks.cs

@@ -67,4 +67,79 @@ public void CustomCheck_Configure_ServiceControl()
             timeToLive: TimeSpan.FromSeconds(10));
         #endregion
     }
+
+    #region CustomCheckFailed
+    public class CustomCheckFailed
+    {
+        /// <summary>
+        /// The id for the custom check provided by the user.
+        /// </summary>
+        public string CustomCheckId { get; set; }
+
+        /// <summary>
+        /// The custom check category provided by the user.
+        /// </summary>
+        public string Category { get; set; }
+
+        /// <summary>
+        /// The reason provided by the user for the failure.
+        /// </summary>
+        public string FailureReason { get; set; }
+
+        /// <summary>
+        /// The date and time the check failed.
+        /// </summary>
+        public DateTime FailedAt { get; set; }
+
+        /// <summary>
+        /// The name of the endpoint
+        /// </summary>
+        public string EndpointName { get; set; }
+
+        /// <summary>
+        /// The unique identifier for the host that runs the endpoint
+        /// </summary>
+        public Guid HostId { get; set; }
+
+        /// <summary>
+        /// The name of the host
+        /// </summary>
+        public string Host { get; set; }
+    }
+    #endregion
+
+    #region CustomCheckSucceeded
+    public class CustomCheckSucceeded
+    {
+        /// <summary>
+        /// The id for the custom check provided by the user.
+        /// </summary>
+        public string CustomCheckId { get; set; }
+
+        /// <summary>
+        /// The custom check category provided by the user.
+        /// </summary>
+        public string Category { get; set; }
+
+        /// <summary>
+        /// The date and time the check passed.
+        /// </summary>
+        public DateTime SucceededAt { get; set; }
+
+        /// <summary>
+        /// The name of the endpoint
+        /// </summary>
+        public string EndpointName { get; set; }
+
+        /// <summary>
+        /// The unique identifier for the host that runs the endpoint
+        /// </summary>
+        public Guid HostId { get; set; }
+
+        /// <summary>
+        /// The name of the host
+        /// </summary>
+        public string Host { get; set; }
+    }
+    #endregion
 }

Snippets/CustomChecks/CustomChecks_5/CustomChecks.cs

@@ -67,4 +67,79 @@ public void CustomCheck_Configure_ServiceControl()
             timeToLive: TimeSpan.FromSeconds(10));
         #endregion
     }
+
+    #region CustomCheckFailed
+    public class CustomCheckFailed
+    {
+        /// <summary>
+        /// The id for the custom check provided by the user.
+        /// </summary>
+        public string CustomCheckId { get; set; }
+
+        /// <summary>
+        /// The custom check category provided by the user.
+        /// </summary>
+        public string Category { get; set; }
+
+        /// <summary>
+        /// The reason provided by the user for the failure.
+        /// </summary>
+        public string FailureReason { get; set; }
+
+        /// <summary>
+        /// The date and time the check failed.
+        /// </summary>
+        public DateTime FailedAt { get; set; }
+
+        /// <summary>
+        /// The name of the endpoint
+        /// </summary>
+        public string EndpointName { get; set; }
+
+        /// <summary>
+        /// The unique identifier for the host that runs the endpoint
+        /// </summary>
+        public Guid HostId { get; set; }
+
+        /// <summary>
+        /// The name of the host
+        /// </summary>
+        public string Host { get; set; }
+    }
+    #endregion
+
+    #region CustomCheckSucceeded
+    public class CustomCheckSucceeded
+    {
+        /// <summary>
+        /// The id for the custom check provided by the user.
+        /// </summary>
+        public string CustomCheckId { get; set; }
+
+        /// <summary>
+        /// The custom check category provided by the user.
+        /// </summary>
+        public string Category { get; set; }
+
+        /// <summary>
+        /// The date and time the check passed.
+        /// </summary>
+        public DateTime SucceededAt { get; set; }
+
+        /// <summary>
+        /// The name of the endpoint
+        /// </summary>
+        public string EndpointName { get; set; }
+
+        /// <summary>
+        /// The unique identifier for the host that runs the endpoint
+        /// </summary>
+        public Guid HostId { get; set; }
+
+        /// <summary>
+        /// The name of the host
+        /// </summary>
+        public string Host { get; set; }
+    }
+    #endregion
 }

monitoring/custom-checks/notification-events.md

@@ -1,7 +1,7 @@
 ---
 title: Custom Checks notification events
 summary: Learn about the integration events exposed by ServiceControl for the Custom Checks plugin
-reviewed: 2022-02-28
+reviewed: 2024-10-28
 component: CustomChecks
 versions: 'CustomChecks:*'
 ---
@@ -31,82 +31,10 @@ P -- Failed --> F
 
 The `CustomCheckFailed` event is published if a custom check transitions from the unknown or pass state to the fail state.
 
-```csharp
-public class CustomCheckFailed
-{
-    /// <summary>
-    /// The id for the custom check provided by the user.
-    /// </summary>
-    public string CustomCheckId { get; set; }
-
-    /// <summary>
-    /// The custom check category provided by the user.
-    /// </summary>
-    public string Category { get; set; }
-
-    /// <summary>
-    /// The reason provided by the user for the failure.
-    /// </summary>
-    public string FailureReason { get; set; }
-
-    /// <summary>
-    /// The date and time the check failed.
-    /// </summary>
-    public DateTime FailedAt { get; set; }
-
-    /// <summary>
-    /// The name of the endpoint
-    /// </summary>
-    public string EndpointName { get; set; }
-
-    /// <summary>
-    /// The unique identifier for the host that runs the endpoint
-    /// </summary>
-    public Guid HostId { get; set; }
-
-    /// <summary>
-    /// The name of the host
-    /// </summary>
-    public string Host { get; set; }
-}
-```
-
+snippet: CustomCheckFailed
 
 ## `CustomCheckSucceeded`
 
 The `CustomCheckSucceeded` event is published if a custom check transitions from the unknown or fail state to the pass state.
 
-```csharp
-public class CustomCheckSucceeded
-{
-    /// <summary>
-    /// The id for the custom check provided by the user.
-    /// </summary>
-    public string CustomCheckId { get; set; }
-
-    /// <summary>
-    /// The custom check category provided by the user.
-    /// </summary>
-    public string Category { get; set; }
-
-    /// <summary>
-    /// The date and time the check passed.
-    /// </summary>
-    public DateTime SucceededAt { get; set; }
-
-    /// <summary>
-    /// The name of the endpoint
-    /// </summary>
-    public string EndpointName { get; set; }
-
-    /// <summary>
-    /// The unique identifier for the host that runs the endpoint
-    /// </summary>
-    public Guid HostId { get; set; }
-
-    /// <summary>
-    /// The name of the host
-    /// </summary>
-    public string Host { get; set; }
-}
-```
+snippet: CustomCheckSucceeded

monitoring/heartbeats/expired-heartbeats.md

@@ -1,7 +1,7 @@
 ---
 title: Expired heartbeat messages
 summary:
-reviewed: 2022-02-28
+reviewed: 2024-10-28
 component: Heartbeats
 versions: 'Heartbeats:*'
 ---

nservicebus/sagas/saga-finding.md

@@ -1,7 +1,7 @@
 ---
 title: Complex saga finding logic
 summary: Use IFindSaga to write custom code that resolves sagas.
-reviewed: 2022-02-18
+reviewed: 2024-10-28
 component: Core
 related:
 - samples/saga/nh-custom-sagafinder