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

비밀번호

댓글 작성자
 




... 181  [182]  183  184  185  186  187  188  189  190  191  192  193  194  195  ...
NoWriterDateCnt.TitleFile(s)
525정성태8/27/200726308VS.NET IDE: 54. VS.NET 2008 - 새롭게 도입되는 XSD Schema Designer
524정성태8/23/200743990오류 유형: 45. 요청한 작업은, 사용자가 매핑한 구역이 열려 있는...
523정성태8/16/200726586VS.NET IDE: 53. VS.NET 2008 - 서비스 참조 시 기존 데이터 컨테이너 DLL 사용
522정성태8/13/200730128VS.NET IDE: 52. VS.NET 2008 - WCF를 위한 디버깅 환경 개선
521정성태8/8/200729800.NET Framework: 92. XmlSerializer 생성자의 실행 속도를 올리는 방법 - 두 번째 이야기 [3]
520정성태8/7/200725252VS.NET IDE: 51. Visual Studio 2008 베타 2 설치
519정성태7/27/200731793오류 유형: 44. System.BadImageFormatException [2]
518정성태7/26/200732872오류 유형: 43. System.ComponentModel.LicenseException [1]
517정성태7/19/200720988개발 환경 구성: 26. VPC - 일반 사용자 계정으로 구동
516정성태7/19/200724239오류 유형: 42. TFS - Error loading menu: Index was outside the bounds of the array [2]
515정성태7/18/200732405오류 유형: 41. SSL 서버 자격 증명을 만드는 동안 심각한 오류가 발생했습니다.
514정성태7/14/200724828Team Foundation Server: 19. Orcas에서 개선되는 TFS 기능들
513정성태7/4/200736093.NET Framework: 91. Foreground Thread / Background Thread [1]
512정성태6/27/200725105오류 유형: 40. error PRJ0050: Failed to register output.
511정성태6/25/200733814.NET Framework: 90. XmlSerializer 생성자의 실행 속도를 올리는 방법 [2]
510정성태6/25/200749081디버깅 기술: 15. First-Chance Exception
508정성태6/21/200731706Team Foundation Server: 18. Team Build에 사용되는 각종 Property 값 [4]
507정성태6/11/200729357VS.NET IDE: 50. Orcas - UAC 설정 관련
506정성태6/9/200723980오류 유형: 39. VC Package not available or not registered
505정성태6/9/200723754오류 유형: 38. Visual SourceSafe - DB 잠김 오류
504정성태6/9/200729005오류 유형: 37. Visual SourceSafe - Anaylze 도중 비정상 종료
503정성태6/7/200731725VS.NET IDE: 49. Orcas - VC++ 다중 소스 동시 컴파일 옵션: /MP
502정성태6/7/200726609VS.NET IDE: 48. Orcas - VC++ 프로젝트 마이그레이션
500정성태6/4/200735854VS.NET IDE: 47. Orcas - Web Browser Debugger를 이용한 보호 모드의 ActiveX 컨트롤 디버깅
499정성태6/3/200728382VS.NET IDE: 46. Orcas - ComUtil로 인한 증분(/INCREMENTAL) 링크 옵션 사용 제한파일 다운로드1
498정성태5/31/200722165Windows: 26. 스마트 카드 암호 바꾸는 방법.
... 181  [182]  183  184  185  186  187  188  189  190  191  192  193  194  195  ...