C# - CLR ETW 이벤트 수신이 GCHeapStats_V1/V2에 대해 안 되는 문제
전에 쓴 글에,
C# - (.NET Core 2.2부터 가능한) 프로세스 내부에서 CLR ETW 이벤트 수신
; https://www.sysnet.pe.kr/2/0/12474
GCHeapStats_V1, GCHeapStats_V2 이벤트를,
GCHeapStats_V2 Event
; https://learn.microsoft.com/en-us/dotnet/framework/performance/garbage-collection-etw-events#gcheapstats_v2-event
받으려고 다음과 같이 소스코드를 작성했습니다.
using System;
using System.Diagnostics.Tracing;
using System.Linq;
using System.Reflection;
using System.Runtime.Versioning;
class Program
{
static MyEventListener _listener;
static Program()
{
_listener = new MyEventListener(DotnetRuntimeKeyword.GCKEYWORD,
new PrimitiveEnum[] { GCEvent.GCHeapStats_V2 });
}
static void Main(string[] args)
{
Console.WriteLine(Environment.Version);
Console.WriteLine(System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription); // .NET Core 3.0.0-preview4.19113.15
Console.WriteLine(Assembly.GetEntryAssembly().GetCustomAttribute<TargetFrameworkAttribute>().FrameworkName);
Console.WriteLine(Assembly.GetEntryAssembly().GetName().Version);
Console.WriteLine("In-proc ETW Enabled on .NET Core 2.2 or later");
while (true)
{
string result = Console.ReadLine();
GC.Collect(GC.MaxGeneration, GCCollectionMode.Forced);
}
}
}
public enum DotnetRuntimeKeyword : long
{
GCKEYWORD = 0x01,
}
public enum GCEvent
{
GCStart_V1 = 1,
GCEnd_V1 = 2,
GCHeapStats_V1 = 4,
GCHeapStats_V2 = 4, // https://learn.microsoft.com/en-us/dotnet/framework/performance/garbage-collection-etw-events#gcheapstats_v2-event
GCCreateSegment_V1 = 5,
GCFreeSegment_V1 = 6,
GCRestartEEBegin_V1 = 7,
GCRestartEEEnd_V1 = 3,
GCSuspendEE_V1 = 9,
GCSuspendEEEnd_V1 = 8,
GCAllocationTick_V2 = 10,
GCAllocationTick_V3 = 10,
GCFinalizersBegin_V1 = 14,
GCFinalizersEnd_V1 = 13,
GCCreateConcurrentThread_V1 = 11,
GCTerminateConcurrentThread_V1 = 12,
}
internal class MyEventListener : EventListener
{
// https://docs.microsoft.com/en-us/dotnet/framework/performance/clr-etw-keywords-and-levels
EventSource _eventSource;
long _filterKeyword;
int[] _filterEventId;
public MyEventListener(DotnetRuntimeKeyword filterKeyword, PrimitiveEnum[] filterEventId = null)
{
this._filterKeyword = (long)filterKeyword;
this._filterEventId = filterEventId?.Select((elem) => (int)elem).ToArray();
this.EventSourceCreated += MyEventListener_EventSourceCreated;
}
private void MyEventListener_EventSourceCreated(object sender, EventSourceCreatedEventArgs e)
{
if (e.EventSource.Name == "Microsoft-Windows-DotNETRuntime")
{
_eventSource = e.EventSource;
e.EventSource.EventCommandExecuted += EventSource_EventCommandExecuted;
EnableEvents(e.EventSource, EventLevel.Informational, (EventKeywords)this._filterKeyword);
}
}
private void EventSource_EventCommandExecuted(object sender, EventCommandEventArgs e)
{
if (e.Command == EventCommand.Enable)
{
// e.DisableEvent((int)ExceptionEvent.ExceptionThrown_V1);
// e.DisableEvent((int)ExceptionEvent.ExceptionCatchStart);
// e.DisableEvent((int)ExceptionEvent.ExceptionCatchStop);
// e.DisableEvent((int)ExceptionEvent.ExceptionFinallyStart);
// e.DisableEvent((int)ExceptionEvent.ExceptionFinallyStop);
// e.DisableEvent((int)ExceptionEvent.ExceptionFilterStart);
// e.DisableEvent((int)ExceptionEvent.ExceptionFilterStop);
// e.DisableEvent((int)ExceptionEvent.ExceptionThrownStop);
FilterEventId(_eventSource, e);
}
}
private void FilterEventId(EventSource eventSource, EventCommandEventArgs e)
{
Type type = eventSource.GetType();
FieldInfo fi = type.GetField("m_eventData", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance);
if (fi != null)
{
object objMetadataArray = fi.GetValue(eventSource); // System.Diagnostics.Tracing.EventSource.EventMetadata []
System.Collections.IEnumerable enumerator = objMetadataArray as System.Collections.IEnumerable;
foreach (object objItem in enumerator)
{
object descriptor = GetDescriptor(objItem);
if (descriptor == null)
{
continue;
}
(long keyword, int eventId) = GetKeywordAndEventId(descriptor);
if (((long)keyword & this._filterKeyword) == this._filterKeyword)
{
if (_filterEventId?.Contains(eventId) == false)
{
e.DisableEvent(eventId);
}
}
}
}
}
private (long, int) GetKeywordAndEventId(object descriptor)
{
object keyword = GetPropertyReflect(descriptor, "Keywords");
object eventValue = GetPropertyReflect(descriptor, "EventId");
if (keyword == null || eventValue == null)
{
return (0, 0);
}
return ((long)keyword, (int)eventValue);
}
private object GetDescriptor(object objItem)
{
return GetFieldReflect(objItem, "Descriptor");
}
object GetPropertyReflect(object obj, string propertyName)
{
Type type = obj.GetType();
PropertyInfo pi = type.GetProperty(propertyName, BindingFlags.Public | BindingFlags.Instance);
if (pi != null)
{
return pi.GetValue(obj);
}
return null;
}
object GetFieldReflect(object obj, string fieldName)
{
Type type = obj.GetType();
FieldInfo fi = type.GetField(fieldName, BindingFlags.Public | BindingFlags.Instance);
if (fi != null)
{
return fi.GetValue(obj);
}
return null;
}
protected override void OnEventWritten(EventWrittenEventArgs eventData)
{
if (((long)eventData.Keywords & _filterKeyword) == _filterKeyword)
{
if (eventData.EventId == (int)GCEvent.GCHeapStats_V2)
{
Console.WriteLine($"{DateTime.Now}: {eventData.EventName}, {eventData.EventId}");
}
}
}
}
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
위의 경우에는 테스트가 잘 되었는데, 이상하게도 저 MyEventListener 클래스를 .NET Core 2.2 + ASP.NET Core Web Application 환경에서 돌리면 그때부터 GCHeapStats_V2 이벤트가 수신되지 않습니다.
이거저거 살펴본 결과 ^^; (ASP.NET의 경우 설정 파일에 명시하고 있는) 서버 유형의 GC 모드가 동작하는 환경에서는 그런 문제가 발생했습니다. 그래서 위의 예제 코드에 "
runtimeconfig.template.json" 파일을 추가해 다음과 같은 설정을 추가하면,
{
"configProperties": {
"System.GC.Server": true
}
}
그 후부터 .NET Core 2.2 런타임에서는 동일한 현상이 재현됩니다. 재미있는 것은, .NET Core 3.0부터는 정상적으로 이벤트가 수신됩니다.
사실 .NET Core 2.2를 이제는 거의 사용하지 않을 것이므로 이제는 그냥 역사 속으로 묻힐 시행 착오에 불과한 이야기가 되는군요. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]