Move and consolidate TelemetryInitializers from NuGet.Jobs to NuGet.Services.Logging (#329)

Author: xavierdecoster

src/NuGet.Services.Logging/NuGet.Services.Logging.csproj

@@ -53,6 +53,7 @@
     <Compile Include="TelemetryInitializers\DeploymentIdTelemetryEnricher.cs" />
     <Compile Include="TelemetryInitializers\DeploymentLabelEnricher.cs" />
     <Compile Include="DurationMetric.cs" />
+    <Compile Include="TelemetryInitializers\JobPropertiesTelemetryInitializer.cs" />
     <Compile Include="TelemetryProcessors\ExceptionTelemetryProcessor.cs" />
     <Compile Include="Extensions\DiagnosticsTelemetryModuleExtensions.cs" />
     <Compile Include="LoggingSetup.cs" />

src/NuGet.Services.Logging/TelemetryInitializers/JobPropertiesTelemetryInitializer.cs

@@ -0,0 +1,47 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.ApplicationInsights.Extensibility;
+
+namespace NuGet.Services.Logging
+{
+    public class JobPropertiesTelemetryInitializer
+         : ITelemetryInitializer
+    {
+        private readonly string _jobName;
+        private readonly string _instanceName;
+        private readonly IDictionary<string, string> _globalDimensions;
+
+        public JobPropertiesTelemetryInitializer(
+            string jobName,
+            string instanceName,
+            IDictionary<string, string> globalDimensions)
+        {
+            _jobName = jobName ?? throw new ArgumentNullException(nameof(jobName));
+            _instanceName = instanceName ?? throw new ArgumentNullException(nameof(instanceName));
+            _globalDimensions = globalDimensions ?? throw new ArgumentNullException(nameof(globalDimensions));
+        }
+
+        public void Initialize(ITelemetry telemetry)
+        {
+            // We need to cast to ISupportProperties to avoid using the deprecated telemetry.Context.Properties API.
+            // https://github.com/Microsoft/ApplicationInsights-Home/issues/300
+            if (!(telemetry is ISupportProperties itemTelemetry))
+            {
+                return;
+            }
+
+            itemTelemetry.Properties["JobName"] = _jobName;
+            itemTelemetry.Properties["InstanceName"] = _instanceName;
+
+            foreach (var dimension in _globalDimensions)
+            {
+                itemTelemetry.Properties[dimension.Key] = dimension.Value;
+            }
+        }
+    }
+}

src/NuGet.Services.Logging/TelemetryInitializers/SupportPropertiesTelemetryInitializer.cs

@@ -22,11 +22,15 @@ protected SupportPropertiesTelemetryInitializer(string propertyName, string prop
 
         public void Initialize(ITelemetry telemetry)
         {
+            // We need to cast to ISupportProperties to avoid using the deprecated telemetry.Context.Properties API.
+            // https://github.com/Microsoft/ApplicationInsights-Home/issues/300
             if (!(telemetry is ISupportProperties itemTelemetry))
             {
                 return;
             }
 
+            // Note that telemetry initializers can be called multiple times for the same telemetry item.
+            // https://github.com/microsoft/ApplicationInsights-dotnet-server/issues/977
             if (itemTelemetry.Properties.ContainsKey(PropertyName))
             {
                 return;

tests/NuGet.Services.Logging.Tests/NuGet.Services.Logging.Tests.csproj

@@ -54,13 +54,15 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ApplicationInsightsTests.cs" />
-    <Compile Include="DeploymentLabelEnricherTests.cs" />
+    <Compile Include="TelemetryInitializers\DeploymentLabelEnricherTests.cs" />
     <Compile Include="Extensions\DiagnosticsTelemetryModuleExtensionsTests.cs" />
     <Compile Include="ExceptionTelemetryProcessorTests.cs" />
     <Compile Include="LoggingSetupTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="RequestTelemetryProcessorTests.cs" />
     <Compile Include="Extensions\TelemetryClientExtensionsTests.cs" />
+    <Compile Include="TelemetryInitializers\JobPropertiesTelemetryInitializerTests.cs" />
+    <Compile Include="TestableTelemetry.cs" />
     <Compile Include="TelemetryProcessorTest.cs" />
   </ItemGroup>
   <ItemGroup>

…ng.Tests/DeploymentLabelEnricherTests.cs …ializers/DeploymentLabelEnricherTests.cstests/NuGet.Services.Logging.Tests/DeploymentLabelEnricherTests.cs renamed to tests/NuGet.Services.Logging.Tests/TelemetryInitializers/DeploymentLabelEnricherTests.cs tests/NuGet.Services.Logging.Tests/DeploymentLabelEnricherTests.cs renamed to tests/NuGet.Services.Logging.Tests/TelemetryInitializers/DeploymentLabelEnricherTests.cs

@@ -0,0 +1,101 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
+using Moq;
+using Xunit;
+
+namespace NuGet.Services.Logging.Tests
+{
+    public class JobPropertiesTelemetryInitializerTests
+    {
+        private readonly TelemetryContext _telemetryContext = new TelemetryContext();
+        private readonly Mock<ITelemetry> _telemetry = new Mock<ITelemetry>();
+
+        public JobPropertiesTelemetryInitializerTests()
+        {
+            _telemetry.SetupGet(x => x.Context)
+                .Returns(_telemetryContext);
+        }
+
+        [Fact]
+        public void Constructor_WhenJobNameIsNull_Throws()
+        {
+            var exception = Assert.Throws<ArgumentNullException>(
+                () => new JobPropertiesTelemetryInitializer(
+                    jobName: null,
+                    instanceName: "instanceName",
+                    globalDimensions: new Dictionary<string, string>()));
+
+            Assert.Equal("jobName", exception.ParamName);
+        }
+
+        [Fact]
+        public void Constructor_WhenInstanceNameIsNull_Throws()
+        {
+            var exception = Assert.Throws<ArgumentNullException>(
+                () => new JobPropertiesTelemetryInitializer(
+                    jobName: "jobName",
+                    instanceName: null,
+                    globalDimensions: new Dictionary<string, string>()));
+
+            Assert.Equal("instanceName", exception.ParamName);
+        }
+
+        [Fact]
+        public void Constructor_WhenGlobalDimensionsIsNull_Throws()
+        {
+            var exception = Assert.Throws<ArgumentNullException>(
+                () => new JobPropertiesTelemetryInitializer(
+                    jobName: "jobName",
+                    instanceName: "instanceName",
+                    globalDimensions: null));
+
+            Assert.Equal("globalDimensions", exception.ParamName);
+        }
+
+        [Fact]
+        public void Initialize_WhenGlobalDimensionsIsEmpty_SetsJobNameAndInstanceName()
+        {
+            var telemetry = new TestableTelemetry();
+
+            var initializer = new JobPropertiesTelemetryInitializer(
+                jobName: "a",
+                instanceName: "b",
+                globalDimensions: new Dictionary<string, string>());
+
+            initializer.Initialize(telemetry);
+
+            Assert.Equal(2, telemetry.Properties.Count);
+            Assert.Equal("a", telemetry.Properties["JobName"]);
+            Assert.Equal("b", telemetry.Properties["InstanceName"]);
+        }
+
+        [Fact]
+        public void Initialize_WhenGlobalDimensionsIsNotEmpty_SetsTelemetry()
+        {
+            var globalDimensions = new Dictionary<string, string>()
+            {
+                { "a", "b" },
+                { "c", "d" }
+            };
+            var telemetry = new TestableTelemetry();
+
+            var initializer = new JobPropertiesTelemetryInitializer(
+                jobName: "jobName",
+                instanceName: "instanceName",
+                globalDimensions: globalDimensions);
+
+            initializer.Initialize(telemetry);
+
+            Assert.Equal(4, telemetry.Properties.Count);
+            Assert.Equal("jobName", telemetry.Properties["JobName"]);
+            Assert.Equal("instanceName", telemetry.Properties["InstanceName"]);
+            Assert.Equal("b", telemetry.Properties["a"]);
+            Assert.Equal("d", telemetry.Properties["c"]);
+        }
+    }
+}

tests/NuGet.Services.Logging.Tests/TelemetryInitializers/JobPropertiesTelemetryInitializerTests.cs

@@ -0,0 +1,39 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.ApplicationInsights.Extensibility;
+
+namespace NuGet.Services.Logging.Tests
+{
+    public class TestableTelemetry : ITelemetry, ISupportProperties
+    {
+        public DateTimeOffset Timestamp { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
+
+        public TelemetryContext Context => throw new NotImplementedException();
+
+        public IExtension Extension { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
+
+        public string Sequence { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
+
+        public IDictionary<string, string> Properties { get; } = new Dictionary<string, string>();
+
+        public ITelemetry DeepClone()
+        {
+            throw new NotImplementedException();
+        }
+
+        public void Sanitize()
+        {
+            throw new NotImplementedException();
+        }
+
+        public void SerializeData(ISerializationWriter serializationWriter)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}