Add KnownOperation telemetry and add more configuration to DI (#7867)

joelverhagen · joelverhagen · commit 2afaf673619c · 2020-03-16T12:06:59.000-07:00
Progress on NuGet/Engineering#3020
diff --git a/src/DatabaseMigrationTools/DatabaseMigrationTools.csproj b/src/DatabaseMigrationTools/DatabaseMigrationTools.csproj
@@ -64,7 +64,7 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Validation">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
   </ItemGroup>
   <ItemGroup>
diff --git a/src/GitHubVulnerabilities2Db/GitHubVulnerabilities2Db.csproj b/src/GitHubVulnerabilities2Db/GitHubVulnerabilities2Db.csproj
@@ -89,7 +89,7 @@
       <Version>4.3.0-dev-3453620</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Cursor">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
   </ItemGroup>
   <ItemGroup>
diff --git a/src/NuGetGallery.Core/NuGetGallery.Core.csproj b/src/NuGetGallery.Core/NuGetGallery.Core.csproj
@@ -242,16 +242,16 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="NuGet.Services.FeatureFlags">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Messaging.Email">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Validation">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Validation.Issues">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.StrongName.AnglicanGeek.MarkdownMailer">
       <Version>1.2.0</Version>
diff --git a/src/NuGetGallery.Services/Configuration/AppConfiguration.cs b/src/NuGetGallery.Services/Configuration/AppConfiguration.cs
@@ -5,6 +5,7 @@
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.Net.Mail;
+using NuGet.Services.Configuration;
 
 namespace NuGetGallery.Configuration
 {
diff --git a/src/NuGetGallery.Services/Configuration/ConfigurationService.cs b/src/NuGetGallery.Services/Configuration/ConfigurationService.cs
@@ -6,18 +6,18 @@
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 using System.Configuration;
-using System.Diagnostics;
 using System.Globalization;
 using System.Linq;
 using System.Threading.Tasks;
 using System.Web;
 using System.Web.Configuration;
 using Microsoft.WindowsAzure.ServiceRuntime;
+using NuGet.Services.Configuration;
 using NuGet.Services.KeyVault;
 
 namespace NuGetGallery.Configuration
 {
-    public class ConfigurationService : IGalleryConfigurationService
+    public class ConfigurationService : IGalleryConfigurationService, IConfigurationFactory
     {
         protected const string SettingPrefix = "Gallery.";
         protected const string FeaturePrefix = "Feature.";
@@ -73,6 +73,21 @@ public string GetSiteRoot(bool useHttps)
             return useHttps ? _httpsSiteRootThunk.Value : _httpSiteRootThunk.Value;
         }
 
+        public Task<T> Get<T>() where T : NuGet.Services.Configuration.Configuration, new()
+        {
+            // Get the prefix specified by the ConfigurationKeyPrefixAttribute on the class if it exists.
+            var classPrefix = string.Empty;
+            var configNamePrefixProperty = (ConfigurationKeyPrefixAttribute)typeof(T)
+                .GetCustomAttributes(typeof(ConfigurationKeyPrefixAttribute), inherit: true)
+                .FirstOrDefault();
+            if (configNamePrefixProperty != null)
+            {
+                classPrefix = configNamePrefixProperty.Prefix;
+            }
+
+            return ResolveConfigObject(Activator.CreateInstance<T>(), classPrefix);
+        }
+
         public async Task<T> ResolveConfigObject<T>(T instance, string prefix)
         {
             // Iterate over the properties
@@ -258,4 +273,4 @@ private string GetHttpsSiteRoot()
             return "https://" + siteRoot.Substring(7);
         }
     }
-}
+}
diff --git a/src/NuGetGallery.Services/Helpers/StringArrayConverter.cs b/src/NuGetGallery.Services/Helpers/StringArrayConverter.cs
diff --git a/src/NuGetGallery.Services/NuGetGallery.Services.csproj b/src/NuGetGallery.Services/NuGetGallery.Services.csproj
@@ -143,7 +143,6 @@
     <Compile Include="Extensions\UriExtensions.cs" />
     <Compile Include="Extensions\UserExtensions.cs" />
     <Compile Include="Helpers\MailAddressConverter.cs" />
-    <Compile Include="Helpers\StringArrayConverter.cs" />
     <Compile Include="Helpers\UploadHelper.cs" />
     <Compile Include="Models\LuceneIndexLocation.cs" />
     <Compile Include="Models\ReportPackageReason.cs" />
@@ -294,11 +293,11 @@
     <PackageReference Include="NuGet.Protocol">
       <Version>5.0.0-preview1.5665</Version>
     </PackageReference>
-    <PackageReference Include="NuGet.Services.KeyVault">
-      <Version>2.69.0</Version>
+    <PackageReference Include="NuGet.Services.Configuration">
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Logging">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.StrongName.WebBackgrounder">
       <Version>0.2.0</Version>
diff --git a/src/NuGetGallery/App_Start/DefaultDependenciesModule.cs b/src/NuGetGallery/App_Start/DefaultDependenciesModule.cs
@@ -22,12 +22,11 @@
 using Elmah;
 using Microsoft.ApplicationInsights.Extensibility;
 using Microsoft.ApplicationInsights.Extensibility.Implementation;
-using Microsoft.AspNet.TelemetryCorrelation;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Http;
 using Microsoft.Extensions.Logging;
 using Microsoft.WindowsAzure.ServiceRuntime;
-using Microsoft.WindowsAzure.Storage;
+using NuGet.Services.Configuration;
 using NuGet.Services.Entities;
 using NuGet.Services.FeatureFlags;
 using NuGet.Services.KeyVault;
@@ -108,6 +107,10 @@ protected override void Load(ContainerBuilder builder)
                 loggerConfiguration,
                 telemetryConfiguration: applicationInsightsConfiguration.TelemetryConfiguration);
 
+            builder.RegisterInstance(applicationInsightsConfiguration.TelemetryConfiguration)
+                .AsSelf()
+                .SingleInstance();
+
             builder.RegisterInstance(telemetryClient)
                 .AsSelf()
                 .As<ITelemetryClient>()
@@ -126,6 +129,7 @@ protected override void Load(ContainerBuilder builder)
 
             builder.RegisterInstance(configuration)
                 .AsSelf()
+                .As<IConfigurationFactory>()
                 .As<IGalleryConfigurationService>();
 
             builder.Register(c => configuration.Current)
@@ -519,6 +523,7 @@ internal static ApplicationInsightsConfiguration ConfigureApplicationInsights(
             }
 
             telemetryConfiguration.TelemetryInitializers.Add(new ClientInformationTelemetryEnricher());
+            telemetryConfiguration.TelemetryInitializers.Add(new KnownOperationNameEnricher());
 
             // Add processors
             telemetryConfiguration.TelemetryProcessorChainBuilder.Use(next =>
diff --git a/src/NuGetGallery/App_Start/Routes.cs b/src/NuGetGallery/App_Start/Routes.cs
@@ -223,7 +223,7 @@ public static void RegisterUIRoutes(RouteCollection routes)
                 "packages/{id}/{version}",
                 new
                 {
-                    controller = "packages",
+                    controller = "Packages",
                     action = "DisplayPackage",
                     version = UrlParameter.Optional
                 },
diff --git a/src/NuGetGallery/NuGetGallery.csproj b/src/NuGetGallery/NuGetGallery.csproj
@@ -583,6 +583,7 @@
     <Compile Include="Services\ValidationService.cs" />
     <Compile Include="Telemetry\ClientInformationTelemetryEnricher.cs" />
     <Compile Include="Telemetry\ClientTelemetryPIIProcessor.cs" />
+    <Compile Include="Telemetry\KnownOperationNameEnricher.cs" />
     <Compile Include="Telemetry\QuietExceptionLogger.cs" />
     <Compile Include="Infrastructure\PasswordValidationAttribute.cs" />
     <Compile Include="Migrations\201602181939424_RemovePackageStatistics.cs" />
@@ -2119,9 +2120,6 @@
     <PackageReference Include="Microsoft.Extensions.Http.Polly">
       <Version>2.2.0</Version>
     </PackageReference>
-    <PackageReference Include="NuGet.Services.Licenses">
-      <Version>2.69.0</Version>
-    </PackageReference>
     <PackageReference Include="NuGet.StrongName.AnglicanGeek.MarkdownMailer">
       <Version>1.2.0</Version>
     </PackageReference>
@@ -2298,14 +2296,14 @@
     <PackageReference Include="NuGet.Protocol">
       <Version>5.0.0-preview1.5665</Version>
     </PackageReference>
-    <PackageReference Include="NuGet.Services.KeyVault">
-      <Version>2.69.0</Version>
+    <PackageReference Include="NuGet.Services.Licenses">
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Owin">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Sql">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="Owin">
       <Version>1.0.0</Version>
diff --git a/src/NuGetGallery/Telemetry/KnownOperationNameEnricher.cs b/src/NuGetGallery/Telemetry/KnownOperationNameEnricher.cs
@@ -0,0 +1,53 @@
+﻿// 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.Collections.Generic;
+using Microsoft.ApplicationInsights.Channel;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.ApplicationInsights.Extensibility;
+
+namespace NuGetGallery
+{
+    /// <summary>
+    /// Because we have web.config based redirects and other steps in the pipeline that act before ASP.NET determines
+    /// the controller and action that a URL is associated with, the "operation name" field has an extremely high
+    /// cardinality which makes it inappropriate as a dimension in some metric systems. For example, sometimes the
+    /// operation name is the verbatim URL path, with parameters filled in. Therefore, we have a list of known operation
+    /// names that we copy to another field, which is better for aggregation.
+    /// </summary>
+    public class KnownOperationNameEnricher : ITelemetryInitializer
+    {
+        private const string KnownOperation = "KnownOperation";
+
+        private static readonly HashSet<string> KnownOperations = new HashSet<string>
+        {
+            "GET Packages/DisplayPackage",
+        };
+
+        public void Initialize(ITelemetry telemetry)
+        {
+            var request = telemetry as RequestTelemetry;
+            if (request == null)
+            {
+                return;
+            }
+
+            var itemTelemetry = telemetry as ISupportProperties;
+            if (itemTelemetry == null)
+            {
+                return;
+            }
+
+            var operationName = telemetry.Context?.Operation?.Name;
+            if (operationName == null)
+            {
+                return;
+            }
+
+            if (KnownOperations.Contains(operationName))
+            {
+                itemTelemetry.Properties[KnownOperation] = operationName;
+            }
+        }
+    }
+}
diff --git a/src/NuGetGallery/Web.config b/src/NuGetGallery/Web.config
@@ -583,7 +583,7 @@
       </dependentAssembly>
       <dependentAssembly>
         <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30AD4FE6B2A6AEED" culture="neutral"/>
-        <bindingRedirect oldVersion="0.0.0.0-10.0.0.0" newVersion="10.0.0.0"/>
+        <bindingRedirect oldVersion="0.0.0.0-11.0.0.0" newVersion="11.0.0.0"/>
       </dependentAssembly>
       <dependentAssembly>
         <assemblyIdentity name="Microsoft.Owin" publicKeyToken="31BF3856AD364E35" culture="neutral"/>
diff --git a/tests/NuGetGallery.Facts/App_Start/DefaultDependenciesModuleFacts.cs b/tests/NuGetGallery.Facts/App_Start/DefaultDependenciesModuleFacts.cs
@@ -152,6 +152,7 @@ private Action<ITelemetryInitializer>[] GetTelemetryInitializerInspectors(string
                 {
                     // Registered by DefaultDependenciesModule in NuGetGallery
                     ti => ti.GetType().Equals(typeof(ClientInformationTelemetryEnricher)),
+                    ti => ti.GetType().Equals(typeof(KnownOperationNameEnricher)),
 
                     // Registered by applicationinsights.config
                     ti => ti.GetType().Equals(typeof(HttpDependenciesParsingTelemetryInitializer)),
diff --git a/tests/NuGetGallery.FunctionalTests.Core/NuGetGallery.FunctionalTests.Core.csproj b/tests/NuGetGallery.FunctionalTests.Core/NuGetGallery.FunctionalTests.Core.csproj
@@ -81,7 +81,7 @@
       <Version>2.8.6</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Configuration">
-      <Version>2.69.0</Version>
+      <Version>2.70.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Versioning">
       <Version>4.4.0</Version>

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.ComponentModel;`
`6`	`6`	`using System.ComponentModel.DataAnnotations;`
`7`	`7`	`using System.Net.Mail;`
	`8`	`+using NuGet.Services.Configuration;`
`8`	`9`
`9`	`10`	`namespace NuGetGallery.Configuration`
`10`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -223,7 +223,7 @@ public static void RegisterUIRoutes(RouteCollection routes)`
`223`	`223`	`"packages/{id}/{version}",`
`224`	`224`	`new`
`225`	`225`	`{`
`226`		`- controller = "packages",`
	`226`	`+ controller = "Packages",`
`227`	`227`	`action = "DisplayPackage",`
`228`	`228`	`version = UrlParameter.Optional`
`229`	`229`	`},`