FIX #87983 - Enable events for LogAlways

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816

[nickyMcDonald]

Repro of Issue #87983 demonstrates that when an EventListener enables events for NativeRuntimeEventSource with EventLevel.LogAlways then OnEventWritten receives no events.

With a change in src/native/eventpipe/ep-provider.c most events should fire.
With a change in src/coreclr/vm/eventtrace.cpp the rest should fire.
With a change in System.Private.CoreLib/src/System/Diagnostics/Tracing/EventPipeEventDispatcher.cs LogAlways will be treated as the highest level.

The issue was that the provider's level being LogAlways was not accounted for when enabling events and when firing them.

Test app that is helpful reproing the issue and providing useful information:

usingSystem;usingSystem.Collections.Concurrent;usingSystem.Collections.Generic;usingSystem.Diagnostics;usingSystem.Diagnostics.Tracing;usingSystem.Linq;usingSystem.Threading;Listenerlistener=Listener.Create(/* EventLevel.Informational//*/);Stopwatchstopwatch=Stopwatch.StartNew();while(stopwatch.Elapsed.TotalSeconds<5d){Thread.Sleep(Random.Shared.Next().ToString().GetHashCode()&sbyte.MaxValue);}listener.DumpEvents();internalsealedclassListener:EventListener{publicstaticEventLevelNextLevel=EventLevel.LogAlways;privatereadonlyConcurrentDictionary<string,int>Distinct=new();privateEventLevelLevel=EventLevel.LogAlways;privateListener?listener=null;publicstaticListenerCreate(paramsEventLevel[]levels){NextLevel=levels.FirstOrDefault(EventLevel.LogAlways);returnnew(){listener=(levels.Length>1)?Create(levels[1..]):null,};}publicvoidDumpEvents(){Dispose();Console.WriteLine($"\n{nameof(Level)}\t\t{Level}");Console.WriteLine($"{nameof(Distinct)}\t{Distinct.Count}");Console.WriteLine($"Total\t\t{Distinct.Values.Sum()}");foreach(KeyValuePair<string,int>einDistinct.OrderByDescending(e =>e.Value)){Console.WriteLine($"#{e.Value}\t{e.Key}");}listener?.DumpEvents();}protectedoverridevoidOnEventSourceCreated(EventSourcesource){if(source.Nameis"Microsoft-Windows-DotNETRuntime"){Level=NextLevel;EnableEvents(source,Level,EventKeywords.All);}}protectedoverridevoidOnEventWritten(EventWrittenEventArgse){stringstr=$"{e.EventId}\t{e.EventSource.Name}\t{e.EventName}";Distinct[str]=Distinct.GetValueOrDefault(str,0)+1;}}

[lateralusX]

LGTM!

[davmason]

Thanks!

[lateralusX]

Maybe we should add a CLI unit test (under src/tests/tracing) to better cover the different log levels and masks to make sure this doesn't regress? @n77y, something you would be interested in doing?

[nickyMcDonald]

@lateralusX, I can take a look.

[nickyMcDonald]

@lateralusX, #89816