Track the project name for a generator driver and report it via ETW

chsienki · chsienki · commit 702be07f922b · 2025-11-04T14:21:08.000-08:00
diff --git a/src/Compilers/Core/Portable/CodeAnalysisEventSource.Common.cs b/src/Compilers/Core/Portable/CodeAnalysisEventSource.Common.cs
@@ -37,21 +37,23 @@ private CodeAnalysisEventSource() { }
         internal void StartSingleGeneratorRunTime(string generatorName, string assemblyPath, string id) => WriteEvent(3, generatorName, assemblyPath, id);
 
         [Event(4, Message = "Generator {0} ran for {2} ticks", Keywords = Keywords.Performance, Level = EventLevel.Informational, Opcode = EventOpcode.Stop, Task = Tasks.SingleGeneratorRunTime)]
-        internal unsafe void StopSingleGeneratorRunTime(string generatorName, string assemblyPath, long elapsedTicks, string id)
+        internal unsafe void StopSingleGeneratorRunTime(string generatorName, string projectName, string assemblyPath, long elapsedTicks, string id)
         {
             if (IsEnabled())
             {
                 fixed (char* generatorNameBytes = generatorName)
+                fixed (char* projectNameBytes = projectName)
                 fixed (char* assemblyPathBytes = assemblyPath)
                 fixed (char* idBytes = id)
                 {
-                    Span<EventData> data = stackalloc EventData[]
-                    {
+                    Span<EventData> data =
+                    [
                         GetEventDataForString(generatorName, generatorNameBytes),
+                        GetEventDataForString(projectName, projectNameBytes),
                         GetEventDataForString(assemblyPath, assemblyPathBytes),
                         GetEventDataForInt64(&elapsedTicks),
                         GetEventDataForString(id, idBytes),
-                    };
+                    ];
 
                     fixed (EventSource.EventData* dataPtr = data)
                     {
diff --git a/src/Compilers/Core/Portable/PublicAPI.Unshipped.txt b/src/Compilers/Core/Portable/PublicAPI.Unshipped.txt
@@ -1,4 +1,4 @@
-Microsoft.CodeAnalysis.CommandLineArguments.ManifestResourceArguments.get -> System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.CommandLineResource>
+﻿Microsoft.CodeAnalysis.CommandLineArguments.ManifestResourceArguments.get -> System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.CommandLineResource>
 Microsoft.CodeAnalysis.CommandLineResource
 Microsoft.CodeAnalysis.CommandLineResource.CommandLineResource() -> void
 Microsoft.CodeAnalysis.CommandLineResource.FullPath.get -> string!
@@ -13,6 +13,9 @@ Microsoft.CodeAnalysis.Emit.EmitDifferenceOptions
 Microsoft.CodeAnalysis.Emit.EmitDifferenceOptions.EmitDifferenceOptions() -> void
 Microsoft.CodeAnalysis.Emit.EmitDifferenceOptions.EmitFieldRva.get -> bool
 Microsoft.CodeAnalysis.Emit.EmitDifferenceOptions.EmitFieldRva.init -> void
+Microsoft.CodeAnalysis.GeneratorDriverOptions.GeneratorDriverOptions(Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind disabledOutputs = Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind.None, bool trackIncrementalGeneratorSteps = false, string? baseDirectory = null, string? projectName = null) -> void
+Microsoft.CodeAnalysis.GeneratorDriverOptions.GeneratorDriverOptions(Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind disabledOutputs, bool trackIncrementalGeneratorSteps, string? baseDirectory) -> void
+Microsoft.CodeAnalysis.GeneratorDriverOptions.ProjectName.get -> string?
 Microsoft.CodeAnalysis.IMethodSymbol.AssociatedExtensionImplementation.get -> Microsoft.CodeAnalysis.IMethodSymbol?
 Microsoft.CodeAnalysis.IMethodSymbol.IsIterator.get -> bool
 Microsoft.CodeAnalysis.IMethodSymbol.ReduceExtensionMember(Microsoft.CodeAnalysis.ITypeSymbol! receiverType) -> Microsoft.CodeAnalysis.IMethodSymbol?
diff --git a/src/Compilers/Core/Portable/SourceGeneration/GeneratorDriver.cs b/src/Compilers/Core/Portable/SourceGeneration/GeneratorDriver.cs
@@ -317,7 +317,7 @@ internal GeneratorDriverState RunGeneratorsCore(Compilation compilation, Diagnos
                     continue;
                 }
 
-                using var generatorTimer = CodeAnalysisEventSource.Log.CreateSingleGeneratorRunTimer(state.Generators[i], (t) => t.Add(syntaxStoreBuilder.GetRuntimeAdjustment(stateBuilder[i].InputNodes)));
+                using var generatorTimer = CodeAnalysisEventSource.Log.CreateSingleGeneratorRunTimer(state.Generators[i], state.ProjectName, (t) => t.Add(syntaxStoreBuilder.GetRuntimeAdjustment(stateBuilder[i].InputNodes)));
                 try
                 {
                     // We do not support incremental step tracking for v1 generators, as the pipeline is implicitly defined.
diff --git a/src/Compilers/Core/Portable/SourceGeneration/GeneratorDriverOptions.cs b/src/Compilers/Core/Portable/SourceGeneration/GeneratorDriverOptions.cs
@@ -22,6 +22,14 @@ public readonly struct GeneratorDriverOptions
         /// </summary>
         public string? BaseDirectory { get; }
 
+        /// <summary>
+        /// The name of the project this generator driver is for.
+        /// </summary>
+        /// <remarks>
+        /// Only used for telemetry purposes.
+        /// </remarks>
+        public string? ProjectName { get; }
+
         public GeneratorDriverOptions(IncrementalGeneratorOutputKind disabledOutputs)
             : this(disabledOutputs, false)
         {
@@ -40,7 +48,7 @@ public GeneratorDriverOptions(IncrementalGeneratorOutputKind disabledOutputs, bo
         /// <param name="trackIncrementalGeneratorSteps"></param>
         /// <param name="baseDirectory">Absolute path to the base directory used for file paths of generated files.</param>
         /// <exception cref="ArgumentException"><paramref name="baseDirectory"/> is not an absolute path.</exception>
-        public GeneratorDriverOptions(IncrementalGeneratorOutputKind disabledOutputs = IncrementalGeneratorOutputKind.None, bool trackIncrementalGeneratorSteps = false, string? baseDirectory = null)
+        public GeneratorDriverOptions(IncrementalGeneratorOutputKind disabledOutputs = IncrementalGeneratorOutputKind.None, bool trackIncrementalGeneratorSteps = false, string? baseDirectory = null, string? projectName = null)
         {
             if (baseDirectory != null && !PathUtilities.IsAbsolute(baseDirectory))
             {
@@ -50,6 +58,13 @@ public GeneratorDriverOptions(IncrementalGeneratorOutputKind disabledOutputs = I
             DisabledOutputs = disabledOutputs;
             TrackIncrementalGeneratorSteps = trackIncrementalGeneratorSteps;
             BaseDirectory = baseDirectory;
+            ProjectName = projectName;
+        }
+
+        // 5.0 BACKCOMPAT OVERLOAD -- DO NOT TOUCH
+        public GeneratorDriverOptions(IncrementalGeneratorOutputKind disabledOutputs, bool trackIncrementalGeneratorSteps, string? baseDirectory)
+            : this(disabledOutputs, trackIncrementalGeneratorSteps, baseDirectory, projectName: null)
+        {
         }
     }
 }
diff --git a/src/Compilers/Core/Portable/SourceGeneration/GeneratorDriverState.cs b/src/Compilers/Core/Portable/SourceGeneration/GeneratorDriverState.cs
@@ -80,6 +80,11 @@ internal GeneratorDriverState(ParseOptions parseOptions,
         /// </summary>
         internal string? BaseDirectory => _driverOptions.BaseDirectory;
 
+        /// <summary>
+        /// The name of the project this driver is associated with.
+        /// </summary>
+        internal string? ProjectName => _driverOptions.ProjectName;
+
         /// <summary>
         /// ParseOptions to use when parsing generator provided source.
         /// </summary>
diff --git a/src/Compilers/Core/Portable/SourceGeneration/GeneratorTimerExtensions.cs b/src/Compilers/Core/Portable/SourceGeneration/GeneratorTimerExtensions.cs
@@ -27,14 +27,14 @@ public static RunTimer CreateGeneratorDriverRunTimer(this CodeAnalysisEventSourc
             }
         }
 
-        public static RunTimer CreateSingleGeneratorRunTimer(this CodeAnalysisEventSource eventSource, ISourceGenerator generator, Func<TimeSpan, TimeSpan> adjustRunTime)
+        public static RunTimer CreateSingleGeneratorRunTimer(this CodeAnalysisEventSource eventSource, ISourceGenerator generator, string? projectName, Func<TimeSpan, TimeSpan> adjustRunTime)
         {
             if (eventSource.IsEnabled(EventLevel.Informational, Keywords.Performance))
             {
                 var id = Guid.NewGuid().ToString();
                 var type = generator.GetGeneratorType();
                 eventSource.StartSingleGeneratorRunTime(type.FullName!, type.Assembly.Location, id);
-                return new RunTimer(t => eventSource.StopSingleGeneratorRunTime(type.FullName!, type.Assembly.Location, t.Ticks, id), adjustRunTime);
+                return new RunTimer(t => eventSource.StopSingleGeneratorRunTime(type.FullName!, projectName ?? "<Unknown Project>", type.Assembly.Location, t.Ticks, id), adjustRunTime);
             }
             else
             {
diff --git a/src/Tools/SemanticSearch/ReferenceAssemblies/Apis/Microsoft.CodeAnalysis.txt b/src/Tools/SemanticSearch/ReferenceAssemblies/Apis/Microsoft.CodeAnalysis.txt
@@ -1076,9 +1076,11 @@ Microsoft.CodeAnalysis.GeneratorDriverOptions
 Microsoft.CodeAnalysis.GeneratorDriverOptions.#ctor(Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind)
 Microsoft.CodeAnalysis.GeneratorDriverOptions.#ctor(Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind,System.Boolean)
 Microsoft.CodeAnalysis.GeneratorDriverOptions.#ctor(Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind,System.Boolean,System.String)
+Microsoft.CodeAnalysis.GeneratorDriverOptions.#ctor(Microsoft.CodeAnalysis.IncrementalGeneratorOutputKind,System.Boolean,System.String,System.String)
 Microsoft.CodeAnalysis.GeneratorDriverOptions.DisabledOutputs
 Microsoft.CodeAnalysis.GeneratorDriverOptions.TrackIncrementalGeneratorSteps
 Microsoft.CodeAnalysis.GeneratorDriverOptions.get_BaseDirectory
+Microsoft.CodeAnalysis.GeneratorDriverOptions.get_ProjectName
 Microsoft.CodeAnalysis.GeneratorDriverRunResult
 Microsoft.CodeAnalysis.GeneratorDriverRunResult.get_Diagnostics
 Microsoft.CodeAnalysis.GeneratorDriverRunResult.get_GeneratedTrees
diff --git a/src/Workspaces/CSharp/Portable/Workspace/LanguageServices/CSharpCompilationFactoryService.cs b/src/Workspaces/CSharp/Portable/Workspace/LanguageServices/CSharpCompilationFactoryService.cs
@@ -53,6 +53,6 @@ CompilationOptions ICompilationFactoryService.GetDefaultCompilationOptions()
         return new CSharpCompilationOptions(outputKind: outputKind);
     }
 
-    GeneratorDriver ICompilationFactoryService.CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory)
-        => CSharpGeneratorDriver.Create(generators, additionalTexts, (CSharpParseOptions)parseOptions, optionsProvider, new GeneratorDriverOptions(baseDirectory: generatedFilesBaseDirectory));
+    GeneratorDriver ICompilationFactoryService.CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory, string? projectName)
+        => CSharpGeneratorDriver.Create(generators, additionalTexts, (CSharpParseOptions)parseOptions, optionsProvider, new GeneratorDriverOptions(baseDirectory: generatedFilesBaseDirectory, projectName: projectName));
 }
diff --git a/src/Workspaces/Core/Portable/Workspace/Host/CompilationFactory/ICompilationFactoryService.cs b/src/Workspaces/Core/Portable/Workspace/Host/CompilationFactory/ICompilationFactoryService.cs
@@ -15,5 +15,5 @@ internal interface ICompilationFactoryService : ILanguageService
     Compilation CreateSubmissionCompilation(string assemblyName, CompilationOptions options, Type? hostObjectType);
     CompilationOptions GetDefaultCompilationOptions();
     CompilationOptions? TryParsePdbCompilationOptions(IReadOnlyDictionary<string, string> compilationOptionsMetadata);
-    GeneratorDriver CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory);
+    GeneratorDriver CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory, string? projectName);
 }
diff --git a/src/Workspaces/Core/Portable/Workspace/Solution/SolutionCompilationState.RegularCompilationTracker_Generators.cs b/src/Workspaces/Core/Portable/Workspace/Solution/SolutionCompilationState.RegularCompilationTracker_Generators.cs
@@ -437,7 +437,8 @@ static GeneratorDriver CreateGeneratorDriver(ProjectState projectState)
                     GetSourceGenerators(projectState),
                     projectState.ProjectAnalyzerOptions.AnalyzerConfigOptionsProvider,
                     additionalTexts,
-                    generatedFilesBaseDirectory);
+                    generatedFilesBaseDirectory,
+                    $"{projectState.Name} ({projectState.Id})");
             }
 
             [Conditional("DEBUG")]
diff --git a/src/Workspaces/CoreTest/Host/LanguageServices/TestCSharpCompilationFactoryServiceWithIncrementalGeneratorTracking.cs b/src/Workspaces/CoreTest/Host/LanguageServices/TestCSharpCompilationFactoryServiceWithIncrementalGeneratorTracking.cs
@@ -55,8 +55,8 @@ CompilationOptions ICompilationFactoryService.GetDefaultCompilationOptions()
         return new CSharpCompilationOptions(outputKind: outputKind);
     }
 
-    GeneratorDriver ICompilationFactoryService.CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory)
+    GeneratorDriver ICompilationFactoryService.CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory, string? projectName)
     {
-        return CSharpGeneratorDriver.Create(generators, additionalTexts, (CSharpParseOptions)parseOptions, optionsProvider, new GeneratorDriverOptions(IncrementalGeneratorOutputKind.None, trackIncrementalGeneratorSteps: true, baseDirectory: TempRoot.Root));
+        return CSharpGeneratorDriver.Create(generators, additionalTexts, (CSharpParseOptions)parseOptions, optionsProvider, new GeneratorDriverOptions(IncrementalGeneratorOutputKind.None, trackIncrementalGeneratorSteps: true, baseDirectory: TempRoot.Root, projectName: projectName));
     }
 }
diff --git a/src/Workspaces/VisualBasic/Portable/Workspace/LanguageServices/VisualBasicCompilationFactoryService.vb b/src/Workspaces/VisualBasic/Portable/Workspace/LanguageServices/VisualBasicCompilationFactoryService.vb
@@ -65,8 +65,9 @@ Namespace Microsoft.CodeAnalysis.VisualBasic
                 generators As ImmutableArray(Of ISourceGenerator),
                 optionsProvider As AnalyzerConfigOptionsProvider,
                 additionalTexts As ImmutableArray(Of AdditionalText),
-                generatedFilesBaseDirectory As String) As GeneratorDriver Implements ICompilationFactoryService.CreateGeneratorDriver
-            Return VisualBasicGeneratorDriver.Create(generators, additionalTexts, DirectCast(parseOptions, VisualBasicParseOptions), optionsProvider, New GeneratorDriverOptions(baseDirectory:=generatedFilesBaseDirectory))
+                generatedFilesBaseDirectory As String,
+                projectName As String) As GeneratorDriver Implements ICompilationFactoryService.CreateGeneratorDriver
+            Return VisualBasicGeneratorDriver.Create(generators, additionalTexts, DirectCast(parseOptions, VisualBasicParseOptions), optionsProvider, New GeneratorDriverOptions(baseDirectory:=generatedFilesBaseDirectory, projectName:=projectName))
         End Function
     End Class
 End Namespace

Original file line number	Diff line number	Diff line change
`@@ -317,7 +317,7 @@ internal GeneratorDriverState RunGeneratorsCore(Compilation compilation, Diagnos`
`317`	`317`	`continue;`
`318`	`318`	`}`
`319`	`319`
`320`		`- using var generatorTimer = CodeAnalysisEventSource.Log.CreateSingleGeneratorRunTimer(state.Generators[i], (t) => t.Add(syntaxStoreBuilder.GetRuntimeAdjustment(stateBuilder[i].InputNodes)));`
	`320`	`+ using var generatorTimer = CodeAnalysisEventSource.Log.CreateSingleGeneratorRunTimer(state.Generators[i], state.ProjectName, (t) => t.Add(syntaxStoreBuilder.GetRuntimeAdjustment(stateBuilder[i].InputNodes)));`
`321`	`321`	`try`
`322`	`322`	`{`
`323`	`323`	`// We do not support incremental step tracking for v1 generators, as the pipeline is implicitly defined.`
Original file line number	Diff line number	Diff line change
`@@ -27,14 +27,14 @@ public static RunTimer CreateGeneratorDriverRunTimer(this CodeAnalysisEventSourc`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
`30`		`- public static RunTimer CreateSingleGeneratorRunTimer(this CodeAnalysisEventSource eventSource, ISourceGenerator generator, Func<TimeSpan, TimeSpan> adjustRunTime)`
	`30`	`+ public static RunTimer CreateSingleGeneratorRunTimer(this CodeAnalysisEventSource eventSource, ISourceGenerator generator, string? projectName, Func<TimeSpan, TimeSpan> adjustRunTime)`
`31`	`31`	`{`
`32`	`32`	`if (eventSource.IsEnabled(EventLevel.Informational, Keywords.Performance))`
`33`	`33`	`{`
`34`	`34`	`var id = Guid.NewGuid().ToString();`
`35`	`35`	`var type = generator.GetGeneratorType();`
`36`	`36`	`eventSource.StartSingleGeneratorRunTime(type.FullName!, type.Assembly.Location, id);`
`37`		`- return new RunTimer(t => eventSource.StopSingleGeneratorRunTime(type.FullName!, type.Assembly.Location, t.Ticks, id), adjustRunTime);`
	`37`	`+ return new RunTimer(t => eventSource.StopSingleGeneratorRunTime(type.FullName!, projectName ?? "<Unknown Project>", type.Assembly.Location, t.Ticks, id), adjustRunTime);`
`38`	`38`	`}`
`39`	`39`	`else`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,6 @@ CompilationOptions ICompilationFactoryService.GetDefaultCompilationOptions()`
`53`	`53`	`return new CSharpCompilationOptions(outputKind: outputKind);`
`54`	`54`	`}`
`55`	`55`
`56`		`- GeneratorDriver ICompilationFactoryService.CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory)`
`57`		`- => CSharpGeneratorDriver.Create(generators, additionalTexts, (CSharpParseOptions)parseOptions, optionsProvider, new GeneratorDriverOptions(baseDirectory: generatedFilesBaseDirectory));`
	`56`	`+ GeneratorDriver ICompilationFactoryService.CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory, string? projectName)`
	`57`	`+ => CSharpGeneratorDriver.Create(generators, additionalTexts, (CSharpParseOptions)parseOptions, optionsProvider, new GeneratorDriverOptions(baseDirectory: generatedFilesBaseDirectory, projectName: projectName));`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ internal interface ICompilationFactoryService : ILanguageService`
`15`	`15`	`Compilation CreateSubmissionCompilation(string assemblyName, CompilationOptions options, Type? hostObjectType);`
`16`	`16`	`CompilationOptions GetDefaultCompilationOptions();`
`17`	`17`	`CompilationOptions? TryParsePdbCompilationOptions(IReadOnlyDictionary<string, string> compilationOptionsMetadata);`
`18`		`- GeneratorDriver CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory);`
	`18`	`+ GeneratorDriver CreateGeneratorDriver(ParseOptions parseOptions, ImmutableArray<ISourceGenerator> generators, AnalyzerConfigOptionsProvider optionsProvider, ImmutableArray<AdditionalText> additionalTexts, string? generatedFilesBaseDirectory, string? projectName);`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -437,7 +437,8 @@ static GeneratorDriver CreateGeneratorDriver(ProjectState projectState)`
`437`	`437`	`GetSourceGenerators(projectState),`
`438`	`438`	`projectState.ProjectAnalyzerOptions.AnalyzerConfigOptionsProvider,`
`439`	`439`	`additionalTexts,`
`440`		`- generatedFilesBaseDirectory);`
	`440`	`+ generatedFilesBaseDirectory,`
	`441`	`+ $"{projectState.Name} ({projectState.Id})");`
`441`	`442`	`}`
`442`	`443`
`443`	`444`	`[Conditional("DEBUG")]`