Move to manifest based event source (#7164)

Author: Nigusu-Allehu

src/NuGet.Core/Microsoft.Build.NuGetSdkResolver/GlobalJsonReader.cs

@@ -6,13 +6,11 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Diagnostics.Tracing;
 using System.Globalization;
 using System.IO;
 using System.Runtime.CompilerServices;
 using Microsoft.Build.Framework;
 using Newtonsoft.Json;
-using NuGet.Common;
 
 namespace Microsoft.Build.NuGetSdkResolver
 {
@@ -242,7 +240,7 @@ private Dictionary<string, string> ParseMSBuildSdkVersions(string globalJsonPath
             // Load the file as a string and check if it has an msbuild-sdks section.  Parsing the contents requires Newtonsoft.Json.dll to be loaded which can be expensive
             string json;
 
-            if (NuGetEventSource.IsEnabled) TraceEvents.GlobalJsonReadStart(globalJsonPath, sdkResolverContext);
+            if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.GlobalJsonReadStart(globalJsonPath, sdkResolverContext.ProjectFilePath, sdkResolverContext.SolutionFilePath);
 
             try
             {
@@ -281,40 +279,8 @@ private Dictionary<string, string> ParseMSBuildSdkVersions(string globalJsonPath
             }
             finally
             {
-                if (NuGetEventSource.IsEnabled) TraceEvents.GlobalJsonReadStop(globalJsonPath, sdkResolverContext);
+                if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.GlobalJsonReadStop(globalJsonPath, sdkResolverContext.ProjectFilePath, sdkResolverContext.SolutionFilePath);
             }
         }
-
-        private static class TraceEvents
-        {
-            private const string EventNameGlobalJsonRead = "SdkResolver/GlobalJsonRead";
-
-            public static void GlobalJsonReadStart(string globalJsonPath, SdkResolverContext sdkResolverContext)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.SdkResolver | NuGetEventSource.Keywords.Performance,
-                    Opcode = EventOpcode.Start
-                };
-
-                NuGetEventSource.Instance.Write(EventNameGlobalJsonRead, eventOptions, new GlobalJsonReadEventData(globalJsonPath, sdkResolverContext.ProjectFilePath, sdkResolverContext.SolutionFilePath));
-            }
-
-            public static void GlobalJsonReadStop(string globalJsonPath, SdkResolverContext sdkResolverContext)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.SdkResolver | NuGetEventSource.Keywords.Performance,
-                    Opcode = EventOpcode.Stop
-                };
-
-                NuGetEventSource.Instance.Write(EventNameGlobalJsonRead, eventOptions, new GlobalJsonReadEventData(globalJsonPath, sdkResolverContext.ProjectFilePath, sdkResolverContext.SolutionFilePath));
-            }
-
-            [EventData]
-            private record struct GlobalJsonReadEventData(string Path, string ProjectFullPath, string SolutionFullPath);
-        }
     }
 }

src/NuGet.Core/Microsoft.Build.NuGetSdkResolver/NuGetSdkLogger.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.Tracing;
 using System.Threading.Tasks;
 using Microsoft.Build.Framework;
 using NuGet.Common;
@@ -56,46 +55,55 @@ public NuGetSdkLogger(SdkLogger sdkLogger)
         /// <inheritdoc cref="ILogger.Log(NuGet.Common.LogLevel, string)" />
         public void Log(LogLevel level, string data)
         {
-            EventLevel eventLevel = EventLevel.LogAlways;
-
             switch (level)
             {
                 case LogLevel.Debug:
                 case LogLevel.Verbose:
                     // Debug and Verbose verbosity in NuGet maps to a low importance message in MSBuild
                     _sdkLogger.LogMessage(data, MessageImportance.Low);
-
-                    eventLevel = EventLevel.Verbose;
                     break;
 
                 case LogLevel.Information:
                     // Information verbosity in NuGet maps to a normal importance message in MSBuild
                     _sdkLogger.LogMessage(data, MessageImportance.Normal);
-
-                    eventLevel = EventLevel.Informational;
                     break;
 
                 case LogLevel.Minimal:
                     // Minimal verbosity in NuGet maps to a high importance message in MSBuild
                     _sdkLogger.LogMessage(data, MessageImportance.High);
-
-                    eventLevel = EventLevel.LogAlways;
                     break;
 
                 case LogLevel.Warning:
                     _warnings.Add(data);
-
-                    eventLevel = EventLevel.Warning;
                     break;
 
                 case LogLevel.Error:
                     _errors.Add(data);
-
-                    eventLevel = EventLevel.Error;
                     break;
             }
 
-            if (NuGetEventSource.IsEnabled) TraceEvents.LogMessage(eventLevel, level, data);
+            if (SdkResolverEventSource.Instance.IsEnabled())
+            {
+                switch (level)
+                {
+                    case LogLevel.Debug:
+                    case LogLevel.Verbose:
+                        SdkResolverEventSource.Instance.LogMessageVerbose((int)level, data);
+                        break;
+                    case LogLevel.Information:
+                        SdkResolverEventSource.Instance.LogMessageInformational((int)level, data);
+                        break;
+                    case LogLevel.Minimal:
+                        SdkResolverEventSource.Instance.LogMessageAlways((int)level, data);
+                        break;
+                    case LogLevel.Warning:
+                        SdkResolverEventSource.Instance.LogMessageWarning((int)level, data);
+                        break;
+                    case LogLevel.Error:
+                        SdkResolverEventSource.Instance.LogMessageError((int)level, data);
+                        break;
+                }
+            }
         }
 
         /// <inheritdoc cref="ILogger.LogAsync(ILogMessage)" />
@@ -137,22 +145,5 @@ public Task LogAsync(ILogMessage message)
 
         /// <inheritdoc cref="ILogger.LogWarning(string)" />
         public void LogWarning(string data) => Log(LogLevel.Warning, data);
-
-        private static class TraceEvents
-        {
-            public static void LogMessage(EventLevel eventLevel, LogLevel level, string message)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    Level = eventLevel,
-                    Keywords = NuGetEventSource.Keywords.Logging,
-                };
-
-                NuGetEventSource.Instance.Write("SdkResolver/LogMessage", eventOptions, new LogMessageEventData(level, message));
-            }
-
-            [EventData]
-            private record struct LogMessageEventData(LogLevel Level, string Message);
-        }
     }
 }

src/NuGet.Core/Microsoft.Build.NuGetSdkResolver/NuGetSdkResolver.cs

@@ -5,7 +5,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.Tracing;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -88,7 +87,7 @@ public override SdkResult Resolve(SdkReference sdkReference, SdkResolverContext
                 return factory.IndicateFailure(errors: new List<string>() { Strings.Error_DisabledSdkResolver }, warnings: null);
             }
 
-            if (NuGetEventSource.IsEnabled) TraceEvents.ResolveStart(sdkReference);
+            if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.ResolveStart(sdkReference.Name, sdkReference.Version);
 
             try
             {
@@ -108,7 +107,7 @@ public override SdkResult Resolve(SdkReference sdkReference, SdkResolverContext
             }
             finally
             {
-                if (NuGetEventSource.IsEnabled) TraceEvents.ResolveStop(sdkReference);
+                if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.ResolveStop(sdkReference.Name, sdkReference.Version);
             }
         }
 
@@ -159,13 +158,13 @@ public static SdkResult GetSdkResult(SdkReference sdk, object nuGetVersion, SdkR
                 // Cast the NuGet version since the caller does not want to consume NuGet classes directly
                 var parsedSdkVersion = (NuGetVersion)nuGetVersion;
 
-                if (NuGetEventSource.IsEnabled) TraceEvents.GetResultStart(sdk.Name, parsedSdkVersion.OriginalVersion);
+                if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.GetResultStart(sdk.Name, parsedSdkVersion.OriginalVersion);
 
                 SdkResult result = null;
 
                 try
                 {
-                    if (NuGetEventSource.IsEnabled) TraceEvents.LoadSettingsStart();
+                    if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.LoadSettingsStart();
 
                     // Load NuGet settings and a path resolver
                     ISettings settings;
@@ -183,7 +182,7 @@ public static SdkResult GetSdkResult(SdkReference sdk, object nuGetVersion, SdkR
                     }
                     finally
                     {
-                        if (NuGetEventSource.IsEnabled) TraceEvents.LoadSettingsStop();
+                        if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.LoadSettingsStop();
                     }
 
                     var fallbackPackagePathResolver = new FallbackPackagePathResolver(NuGetPathContext.Create(settings));
@@ -201,7 +200,7 @@ public static SdkResult GetSdkResult(SdkReference sdk, object nuGetVersion, SdkR
                             X509TrustStore.InitializeForDotNetSdk(logger);
 #endif
 
-                            if (NuGetEventSource.IsEnabled) TraceEvents.RestorePackageStart(libraryIdentity);
+                            if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.RestorePackageStart(libraryIdentity.Name, libraryIdentity.Version.OriginalVersion);
 
                             // Asynchronously run the restore without a commit which find the package on configured feeds, download, and unzip it without generating any other files
                             // This must be run in its own task because legacy project system evaluates projects on the UI thread which can cause RunWithoutCommit() to deadlock
@@ -213,7 +212,7 @@ public static SdkResult GetSdkResult(SdkReference sdk, object nuGetVersion, SdkR
 
                             var results = restoreTask.Result;
 
-                            if (NuGetEventSource.IsEnabled) TraceEvents.RestorePackageStop(libraryIdentity);
+                            if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.RestorePackageStop(libraryIdentity.Name, libraryIdentity.Version.OriginalVersion);
 
                             fallbackPackagePathResolver = new FallbackPackagePathResolver(NuGetPathContext.Create(settings));
 
@@ -266,7 +265,7 @@ public static SdkResult GetSdkResult(SdkReference sdk, object nuGetVersion, SdkR
                 }
                 finally
                 {
-                    if (NuGetEventSource.IsEnabled) TraceEvents.GetResultStop(sdk.Name, parsedSdkVersion.OriginalVersion, result);
+                    if (SdkResolverEventSource.Instance.IsEnabled()) SdkResolverEventSource.Instance.GetResultStop(sdk.Name, parsedSdkVersion.OriginalVersion, result?.Path, result == null ? 0 : (result.Success ? 1 : 0));
                 }
             }
 
@@ -317,121 +316,5 @@ private static bool TryGetMSBuildSdkPackageInfo(FallbackPackagePathResolver fall
                 return true;
             }
         }
-
-        private static class TraceEvents
-        {
-            private const string EventNameGetResult = "SdkResolver/GetResult";
-            private const string EventNameLoadSettings = "SdkResolver/LoadSettings";
-            private const string EventNameResolve = "SdkResolver/Resolve";
-            private const string EventNameRestorePackage = "SdkResolver/RestorePackage";
-
-            public static void GetResultStart(string id, string version)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.Performance | NuGetEventSource.Keywords.SdkResolver,
-                    Opcode = EventOpcode.Start
-                };
-
-                NuGetEventSource.Instance.Write(EventNameGetResult, eventOptions, new GetResultStartEventData(id, version));
-            }
-
-            public static void GetResultStop(string id, string version, SdkResult result)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.Performance | NuGetEventSource.Keywords.SdkResolver,
-                    Opcode = EventOpcode.Stop
-                };
-
-                NuGetEventSource.Instance.Write(EventNameGetResult, eventOptions, new GetResultStopEventData(id, version, InstallPath: result?.Path, Success: result == null ? false : result.Success));
-            }
-
-            public static void LoadSettingsStart()
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.Performance | NuGetEventSource.Keywords.SdkResolver,
-                    Opcode = EventOpcode.Start
-                };
-
-                NuGetEventSource.Instance.Write(EventNameLoadSettings, eventOptions);
-            }
-
-            public static void LoadSettingsStop()
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.Performance | NuGetEventSource.Keywords.SdkResolver,
-                    Opcode = EventOpcode.Stop
-                };
-
-                NuGetEventSource.Instance.Write(EventNameLoadSettings, eventOptions);
-            }
-
-            public static void ResolveStart(SdkReference sdkReference)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.SdkResolver | NuGetEventSource.Keywords.Performance,
-                    Opcode = EventOpcode.Start
-                };
-
-                NuGetEventSource.Instance.Write(EventNameResolve, eventOptions, new ResolveEventData(sdkReference.Name, sdkReference.Version));
-            }
-
-            public static void ResolveStop(SdkReference sdkReference)
-            {
-                var eventData = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.SdkResolver | NuGetEventSource.Keywords.Performance,
-                    Opcode = EventOpcode.Stop
-                };
-
-                NuGetEventSource.Instance.Write(EventNameResolve, eventData, new ResolveEventData(sdkReference.Name, sdkReference.Version));
-            }
-
-            public static void RestorePackageStart(LibraryIdentity libraryIdentity)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.Performance | NuGetEventSource.Keywords.SdkResolver,
-                    Opcode = EventOpcode.Start
-                };
-
-                NuGetEventSource.Instance.Write(EventNameRestorePackage, eventOptions, new RestorePackageEventData(libraryIdentity.Name, libraryIdentity.Version.OriginalVersion));
-            }
-
-            public static void RestorePackageStop(LibraryIdentity libraryIdentity)
-            {
-                var eventOptions = new EventSourceOptions
-                {
-                    ActivityOptions = EventActivityOptions.Detachable,
-                    Keywords = NuGetEventSource.Keywords.Performance | NuGetEventSource.Keywords.SdkResolver,
-                    Opcode = EventOpcode.Stop
-                };
-
-                NuGetEventSource.Instance.Write(EventNameRestorePackage, eventOptions, new RestorePackageEventData(libraryIdentity.Name, libraryIdentity.Version.OriginalVersion));
-            }
-
-            [EventData]
-            private record struct GetResultStartEventData(string Id, string Version);
-
-            [EventData]
-            private record struct GetResultStopEventData(string Id, string Version, string InstallPath, bool Success);
-
-            [EventData]
-            private record struct ResolveEventData(string Name, string Version);
-
-            [EventData]
-            private record struct RestorePackageEventData(string Id, string Version);
-        }
     }
 }