Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

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를 이제는 거의 사용하지 않을 것이므로 이제는 그냥 역사 속으로 묻힐 시행 착오에 불과한 이야기가 되는군요. ^^




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]







[최초 등록일: ]
[최종 수정일: 10/27/2022]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




... 76  [77]  78  79  80  81  82  83  84  85  86  87  88  89  90  ...
NoWriterDateCnt.TitleFile(s)
12101정성태1/5/202024212.NET Framework: 876. C# - PEB(Process Environment Block)를 통해 로드된 모듈 목록 열람
12100정성태1/3/202021272.NET Framework: 875. .NET 3.5 이하에서 IntPtr.Add 사용
12099정성태1/3/202024399디버깅 기술: 151. Windows 10 - Process Explorer로 확인한 Handle 정보를 windbg에서 조회 [1]
12098정성태1/2/202024117.NET Framework: 874. C# - 커널 구조체의 Offset 값을 하드 코딩하지 않고 사용하는 방법 [3]
12097정성태1/2/202021508디버깅 기술: 150. windbg - Wow64, x86, x64에서의 커널 구조체(예: TEB) 구조체 확인
12096정성태12/30/201922928디버깅 기술: 149. C# - DbgEng.dll을 이용한 간단한 디버거 제작 [1]
12095정성태12/27/201925553VC++: 135. C++ - string_view의 동작 방식
12094정성태12/26/201924707.NET Framework: 873. C# - 코드를 통해 PDB 심벌 파일 다운로드 방법
12093정성태12/26/201923286.NET Framework: 872. C# - 로딩된 Native DLL의 export 함수 목록 출력파일 다운로드1
12092정성태12/25/201921097디버깅 기술: 148. cdb.exe를 이용해 (ntdll.dll 등에 정의된) 커널 구조체 출력하는 방법
12091정성태12/25/201925004디버깅 기술: 147. pdb 파일을 다운로드하기 위한 symchk.exe 실행에 필요한 최소 파일 [1]
12090정성태12/24/201924414.NET Framework: 871. .NET AnyCPU로 빌드된 PE 헤더의 로딩 전/후 차이점 [1]파일 다운로드1
12089정성태12/23/201921758디버깅 기술: 146. gflags와 _CrtIsMemoryBlock을 이용한 Heap 메모리 손상 여부 체크
12088정성태12/23/201921642Linux: 28. Linux - 윈도우의 "Run as different user" 기능을 shell에서 실행하는 방법
12087정성태12/21/201921617디버깅 기술: 145. windbg/sos - Dictionary의 entries 배열 내용을 모두 덤프하는 방법 (do_hashtable.py) [1]
12086정성태12/20/201925356디버깅 기술: 144. windbg - Marshal.FreeHGlobal에서 발생한 덤프 분석 사례
12085정성태12/20/201923648오류 유형: 586. iisreset - The data is invalid. (2147942413, 8007000d) 오류 발생 - 두 번째 이야기 [1]
12084정성태12/19/201923333디버깅 기술: 143. windbg/sos - Hashtable의 buckets 배열 내용을 모두 덤프하는 방법 (do_hashtable.py) [1]
12083정성태12/17/201925758Linux: 27. linux - lldb를 이용한 .NET Core 응용 프로그램의 메모리 덤프 분석 방법 [2]
12082정성태12/17/201924397오류 유형: 585. lsof: WARNING: can't stat() fuse.gvfsd-fuse file system
12081정성태12/16/201926974개발 환경 구성: 465. 로컬 PC에서 개발 중인 ASP.NET Core 웹 응용 프로그램을 다른 PC에서도 접근하는 방법 [5]
12080정성태12/16/201923004.NET Framework: 870. C# - 프로세스의 모든 핸들을 열람
12079정성태12/13/201925779오류 유형: 584. 원격 데스크톱(rdp) 환경에서 다중 또는 고용량 파일 복사 시 "Unspecified error" 오류 발생
12078정성태12/13/201925780Linux: 26. .NET Core 응용 프로그램을 위한 메모리 덤프 방법 [3]
12077정성태12/13/201922944Linux: 25. 자주 실행할 명령어 또는 초기 환경을 "~/.bashrc" 파일에 등록
12076정성태12/12/201923149디버깅 기술: 142. Linux - lldb 환경에서 sos 확장 명령어를 이용한 닷넷 프로세스 디버깅 - 배포 방법에 따른 차이
... 76  [77]  78  79  80  81  82  83  84  85  86  87  88  89  90  ...