chore(observability): remove the arcus.observability hard-link in messaging

Author: stijnmoreels

src/Arcus.Messaging.Abstractions.ServiceBus/AzureServiceBusMessageContext.cs

@@ -4,10 +4,25 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Azure.Messaging.ServiceBus;
-using Microsoft.Extensions.Logging;
 
 namespace Arcus.Messaging.Abstractions.ServiceBus
 {
+    /// <summary>
+    /// Represents the type of Azure Service Bus entity on which the message was received.
+    /// </summary>
+    public enum ServiceBusEntityType
+    {
+        /// <summary>
+        /// The Azure Service Bus entity is a queue.
+        /// </summary>
+        Queue,
+
+        /// <summary>
+        /// The Azure Service Bus entity is a topic subscription.
+        /// </summary>
+        Topic
+    }
+
     /// <summary>
     /// Represents the contextual information concerning an Azure Service Bus message.
     /// </summary>

src/Arcus.Messaging.Abstractions.ServiceBus/MessageHandling/AzureServiceBusMessageRouter.cs

@@ -5,7 +5,6 @@
 using System.Threading.Tasks;
 using Arcus.Messaging.Abstractions.MessageHandling;
 using Arcus.Messaging.Abstractions.Telemetry;
-using Arcus.Observability.Telemetry.Core;
 using Azure.Messaging.ServiceBus;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -100,31 +99,12 @@ protected async Task<MessageProcessingResult> RouteMessageWithPotentialFallbackA
                 throw new ArgumentNullException(nameof(correlationInfo));
             }
 
-            string entityName = messageReceiver?.EntityPath ?? "<not-available>";
-            string serviceBusNamespace = messageReceiver?.FullyQualifiedNamespace ?? "<not-available>";
-
-            using DurationMeasurement measurement = DurationMeasurement.Start();
             using IServiceScope serviceScope = ServiceProvider.CreateScope();
 #pragma warning disable CS0618 // Type or member is obsolete: will be refactored when moving towards v3.0.
             using IDisposable _ = LogContext.Push(new MessageCorrelationInfoEnricher(correlationInfo, Options.CorrelationEnricher));
 #pragma warning restore CS0618 // Type or member is obsolete
 
-            try
-            {
-                MessageProcessingResult routingResult = await TryRouteMessageWithPotentialFallbackAsync(serviceScope.ServiceProvider, messageReceiver, message, messageContext, correlationInfo, cancellationToken);
-
-#pragma warning disable CS0618 // Type or member is obsolete: specific telemetry calls will be removed in v3.0.
-                Logger.LogServiceBusRequest(serviceBusNamespace, entityName, Options.Telemetry.OperationName, routingResult.IsSuccessful, measurement, messageContext.EntityType);
-#pragma warning restore CS0618 // Type or member is obsolete
-                return routingResult;
-            }
-            catch
-            {
-#pragma warning disable CS0618 // Type or member is obsolete: specific telemery calls will be removed in v3.0.
-                Logger.LogServiceBusRequest(serviceBusNamespace, entityName, Options.Telemetry.OperationName, false, measurement, messageContext.EntityType);
-#pragma warning restore CS0618 // Type or member is obsolete
-                throw;
-            }
+            return await TryRouteMessageWithPotentialFallbackAsync(serviceScope.ServiceProvider, messageReceiver, message, messageContext, correlationInfo, cancellationToken);
         }
 
         private async Task<MessageProcessingResult> TryRouteMessageWithPotentialFallbackAsync(

src/Arcus.Messaging.Abstractions/Arcus.Messaging.Abstractions.csproj

@@ -28,8 +28,8 @@
 
   <ItemGroup>
     <!-- TODO: will be removed in v3.0 -->
-    <PackageReference Include="Arcus.Observability.Telemetry.Serilog.Enrichers" Version="[3.0.0,4.0.0)" />
     <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" Version="2.21.0" />
+    <PackageReference Include="Serilog" Version="4.3.0" />
     <!-- TODO: will be removed in v3.0 -->
   </ItemGroup>
 

src/Arcus.Messaging.Abstractions/MessageCorrelationInfo.cs

@@ -1,22 +1,25 @@
 using System;
-using Arcus.Observability.Correlation;
 
 namespace Arcus.Messaging.Abstractions
 {
     /// <summary>
     /// Represents the information concerning correlation of telemetry &amp; processes with main focus on messaging scenarios.
     /// </summary>
-    public class MessageCorrelationInfo : CorrelationInfo
+    public class MessageCorrelationInfo
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="MessageCorrelationInfo"/> class.
         /// </summary>
         /// <param name="operationId">The unique identifier that spans one operation end-to-end.</param>
         /// <param name="transactionId">The unique identifier that spans one or more operations and are considered a transaction/session.</param>
-        /// <exception cref="ArgumentException">Thrown when the <paramref name="operationId"/> is blank.</exception>
+        /// <exception cref="ArgumentException">Thrown when the <paramref name="operationId"/> or <paramref name="transactionId"/> is blank.</exception>
         public MessageCorrelationInfo(string operationId, string transactionId)
-            : base(operationId, transactionId, operationParentId: null)
         {
+            ArgumentException.ThrowIfNullOrWhiteSpace(operationId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(transactionId);
+
+            OperationId = operationId;
+            TransactionId = transactionId;
             CycleId = Guid.NewGuid().ToString("D");
         }
 
@@ -26,13 +29,37 @@ public MessageCorrelationInfo(string operationId, string transactionId)
         /// <param name="operationId">The unique identifier that spans one operation end-to-end.</param>
         /// <param name="transactionId">The unique identifier that spans one or more operations and are considered a transaction/session.</param>
         /// <param name="operationParentId">The unique identifier of the original service that initiated this request.</param>
-        /// <exception cref="ArgumentException">Thrown when the <paramref name="operationId"/> is blank.</exception>
+        /// <exception cref="ArgumentException">
+        ///     Thrown when the <paramref name="operationId"/>, <paramref name="transactionId"/> or <paramref name="operationParentId"/> is blank.
+        /// </exception>
         public MessageCorrelationInfo(string operationId, string transactionId, string operationParentId)
-            : base(operationId, transactionId, operationParentId)
         {
+            ArgumentException.ThrowIfNullOrWhiteSpace(operationId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(transactionId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(operationParentId);
+
+            OperationId = operationId;
+            TransactionId = transactionId;
+            OperationParentId = operationParentId;
+
             CycleId = Guid.NewGuid().ToString("D");
         }
 
+        /// <summary>
+        /// Gets the ID that relates different messaging requests together in a single transaction.
+        /// </summary>
+        public string TransactionId { get; }
+
+        /// <summary>
+        /// Gets the unique ID information of the messaging request.
+        /// </summary>
+        public string OperationId { get; }
+
+        /// <summary>
+        /// Gets the ID of the original service that initiated this messaging request.
+        /// </summary>
+        public string OperationParentId { get; }
+
         /// <summary>
         /// Gets the unique identifier that indicates an attempt to process a given message.
         /// </summary>

src/Arcus.Messaging.Abstractions/MessageHandling/MessageCorrelationEnricherOptions.cs

@@ -1,16 +1,60 @@
 using System;
 using Arcus.Messaging.Abstractions.Telemetry;
-using Arcus.Observability.Telemetry.Serilog.Enrichers.Configuration;
 
 namespace Arcus.Messaging.Abstractions.MessageHandling
 {
     /// <summary>
     /// Represents the consumer configurable options model to change the behavior of the Serilog <see cref="MessageCorrelationInfoEnricher"/>.
     /// </summary>
     [Obsolete("Will be removed in v3.0 as W3C will be the only supported correlation format")]
-    public class MessageCorrelationEnricherOptions : CorrelationInfoEnricherOptions
+    public class MessageCorrelationEnricherOptions
     {
         private string _cycleIdPropertyName = "CycleId";
+        private string _operationIdPropertyName = "OperationId";
+        private string _transactionIdPropertyName = "TransactionId";
+        private string _operationParentIdPropertyName = "OperationParentId";
+
+        /// <summary>
+        /// Gets or sets the property name to enrich the log event with the correlation information operation ID.
+        /// </summary>
+        /// <exception cref="T:System.ArgumentException">Thrown when the <paramref name="value" /> is blank.</exception>
+        public string OperationIdPropertyName
+        {
+            get => _operationIdPropertyName;
+            set
+            {
+                ArgumentException.ThrowIfNullOrWhiteSpace(value);
+                _operationIdPropertyName = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the property name to enrich the log event with the correlation information transaction ID.
+        /// </summary>
+        /// <exception cref="T:System.ArgumentException">Thrown when the <paramref name="value" /> is blank.</exception>
+        public string TransactionIdPropertyName
+        {
+            get => _transactionIdPropertyName;
+            set
+            {
+                ArgumentException.ThrowIfNullOrWhiteSpace(value);
+                _transactionIdPropertyName = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the property name to enrich the log event with the correlation information parent operation ID.
+        /// </summary>
+        /// <exception cref="T:System.ArgumentException">Thrown when the <paramref name="value" /> is blank.</exception>
+        public string OperationParentIdPropertyName
+        {
+            get => _operationParentIdPropertyName;
+            set
+            {
+                ArgumentException.ThrowIfNullOrWhiteSpace(value);
+                _operationParentIdPropertyName = value;
+            }
+        }
 
         /// <summary>
         /// Gets or sets the property name to enrich the log event with the correlation information cycle ID.
@@ -21,11 +65,7 @@ public string CycleIdPropertyName
             get => _cycleIdPropertyName;
             set
             {
-                if (string.IsNullOrWhiteSpace(value))
-                {
-                    throw new ArgumentException("Requires a non-blank property name for the cycle ID", nameof(value));
-                }
-
+                ArgumentException.ThrowIfNullOrWhiteSpace(value);
                 _cycleIdPropertyName = value;
             }
         }

src/Arcus.Messaging.Pumps.ServiceBus/Extensions/IServiceCollectionExtensions.cs

@@ -1,4 +1,5 @@
 using System;
+using Arcus.Messaging.Abstractions.ServiceBus;
 using Arcus.Messaging.Abstractions.ServiceBus.MessageHandling;
 using Arcus.Messaging.Pumps.Abstractions.Resiliency;
 using Arcus.Messaging.Pumps.ServiceBus;

src/Arcus.Messaging.Pumps.ServiceBus/ServiceBusMessageRouter.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Text;
 using System.Threading;
@@ -9,7 +10,6 @@
 using Arcus.Messaging.Abstractions.ServiceBus;
 using Arcus.Messaging.Abstractions.ServiceBus.MessageHandling;
 using Arcus.Messaging.Abstractions.Telemetry;
-using Arcus.Observability.Telemetry.Core;
 using Azure.Messaging.ServiceBus;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -55,7 +55,9 @@ internal async Task<MessageProcessingResult> RouteMessageAsync(
             MessageCorrelationInfo correlationInfo,
             CancellationToken cancellationToken)
         {
-            using DurationMeasurement measurement = DurationMeasurement.Start();
+            var startTime = DateTimeOffset.UtcNow;
+            var watch = Stopwatch.StartNew();
+
             using IServiceScope serviceScope = ServiceProvider.CreateScope();
 #pragma warning disable CS0618 // Type or member is obsolete: will be refactored when moving towards v3.0.
             using IDisposable _ = LogContext.Push(new MessageCorrelationInfoEnricher(correlationInfo, Options.CorrelationEnricher));
@@ -71,8 +73,9 @@ internal async Task<MessageProcessingResult> RouteMessageAsync(
             }
             finally
             {
+                watch.Stop();
 #pragma warning disable CS0618 // Type or member is obsolete
-                Logger.LogServiceBusRequest(messageContext.FullyQualifiedNamespace, messageContext.EntityPath, Options.Telemetry.OperationName, isSuccessful, measurement, messageContext.EntityType);
+                Logger.LogServiceBusRequest(messageContext.FullyQualifiedNamespace, messageContext.EntityPath, Options.Telemetry.OperationName, isSuccessful, watch.Elapsed, startTime, messageContext.EntityType);
 #pragma warning restore CS0618 // Type or member is obsolete
             }
         }
@@ -190,4 +193,44 @@ private async Task AbandonMessageMatchedHandlerFailedAsync(AzureServiceBusMessag
             await messageContext.AbandonMessageAsync(new Dictionary<string, object>(), CancellationToken.None);
         }
     }
+
+    internal static class ILoggerExtensions
+    {
+        public static void LogServiceBusRequest(
+            this ILogger logger,
+            string serviceBusNamespace,
+            string entityName,
+            string operationName,
+            bool isSuccessful,
+            TimeSpan duration,
+            DateTimeOffset startTime,
+            ServiceBusEntityType entityType,
+            Dictionary<string, object> context = null)
+        {
+            if (string.IsNullOrWhiteSpace(operationName))
+            {
+                operationName = "Azure Service Bus message processing";
+            }
+
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
+            context["Endpoint"] = serviceBusNamespace;
+            context["EntityName"] = entityName;
+            context["EntityType"] = entityType;
+
+            logger.LogWarning("@{Request}", new
+            {
+                SourceSystem = RequestSourceSystem.AzureServiceBus,
+                RequestMethod = "<not-applicable>",
+                RequestHost = "<not-applicable>",
+                RequestUri = "<not-applicable>",
+                ResponseStatusCode = isSuccessful ? 200 : 500,
+                OperationName = operationName,
+                RequestDuration = duration,
+                RequestTime = startTime.ToString("yyyy-MM-ddTHH:mm:ss.fffffff zzz"),
+                Context = context
+            });
+        }
+
+        private enum RequestSourceSystem { AzureServiceBus }
+    }
 }

src/Arcus.Messaging.Tests.Core/Arcus.Messaging.Tests.Core.csproj

@@ -6,6 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Arcus.Observability.Telemetry.Core" Version="3.0.0" />
     <PackageReference Include="Microsoft.Data.SqlClient" Version="5.2.1" />
     <PackageReference Include="Bogus" Version="29.0.2" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.8.0" />

src/Arcus.Messaging.Tests.Integration/Arcus.Messaging.Tests.Integration.csproj

@@ -12,7 +12,6 @@
     <PackageReference Include="Arcus.Testing.Messaging.ServiceBus" Version="2.0.0" />
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.1" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
-    <PackageReference Include="Serilog" Version="2.11.0" />
     <PackageReference Include="Serilog.Extensions.Hosting" Version="3.1.0" />
     <PackageReference Include="xunit.v3" Version="2.*" />
     <PackageReference Include="xunit.runner.visualstudio" Version="3.0.2">

src/Arcus.Messaging.Tests.Integration/MessagePump/Fixture/ServiceBusTestContext.cs

@@ -22,6 +22,7 @@
 using Microsoft.Extensions.Logging.Abstractions;
 using Newtonsoft.Json;
 using Xunit;
+using ServiceBusEntityType = Arcus.Messaging.Abstractions.ServiceBus.ServiceBusEntityType;
 
 namespace Arcus.Messaging.Tests.Integration.MessagePump.Fixture
 {