fix: do not alter telemetry ctx pt.1

arcus-azure · Oct 20, 2023 · e92c7ba · e92c7ba
1 parent 14e17ad
commit e92c7ba
Show file tree

Hide file tree

Showing 20 changed files with 373 additions and 46 deletions.
diff --git a/...cus.Observability.Telemetry.AzureFunctions/Extensions/ILoggerHttpRequestDataExtensions.cs b/...cus.Observability.Telemetry.AzureFunctions/Extensions/ILoggerHttpRequestDataExtensions.cs
@@ -121,7 +121,7 @@ public static void LogRequest(
             Guard.NotNull(request, nameof(request), "Requires a HTTP request instance to track a HTTP request");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the request operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             logger.LogWarning(MessageFormats.RequestFormat,
                 RequestLogEntry.CreateForHttpRequest(request.Method,

diff --git a/...Arcus.Observability.Telemetry.Core/Extensions/ILoggerAzureKeyVaultDependencyExtensions.cs b/...Arcus.Observability.Telemetry.Core/Extensions/ILoggerAzureKeyVaultDependencyExtensions.cs
@@ -70,7 +70,6 @@ public static void LogAzureKeyVaultDependency(
             Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name for the Azure Key Vault");
             Guard.NotNull(measurement, nameof(measurement), "Requires a dependency measurement instance to track the latency of the Azure Key Vault when tracking an Azure Key Vault dependency");
 
-            context = context ?? new Dictionary<string, object>();
             LogAzureKeyVaultDependency(logger, vaultUri, secretName, isSuccessful, measurement, dependencyId: null, context);
         }
 
@@ -135,7 +134,6 @@ public static void LogAzureKeyVaultDependency(
             Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name for the Azure Key Vault");
             Guard.NotNull(measurement, nameof(measurement), "Requires a dependency measurement instance to track the latency of the Azure Key Vault when tracking an Azure Key Vault dependency");
 
-            context = context ?? new Dictionary<string, object>();
             LogAzureKeyVaultDependency(logger, vaultUri, secretName, isSuccessful, measurement.StartTime, measurement.Elapsed, dependencyId, context);
         }
 
@@ -168,7 +166,6 @@ public static void LogAzureKeyVaultDependency(
             Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name for the Azure Key Vault");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the Azure Key Vault operation");
 
-            context = context ?? new Dictionary<string, object>();
             LogAzureKeyVaultDependency(logger, vaultUri, secretName, isSuccessful, startTime, duration, dependencyId: null, context);
         }
 
@@ -203,7 +200,7 @@ public static void LogAzureKeyVaultDependency(
             Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name for the Azure Key Vault");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the Azure Key Vault operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             logger.LogWarning(MessageFormats.DependencyFormat, new DependencyLogEntry(
                 dependencyType: "Azure key vault",

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerBlobStorageDependencyExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerBlobStorageDependencyExtensions.cs
@@ -124,8 +124,6 @@ public static void LogBlobStorageDependency(
             Guard.NotNullOrWhitespace(containerName, nameof(containerName), "Requires a non-blank container name in the Azure BLob storage resource to track an Azure Blob storage dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the Azure Blob storage operation");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogBlobStorageDependency(logger, accountName, containerName, isSuccessful, startTime, duration, dependencyId: null, context);
         }
 
@@ -158,7 +156,7 @@ public static void LogBlobStorageDependency(
             Guard.NotNullOrWhitespace(containerName, nameof(containerName), "Requires a non-blank container name in the Azure BLob storage resource to track an Azure Blob storage dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the Azure Blob storage operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             string dependencyName = $"{accountName}/{containerName}";
 

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerEventExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerEventExtensions.cs
@@ -26,7 +26,7 @@ public static void LogSecurityEvent(this ILogger logger, string name, Dictionary
             Guard.NotNull(logger, nameof(logger), "Requires a logger instance to track telemetry");
             Guard.NotNullOrWhitespace(name, nameof(name), "Requires a non-blank name of the event to track an security event");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
             context["EventType"] = "Security";
 
             LogCustomEvent(logger, name, context);

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerHttpDependencyExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerHttpDependencyExtensions.cs
@@ -152,8 +152,6 @@ public static void LogHttpDependency(
             Guard.For(() => request.RequestUri is null, new ArgumentException("Requires a HTTP request URI to track a HTTP dependency", nameof(request)));
             Guard.For(() => request.Method is null, new ArgumentException("Requires a HTTP request method to track a HTTP dependency", nameof(request)));
 
-            context = context ?? new Dictionary<string, object>();
-
             LogHttpDependency(logger, request, statusCode, startTime, duration, dependencyId: null, context);
         }
 
@@ -220,7 +218,7 @@ public static void LogHttpDependency(
             Guard.NotLessThan(statusCode, 100, nameof(statusCode), "Requires a valid HTTP response status code that's within the range of 100 to 599, inclusive");
             Guard.NotGreaterThan(statusCode, 599, nameof(statusCode), "Requires a valid HTTP response status code that's within the range of 100 to 599, inclusive");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             Uri requestUri = request.RequestUri;
             string targetName = requestUri.Host;

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerIotHubDependencyExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerIotHubDependencyExtensions.cs
@@ -113,8 +113,6 @@ public static void LogIotHubDependency(
             Guard.NotNullOrWhitespace(iotHubName, nameof(iotHubName), "Requires a non-blank resource name of the IoT Hub resource to track a IoT Hub dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the IoT Hub operation");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogIotHubDependency(logger, iotHubName, isSuccessful, startTime, duration, dependencyId: null, context);
         }
 
@@ -142,8 +140,6 @@ public static void LogIotHubDependencyWithConnectionString(
             Guard.NotNullOrWhitespace(iotHubConnectionString, nameof(iotHubConnectionString), "Requires an IoT Hub connection string to retrieve the IoT host name to track the IoT Hub dependency");
             Guard.NotNull(measurement, nameof(measurement), "Requires an measurement instance to measure the duration of interaction with the IoT Hub dependency");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogIotHubDependencyWithConnectionString(logger, iotHubConnectionString, isSuccessful, measurement.StartTime, measurement.Elapsed, dependencyId, context);
         }
 
@@ -172,8 +168,6 @@ public static void LogIotHubDependencyWithConnectionString(
             Guard.NotNull(logger, nameof(logger), "Requires an logger instance to track the IoT Hub dependency");
             Guard.NotNullOrWhitespace(iotHubConnectionString, nameof(iotHubConnectionString), "Requires an IoT Hub connection string to retrieve the IoT host name to track the IoT Hub dependency");
 
-            context = context ?? new Dictionary<string, object>();
-
             var result = IotHubConnectionStringParser.Parse(iotHubConnectionString);
             LogIotHubDependency(logger, iotHubName: result.HostName, isSuccessful, startTime, duration, dependencyId, context);
         }
@@ -204,7 +198,7 @@ public static void LogIotHubDependency(
             Guard.NotNullOrWhitespace(iotHubName, nameof(iotHubName), "Requires a non-blank resource name of the IoT Hub resource to track a IoT Hub dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the IoT Hub operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             logger.LogWarning(MessageFormats.DependencyFormat, new DependencyLogEntry(
                 dependencyType: "Azure IoT Hub",

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerMetricExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerMetricExtensions.cs
@@ -27,8 +27,6 @@ public static void LogCustomMetric(this ILogger logger, string name, double valu
             Guard.NotNull(logger, nameof(logger), "Requires a logger instance to track telemetry");
             Guard.NotNullOrWhitespace(name, nameof(name), "Requires a non-blank name to track a metric");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogCustomMetric(logger, name, value, DateTimeOffset.UtcNow, context);
         }
 
@@ -67,7 +65,7 @@ public static void LogCustomMetric(this ILogger logger, string name, double valu
             Guard.NotNull(logger, nameof(logger), "Requires a logger instance to track telemetry");
             Guard.NotNullOrWhitespace(name, nameof(name), "Requires a non-blank name to track a metric");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             logger.LogWarning(MessageFormats.MetricFormat, new MetricLogEntry(name, value, timestamp, context));
         }

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerRequestExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerRequestExtensions.cs
@@ -307,8 +307,6 @@ public static void LogRequest(
             Guard.NotNull(request, nameof(request), "Requires a HTTP request instance to track a HTTP request");
             Guard.NotNull(measurement, nameof(measurement), "Requires an measurement instance to time the duration of the HTTP request");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogRequest(logger, request, responseStatusCode, measurement.StartTime, measurement.Elapsed, context);
         }
 
@@ -340,8 +338,6 @@ public static void LogRequest(
             Guard.NotNull(request, nameof(request), "Requires a HTTP request instance to track a HTTP request");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the request operation");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogRequest(logger, request, responseStatusCode, operationName: null, startTime, duration, context);
         }
 
@@ -419,8 +415,6 @@ public static void LogRequest(
             Guard.NotNull(request, nameof(request), "Requires a HTTP request instance to track a HTTP request");
             Guard.NotNull(measurement, nameof(measurement), "Requires an measurement instance to time the duration of the HTTP request");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogRequest(logger, request, responseStatusCode, operationName, measurement.StartTime, measurement.Elapsed, context);
         }
 
@@ -457,7 +451,7 @@ public static void LogRequest(
             Guard.NotNull(request, nameof(request), "Requires a HTTP request instance to track a HTTP request");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the request operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             logger.LogWarning(MessageFormats.RequestFormat,
                 RequestLogEntry.CreateForHttpRequest(

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerSqlDependencyExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerSqlDependencyExtensions.cs
@@ -307,8 +307,6 @@ public static void LogSqlDependency(
             Guard.NotNullOrWhitespace(databaseName, nameof(databaseName), "Requires a non-blank SQL database name to track a SQL dependency");
             Guard.NotNull(measurement, nameof(measurement), "Requires a dependency measurement instance to measure the latency of the SQL storage when tracking an SQL dependency");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogSqlDependency(logger, serverName, databaseName, sqlCommand, operationName, isSuccessful, measurement.StartTime, measurement.Elapsed, dependencyId, context);
         }
 
@@ -345,7 +343,7 @@ public static void LogSqlDependency(
             Guard.NotNullOrWhitespace(databaseName, nameof(databaseName), "Requires a non-blank SQL database name to track a SQL dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the SQL dependency operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             logger.LogWarning(MessageFormats.SqlDependencyFormat, new DependencyLogEntry(
                 dependencyType: "Sql",

diff --git a/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerTableStorageDependencyExtensions.cs b/src/Arcus.Observability.Telemetry.Core/Extensions/ILoggerTableStorageDependencyExtensions.cs
@@ -124,8 +124,6 @@ public static void LogTableStorageDependency(
             Guard.NotNullOrWhitespace(tableName, nameof(tableName), "Requires a non-blank table name in the Azure Table storage resource to track an Azure Table storage dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the Azure Table storage operation");
 
-            context = context ?? new Dictionary<string, object>();
-
             LogTableStorageDependency(logger, accountName, tableName, isSuccessful, startTime, duration, dependencyId: null, context);
         }
 
@@ -158,7 +156,7 @@ public static void LogTableStorageDependency(
             Guard.NotNullOrWhitespace(tableName, nameof(tableName), "Requires a non-blank table name in the Azure Table storage resource to track an Azure Table storage dependency");
             Guard.NotLessThan(duration, TimeSpan.Zero, nameof(duration), "Requires a positive time duration of the Azure Table storage operation");
 
-            context = context ?? new Dictionary<string, object>();
+            context = context is null ? new Dictionary<string, object>() : new Dictionary<string, object>(context);
 
             string dependencyName = $"{accountName}/{tableName}";
 

diff --git a/...rcus.Observability.Tests.Unit/Telemetry/Logging/AzureBlobStorageDependencyLoggingTests.cs b/...rcus.Observability.Tests.Unit/Telemetry/Logging/AzureBlobStorageDependencyLoggingTests.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Arcus.Observability.Telemetry.Core;
 using Arcus.Observability.Telemetry.Core.Logging;
 using Bogus;
@@ -196,7 +197,7 @@ public void LogBlobStorageDependencyWithDurationMeasurement_WithoutAccountName_F
             var measurement = DurationMeasurement.Start();
             measurement.Dispose();
 
-            // Act / 
+            // Act / Assert
             Assert.ThrowsAny<ArgumentException>(
                 () => logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement));
         }
@@ -214,7 +215,7 @@ public void LogBlobStorageDependencyWithDurationMeasurementWithDependencyId_With
             measurement.Dispose();
             string dependencyId = _bogusGenerator.Lorem.Word();
 
-            // Act / 
+            // Act / Assert
             Assert.ThrowsAny<ArgumentException>(
                 () => logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement, dependencyId));
         }
@@ -231,7 +232,7 @@ public void LogBlobStorageDependencyWithDurationMeasurement_WithoutContainerName
             var measurement = DurationMeasurement.Start();
             measurement.Dispose();
 
-            // Act / 
+            // Act / Assert
             Assert.ThrowsAny<ArgumentException>(
                 () => logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement));
         }
@@ -249,7 +250,7 @@ public void LogBlobStorageDependencyWithDurationMeasurementWithDependencyId_With
             measurement.Dispose();
             string dependencyId = _bogusGenerator.Lorem.Word();
 
-            // Act / 
+            // Act / Assert
             Assert.ThrowsAny<ArgumentException>(
                 () => logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement, dependencyId));
         }
@@ -263,7 +264,7 @@ public void LogBlobStorageDependencyWithDurationMeasurement_WithoutMeasurement_F
             string containerName = _bogusGenerator.Finance.AccountName();
             bool isSuccessful = _bogusGenerator.Random.Bool();
 
-            // Act / 
+            // Act / Assert
             Assert.ThrowsAny<ArgumentException>(
                 () => logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement: (DurationMeasurement)null));
         }
@@ -278,9 +279,48 @@ public void LogBlobStorageDependencyWithDurationMeasurementWithDependencyId_With
             bool isSuccessful = _bogusGenerator.Random.Bool();
             string dependencyId = _bogusGenerator.Lorem.Word();
 
-            // Act / 
+            // Act / Assert
             Assert.ThrowsAny<ArgumentException>(
                 () => logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement: null, dependencyId));
         }
+
+        [Fact]
+        public void LogBlobStorageDependencyWithDurationMeasurement_WithContext_DoesNotAlterContext()
+        {
+            // Arrange
+            var logger = new TestLogger();
+            string accountName = _bogusGenerator.Finance.AccountName();
+            string containerName = _bogusGenerator.Finance.AccountName();
+            bool isSuccessful = _bogusGenerator.Random.Bool();
+            string dependencyId = _bogusGenerator.Lorem.Word();
+            using var measurement = DurationMeasurement.Start();
+            var context = new Dictionary<string, object>();
+
+            // Act
+            logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, measurement, dependencyId, context);
+
+            // Assert
+            Assert.Empty(context);
+        }
+
+        [Fact]
+        public void LogBlobStorageDependencyWithStartDuration_WithContext_DoesNotAlterContext()
+        {
+            // Arrange
+            var logger = new TestLogger();
+            string accountName = _bogusGenerator.Finance.AccountName();
+            string containerName = _bogusGenerator.Finance.AccountName();
+            bool isSuccessful = _bogusGenerator.Random.Bool();
+            string dependencyId = _bogusGenerator.Lorem.Word();
+            var startTime = _bogusGenerator.Date.RecentOffset();
+            var duration = _bogusGenerator.Date.Timespan();
+            var context = new Dictionary<string, object>();
+
+            // Act
+            logger.LogBlobStorageDependency(accountName, containerName, isSuccessful, startTime, duration, dependencyId, context);
+
+            // Assert
+            Assert.Empty(context);
+        }
     }
 }