Telemetry metrics for symbol push. (#6372)

* Add gallery telemetry metrics for the symbol push.

Author: cristinamanum

src/NuGetGallery/Controllers/ApiController.cs

@@ -395,6 +395,9 @@ public virtual Task<ActionResult> CreatePackagePost()
         [ActionName("PushSymbolPackageApi")]
         public virtual async Task<ActionResult> CreateSymbolPackagePutAsync()
         {
+            string id = null;
+            string normalizedVersion = null;
+
             try
             {
                 // Get the user
@@ -422,8 +425,9 @@ public virtual async Task<ActionResult> CreateSymbolPackagePutAsync()
                         using (var packageToPush = new PackageArchiveReader(symbolPackageStream, leaveStreamOpen: false))
                         {
                             var nuspec = packageToPush.GetNuspecReader();
-                            var id = nuspec.GetId();
+                            id = nuspec.GetId();
                             var version = nuspec.GetVersion();
+                            normalizedVersion = version.ToNormalizedStringSafe();
 
                             // Ensure the corresponding package exists before pushing a snupkg.
                             var package = PackageService.FindPackageByIdAndVersionStrict(id, version.ToStringSafe());
@@ -433,7 +437,7 @@ public virtual async Task<ActionResult> CreateSymbolPackagePutAsync()
                                     CultureInfo.CurrentCulture,
                                     Strings.SymbolsPackage_PackageIdAndVersionNotFound,
                                     id,
-                                    version.ToNormalizedStringSafe()));
+                                    normalizedVersion));
                             }
 
                             // Check if this user has the permissions to push the corresponding symbol package
@@ -463,7 +467,7 @@ public virtual async Task<ActionResult> CreateSymbolPackagePutAsync()
                                 {
                                     message = ex.Message;
                                 }
-
+                                TelemetryService.TrackSymbolPackageFailedGalleryValidationEvent(id, normalizedVersion);
                                 return new HttpStatusCodeWithBodyResult(HttpStatusCode.BadRequest, message);
                             }
 
@@ -493,6 +497,8 @@ public virtual async Task<ActionResult> CreateSymbolPackagePutAsync()
                                     throw new NotImplementedException($"The symbol package commit result {commitResult} is not supported.");
                             }
 
+                            TelemetryService.TrackSymbolPackagePushEvent(id, normalizedVersion);
+
                             return new HttpStatusCodeResult(HttpStatusCode.Created);
                         }
                     }
@@ -515,7 +521,7 @@ public virtual async Task<ActionResult> CreateSymbolPackagePutAsync()
             catch (Exception ex)
             {
                 ex.Log();
-
+                TelemetryService.TrackSymbolPackagePushFailureEvent(id, normalizedVersion);
                 throw ex;
             }
         }

src/NuGetGallery/Services/ITelemetryService.cs

@@ -146,5 +146,26 @@ public interface ITelemetryService
         /// <param name="success">Whether sending the email was successful.</param>
         /// <param name="attemptNumber">The number of attempts the message has tried to be sent.</param>
         void TrackSendEmail(string smtpUri, DateTimeOffset startTime, TimeSpan duration, bool success, int attemptNumber);
+
+        /// <summary>
+        /// A telemetry event emitted when a symbol package is pushed.
+        /// </summary>
+        /// <param name="packageId">The id of the package that has the symbols uploaded.</param>
+        /// <param name="packageVersion">The version of the package that has the symbols uploaded.</param>
+        void TrackSymbolPackagePushEvent(string packageId, string packageVersion);
+
+        /// <summary>
+        /// A telemetry event emitted when a symbol package fails to be pushed.
+        /// </summary>
+        /// <param name="packageId">The id of the package that has the symbols uploaded.</param>
+        /// <param name="packageVersion">The version of the package that has the symbols uploaded.</param>
+        void TrackSymbolPackagePushFailureEvent(string packageId, string packageVersion);
+
+        /// <summary>
+        /// A telemetry event emitted when a symbol package fails Gallery validation.
+        /// </summary>
+        /// <param name="packageId">The id of the package that has the symbols uploaded.</param>
+        /// <param name="packageVersion">The version of the package that has the symbols uploaded.</param>
+        void TrackSymbolPackageFailedGalleryValidationEvent(string packageId, string packageVersion);
     }
 }

src/NuGetGallery/Services/TelemetryService.cs

@@ -48,6 +48,9 @@ internal class Events
             public const string PackageRegistrationRequiredSignerSet = "PackageRegistrationRequiredSignerSet";
             public const string AccountDeleteCompleted = "AccountDeleteCompleted";
             public const string AccountDeleteRequested = "AccountDeleteRequested";
+            public const string SymbolPackagePush = "SymbolPackagePush";
+            public const string SymbolPackagePushFailure = "SymbolPackagePushFailure";
+            public const string SymbolPackageGalleryValidation = "SymbolPackageGalleryValidation";
         }
 
         private IDiagnosticsSource _diagnosticsSource;
@@ -346,6 +349,21 @@ public void TrackException(Exception exception, Action<Dictionary<string, string
             _telemetryClient.TrackException(exception, telemetryProperties, metrics: null);
         }
 
+        public void TrackSymbolPackagePushEvent(string packageId, string packageVersion)
+        {
+            TrackMetricForSymbolPackage(Events.SymbolPackagePush, packageId, packageVersion);
+        }
+
+        public void TrackSymbolPackagePushFailureEvent(string packageId, string packageVersion)
+        {
+            TrackMetricForSymbolPackage(Events.SymbolPackagePushFailure, packageId, packageVersion);
+        }
+
+        public void TrackSymbolPackageFailedGalleryValidationEvent(string packageId, string packageVersion)
+        {
+            TrackMetricForSymbolPackage(Events.SymbolPackageGalleryValidation, packageId, packageVersion);
+        }
+
         private void TrackMetricForAccountActivity(string eventName, User user, Credential credential, bool wasMultiFactorAuthenticated = false)
         {
             if (user == null)
@@ -410,6 +428,22 @@ private static string GetApiKeyCreationDate(User user, IIdentity identity)
             return apiKey?.Created.ToString("O") ?? "N/A";
         }
 
+        private void TrackMetricForSymbolPackage(
+            string metricName,
+            string packageId,
+            string packageVersion,
+            Action<Dictionary<string, string>> addProperties = null)
+        {
+            TrackMetric(metricName, 1, properties => {
+                properties.Add(ClientVersion, GetClientVersion());
+                properties.Add(ProtocolVersion, GetProtocolVersion());
+                properties.Add(ClientInformation, GetClientInformation());
+                properties.Add(PackageId, packageId);
+                properties.Add(PackageVersion, packageVersion);
+                addProperties?.Invoke(properties);
+            });
+        }
+
         private void TrackMetricForPackage(
             string metricName,
             Package package,

tests/NuGetGallery.Facts/Controllers/ApiControllerFacts.cs

@@ -408,6 +408,9 @@ public async Task CreateSymbolPackage_WillReturn400ForInvalidPackage()
                 ActionResult result = await controller.CreateSymbolPackagePutAsync();
 
                 // Assert
+                controller.MockTelemetryService.Verify(
+                    x => x.TrackSymbolPackageFailedGalleryValidationEvent(It.IsAny<string>(), It.IsAny<string>()),
+                    Times.Once());
                 ResultAssert.IsStatusCode(result, HttpStatusCode.BadRequest);
             }
 
@@ -488,8 +491,53 @@ public async Task CreateSymbolPackage_WillCreateSymbolPackageSuccessfully()
                 ActionResult result = await controller.CreateSymbolPackagePutAsync();
 
                 // Assert
+                controller.MockTelemetryService.Verify(
+                   x => x.TrackSymbolPackagePushEvent(It.IsAny<string>(), It.IsAny<string>()),
+                   Times.Once());
                 ResultAssert.IsStatusCode(result, HttpStatusCode.Created);
             }
+
+            [Fact]
+            public async Task CreateSymbolPackage_WillTraceFailureToPushEvent()
+            {
+                // Arrange
+                var user = new User() { EmailAddress = "[email protected]" };
+
+                var controller = new TestableApiController(GetConfigurationService());
+                controller.SetCurrentUser(user);
+
+                var nuGetPackage = TestPackage.CreateTestPackageStream("theId", "1.0.42");
+                controller.SetupPackageFromInputStream(nuGetPackage);
+
+                var package = new Package()
+                {
+                    PackageRegistration = new PackageRegistration()
+                    {
+                        Id = "TheId"
+                    },
+                    Version = "1.0.42",
+                    SymbolPackages = new HashSet<SymbolPackage>()
+                };
+
+                controller.MockPackageService
+                    .Setup(x => x.FindPackageByIdAndVersionStrict(It.IsAny<string>(), It.IsAny<string>()))
+                    .Returns(package);
+
+                controller.MockSymbolPackageUploadService
+                    .Setup(x => x.CreateAndUploadSymbolsPackage(
+                        package,
+                        It.IsAny<PackageStreamMetadata>(),
+                        It.IsAny<Stream>()))
+                    .ThrowsAsync(new SymbolsTestException("Test exception."));
+
+                // Act
+                var exception = await Assert.ThrowsAsync<SymbolsTestException>(() => controller.CreateSymbolPackagePutAsync());
+
+                // Assert
+                controller.MockTelemetryService.Verify(
+                   x => x.TrackSymbolPackagePushFailureEvent(It.IsAny<string>(), It.IsAny<string>()),
+                   Times.Once());
+            }
         }
 
         public class TheCreatePackageAction
@@ -2554,5 +2602,14 @@ public void RedirectsToDist()
                 Assert.Equal("https://dist.nuget.org/win-x86-commandline/v2.8.6/nuget.exe", redirect.Url);
             }
         }
+
+        public class SymbolsTestException : Exception
+        {
+            public SymbolsTestException(string message) : base (message)
+            {
+
+            }
+        }
+
     }
 }

tests/NuGetGallery.Facts/Services/TelemetryServiceFacts.cs

@@ -179,6 +179,18 @@ public static IEnumerable<object[]> TrackMetricNames_Data
                     yield return new object[] { "AccountDeleteRequested",
                         (TrackAction)(s => s.TrackRequestForAccountDeletion(fakes.User))
                     };
+
+                    yield return new object[] { "SymbolPackagePush",
+                        (TrackAction)(s => s.TrackSymbolPackagePushEvent("id", "version"))
+                    };
+
+                    yield return new object[] { "SymbolPackagePushFailure",
+                        (TrackAction)(s => s.TrackSymbolPackagePushFailureEvent("id", "version"))
+                    };
+
+                    yield return new object[] { "SymbolPackageGalleryValidation",
+                        (TrackAction)(s => s.TrackSymbolPackageFailedGalleryValidationEvent("id", "version"))
+                    };
                 }
             }