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

C# - ETW EventListener의 Keywords별 EventId에 따른 필터링 방법

지난 글에서 EventListener를 상속한 클래스의 생성자에 인자를 전달해 EnableEvents까지 호출하는 방법을 설명했습니다.

C# - ETW EventListener를 상속받았을 때 초기화 순서
; https://www.sysnet.pe.kr/2/0/12616

EventListener.EnableEvents는 ETW의 Keywords 범주를 지정해 관심 있는 이벤트를 선택하는 방법을 제공하는데요, 아쉽게도 Keywords에 속한 개별 EventId에 따른 필터링은 제공하지 않습니다.

여기서 재미있는 점은, EventId에 따른 Enable/Disable을 특이하게도 EventCommandEventArgs 타입에서 제공하긴 한다는 것입니다. 그리고 그 타입은 오직 EventSource.EventCommandExecuted 이벤트의 인자로만 얻을 수 있습니다. 따라서 전체적인 코딩 방식은 다음과 같은 과정을 거치게 됩니다.

using System;
using System.Diagnostics.Tracing;
using System.Linq;
using System.Reflection;

class Program
{
    static MyEventListener _listener;

    static Program()
    {
        _listener = new MyEventListener(DotnetRuntimeKeyword.EXCEPTIONKEYWORD);
    }

    // ...[생략]...
}

public enum DotnetRuntimeKeyword : long
{
    GCKEYWORD = 0x01,
    EXCEPTIONKEYWORD = 0x00008000
}

internal class MyEventListener : EventListener
{
    EventSource _eventSource;
    long _filterKeyword;

    public MyEventListener(DotnetRuntimeKeyword filterKeyword)
    {
        this._filterKeyword = (long)filterKeyword;
        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)
    {
        // ExceptionCatchStart 유형의 이벤트만 발생하도록 필터링 처리
        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);
        }
    }

    protected override void OnEventWritten(EventWrittenEventArgs eventData)
    {
        if (((long)eventData.Keywords & _filterKeyword) == _filterKeyword)
        {
            Console.WriteLine($"{DateTime.Now}: {eventData.EventName}");
        }
    }
}

public enum ExceptionEvent
{
    ExceptionThrown_V1 = 80,
    ExceptionCatchStart = 250,
    ExceptionCatchStop = 251,
    ExceptionFinallyStart = 252,
    ExceptionFinallyStop = 253,
    ExceptionFilterStart = 254,
    ExceptionFilterStop = 255,
    ExceptionThrownStop = 256,
}

이렇게 만든 MyEventListener와 함께 다음의 Main 메서드를 실행하면,

static void Main(string[] args)
{
    Console.WriteLine(Environment.Version);
    Console.WriteLine("In-proc ETW Enabled on .NET Core 2.2 or later");

    while (true)
    {
        Console.ReadLine();

        try
        {
            throw new ApplicationException("Exception-thrown");
        }
        catch (Exception)
        {
            Console.WriteLine($"{DateTime.Now}: User-exception");
        }
    }
}

이제부터는 ExceptionCatchStart에 대한 OnEventWritten만 실행되는 것을 확인할 수 있습니다.




자, 그럼 여기에 EventId 목록을 알아내는 지난번 소스 코드를,

C# - ETW 이벤트의 Keywords에 속한 EventId 구하는 방법 (2) 관리 코드
; https://www.sysnet.pe.kr/2/0/12613

곁들여서, 내가 관심 있는 이벤트만 생성자에 전달해 OnEventWritten 콜백을 받을 수 있게 만들 수 있습니다.

using System;
using System.Diagnostics.Tracing;
using System.Linq;
using System.Reflection;

class Program
{
    static MyEventListener _listener;

    static Program()
    {
        _listener = new MyEventListener(DotnetRuntimeKeyword.EXCEPTIONKEYWORD,
            new PrimitiveEnum[] { ExceptionEvent.ExceptionCatchStart, ExceptionEvent.ExceptionCatchStop });
    }

    // ...[생략]...
}

// ...[생략]...

internal class MyEventListener : EventListener
{
    // https://learn.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)
        {
            FilterEventId(_eventSource, e);
        }
    }

    private void FilterEventId(EventSource eventSource, EventCommandEventArgs e)
    {
        // ...[생략]...

        (long keyword, int eventId) = GetKeywordAndEventId(descriptor);

        if (((long)keyword & this._filterKeyword) == this._filterKeyword)
        {
            if (_filterEventId != null)
            {
                if (_filterEventId.Contains(eventId) == false)
                {
                    e.DisableEvent(eventId);
                }
            }
        }
    }

    // ...[생략]...

    protected override void OnEventWritten(EventWrittenEventArgs eventData)
    {
        if (((long)eventData.Keywords & _filterKeyword) == _filterKeyword)
        {
            Console.WriteLine($"{DateTime.Now}: {eventData.EventName}");
        }
    }
}

실행해 보면, { ExceptionEvent.ExceptionCatchStart, ExceptionEvent.ExceptionCatchStop } 2개의 이벤트만 받겠다고 지정했으므로 다른 Exception 관련 이벤트는 발생하지 않게 됩니다.

하지만 Keyword 수준의 필터링과는 달리 EventId의 필터링으로 인한 콜백 메서드의 최소화는 의미 있는 수준의 성능을 내지는 않습니다. 왜냐하면, EventId의 필터링이 되기까지 이미 꽤나 많은 ETW 관련 코드들이 수행되기 때문으로 단지 OnEventWritten 메서드 호출만을 회피하는 정도입니다.

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




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







[최초 등록일: ]
[최종 수정일: 11/7/2023]

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

비밀번호

댓글 작성자
 




... 121  122  123  124  125  126  [127]  128  129  130  131  132  133  134  135  ...
NoWriterDateCnt.TitleFile(s)
2913정성태4/30/201527605.NET Framework: 511. Build 2015 행사에서 소개된 (맥/리눅스/윈도우 용 무료) Visual Studio Code 개발 도구 [8]
2912정성태4/29/201523285오류 유형: 286. VirtualBox에 Windows 8/2012 설치 시 "Error Code: 0x000000C4" 오류 발생
2911정성태4/29/201521838오류 유형: 285. Visual Studio 2015를 제거한 경우 Microsoft.VisualStudio.Web.PageInspector.Loader 어셈블리를 못 찾는 문제 [2]
2910정성태4/29/201525697오류 유형: 284. System.TypeLoadException: Could not load type 'System.Reflection.AssemblySignatureKeyAttribute' from assembly [1]
2909정성태4/29/201521868오류 유형: 283. WCF 연결 오류 - Expected record type 'PreambleAck'
2908정성태4/29/201530108오류 유형: 282. 원격에서 SQL 서버는 연결되지만, SQL Express는 연결되지 않는 경우
2907정성태4/29/201520293.NET Framework: 510. 제네릭(Generic) 인자에 대한 메타데이터 등록 확인
2906정성태4/28/201522815오류 유형: 281. DebugView로 인한 System.Diagnostics.Trace.WriteLine 멈춤(Hang) 현상
2905정성태4/27/201523330오류 유형: 280. HttpResponse.Headers.Add에서 "System.PlatformNotSupportedException: This operation requires IIS integrated pipeline mode." 예외 발생
2904정성태4/27/201528224DDK: 6. ZwTerminateProcess로 프로세스를 종료하는 Device Driver 프로그램 [2]파일 다운로드1
2903정성태4/20/201521881Windows: 110. (무료) 마이크로소프트 온라인 강좌 소개 - Azure에서 제공하는 계정 관리 서비스
2902정성태4/16/201527823Windows: 109. (무료) 마이크로소프트 온라인 강좌 소개 - Active Directory 이해
2901정성태4/15/201524433Windows: 108. (무료) 마이크로소프트 온라인 강좌 소개 - Windows Server 2012 R2 주요 기술 (Hyper-V 관점)
2900정성태3/24/201523536오류 유형: 279. robocopy 오류 - The file cannot be accessed by the system [4]
2899정성태3/24/201531590개발 환경 구성: 264. Visual Studio 2013 솔루션을 2015로 마이그레이션
2898정성태3/24/201522307개발 환경 구성: 263. SharePoint 2013을 Windows Server 2012 R2에 설치
2897정성태3/18/201520905오류 유형: 278. LoadLibrary("...") failed - Invalid access to memory location.
2896정성태3/18/201520932VC++: 90. Visual Studio 2013에서 Visual Basic 6용 ATL Control 제작
2895정성태3/18/201524205VC++: 89. Visual Studio 2015 - auto 반환 타입 및 thread_local 예약어 지원(C++ 11 표준) [2]
2894정성태3/18/201521990.NET Framework: 509. ELEMENT_TYPE_MODIFIER의 조합
2893정성태3/18/201522719오류 유형: 277. command line error MIDL1004: cannot execute C preprocessor cl.exe
2892정성태3/17/201527609오류 유형: 276. robocopy - Logon failure: unknown user name or bad password.
2891정성태3/17/201543655개발 환경 구성: 262. Visual Basic 6 (Enterprise Edition)을 Windows 7 x86에 설치하는 방법 [1]
2890정성태3/17/201525513오류 유형: 275. Internet Explorer - This page can't be displayed
2889정성태3/17/201526691Windows: 107. (2015-03-12) 업데이트 이후 작업 표시줄 또는 탐색기의 반응이 느려지는 문제 [1]
2888정성태3/17/201524523.NET Framework: 508. Visual Studio 빌드 - fatal error C1033: cannot open program database ''
... 121  122  123  124  125  126  [127]  128  129  130  131  132  133  134  135  ...