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

비밀번호

댓글 작성자
 




... [76]  77  78  79  80  81  82  83  84  85  86  87  88  89  90  ...
NoWriterDateCnt.TitleFile(s)
12125정성태1/24/202020506VS.NET IDE: 141. IDE0019 - Use pattern matching
12124정성태1/23/202022174VS.NET IDE: 140. IDE1006 - Naming rule violation: These words must begin with upper case characters: ...
12123정성태1/23/202023305웹: 39. Google Analytics - gtag 함수를 이용해 페이지 URL 수정 및 별도의 이벤트 생성 방법 [2]
12122정성태1/20/202019895.NET Framework: 879. C/C++의 UNREFERENCED_PARAMETER 매크로를 C#에서 우회하는 방법(IDE0060 - Remove unused parameter '...')파일 다운로드1
12121정성태1/20/202018682VS.NET IDE: 139. Visual Studio - Error List: "Could not find schema information for the ..."파일 다운로드1
12120정성태1/19/202023273.NET Framework: 878. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 네 번째 이야기(IL 코드로 직접 구현)파일 다운로드1
12119정성태1/17/202023573디버깅 기술: 160. Windbg 확장 DLL 만들기 (3) - C#으로 만드는 방법
12118정성태1/17/202024565개발 환경 구성: 466. C# DLL에서 Win32 C/C++처럼 dllexport 함수를 제공하는 방법 - 세 번째 이야기 [1]
12117정성태1/15/202022808디버깅 기술: 159. C# - 디버깅 중인 프로세스를 강제로 다른 디버거에서 연결하는 방법파일 다운로드1
12116정성태1/15/202024151디버깅 기술: 158. Visual Studio로 디버깅 시 sos.dll 확장 명령어를 (비롯한 windbg의 다양한 기능을) 수행하는 방법
12115정성태1/14/202024321디버깅 기술: 157. C# - PEB.ProcessHeap을 이용해 디버깅 중인지 확인하는 방법파일 다운로드1
12114정성태1/13/202025068디버깅 기술: 156. C# - PDB 파일로부터 심벌(Symbol) 및 타입(Type) 정보 열거 [1]파일 다운로드3
12113정성태1/12/202025437오류 유형: 590. Visual C++ 빌드 오류 - fatal error LNK1104: cannot open file 'atls.lib' [1]
12112정성태1/12/202019389오류 유형: 589. PowerShell - 원격 Invoke-Command 실행 시 "WinRM cannot complete the operation" 오류 발생
12111정성태1/12/202023730디버깅 기술: 155. C# - KernelMemoryIO 드라이버를 이용해 실행 프로그램을 숨기는 방법(DKOM: Direct Kernel Object Modification) [16]파일 다운로드1
12110정성태1/11/202024761디버깅 기술: 154. Patch Guard로 인해 블루 스크린(BSOD)가 발생하는 사례 [5]파일 다운로드1
12109정성태1/10/202019990오류 유형: 588. Driver 프로젝트 빌드 오류 - Inf2Cat error -2: "Inf2Cat, signability test failed."
12108정성태1/10/202021188오류 유형: 587. Kernel Driver 시작 시 127(The specified procedure could not be found.) 오류 메시지 발생
12107정성태1/10/202023274.NET Framework: 877. C# - 프로세스의 모든 핸들을 열람 - 두 번째 이야기
12106정성태1/8/202022215VC++: 136. C++ - OSR Driver Loader와 같은 Legacy 커널 드라이버 설치 프로그램 제작 [1]
12105정성태1/8/202020713디버깅 기술: 153. C# - PEB를 조작해 로드된 DLL을 숨기는 방법
12104정성태1/7/202024050DDK: 9. 커널 메모리를 읽고 쓰는 NT Legacy driver와 C# 클라이언트 프로그램 [4]
12103정성태1/7/202027191DDK: 8. Visual Studio 2019 + WDK Legacy Driver 제작- Hello World 예제 [1]파일 다운로드2
12102정성태1/6/202021836디버깅 기술: 152. User 권한(Ring 3)의 프로그램에서 _ETHREAD 주소(및 커널 메모리를 읽을 수 있다면 _EPROCESS 주소) 구하는 방법
12101정성태1/5/202023929.NET Framework: 876. C# - PEB(Process Environment Block)를 통해 로드된 모듈 목록 열람
12100정성태1/3/202021094.NET Framework: 875. .NET 3.5 이하에서 IntPtr.Add 사용
... [76]  77  78  79  80  81  82  83  84  85  86  87  88  89  90  ...