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)
10830정성태8/12/201525460개발 환경 구성: 275. Web.config이 적용되지 않는 프로젝트에서 Razor 템플릿 파일의 C# 컴파일러 버전 제어 [1]
10829정성태8/10/201527576개발 환경 구성: 274. PowerShell/명령행에서 JDK/JRE를 무인(unattended)/자동 설치를 하는 방법 [3]
10828정성태8/10/201533032웹: 30. Edge 브라우저에서 "이 웹 사이트에는 Internet Explorer가 필요함" 단계를 없애는 방법 [1]
10827정성태7/8/201533866개발 환경 구성: 273. Visual Studio 2015에서 Github와 연동하는 방법 [3]
10826정성태7/8/201524218오류 유형: 301. The trust relationship between this workstation and the primary domain failed. - 두 번째 이야기
10825정성태7/8/201522902개발 환경 구성: 272. Visual Studio IDE 설치 없이 Visual Studio SDK 설치하는 방법
10824정성태7/7/201528531개발 환경 구성: 271. Team Foundation Server 2015 설치 방법 [1]
10823정성태7/7/201529299오류 유형: 300. SqlException (0x80131904): Unable to open the physical file
10822정성태7/7/201528141오류 유형: 299. The 'Visual C++ Project System Package' package did not load correctly.
10821정성태7/7/201521195오류 유형: 298. Unable to start debugging on the web server. IIS does not list a web site that matches the launched URL.
10820정성태7/7/201526924오류 유형: 297. HTTP Error 503. The service is unavailable. - 두 번째
10819정성태7/2/201530079오류 유형: 296. SQL Server Express 시작 오류 - error code 3417
10818정성태7/1/201529247오류 유형: 295. HTTP Error 503. The service is unavailable. [1]
10817정성태6/29/201533200.NET Framework: 523. C# 람다(Lambda)에서 변수 캡처 방식 [3]
10816정성태6/25/201528983.NET Framework: 522. 닷넷의 어셈블리 서명 데이터 확인 방법파일 다운로드1
10815정성태6/23/201527406Graphics: 1. 자네 나와 함께... UNITY 하지 않겠는가! [4]
10814정성태6/22/201525139.NET Framework: 521. Roslyn을 이용해 C# 문법 변형하기 (2) [5]
10813정성태6/21/201526245.NET Framework: 520. Roslyn을 이용해 C# 문법 변형하기 (1)
10812정성태6/20/201527136.NET Framework: 519. C# 6.0 오픈 소스 컴파일러 Roslyn - 빌드 및 테스트 방법 [1]
10811정성태6/20/201524231오류 유형: 294. OpenAuth 사용 시 System.Data.SqlClient.SqlException 예외가 Output 창에 출력되는 문제
10810정성태6/18/201523724개발 환경 구성: 270. Visual Studio에서 github 오픈 소스를 fork해서 테스트하는 방법 [1]
10809정성태6/18/201521481.NET Framework: 518. AllowPartiallyTrustedCallers 특성이 적용된 GAC 어셈블리에서 DynamicMethod의 calli 명령어 사용파일 다운로드1
10808정성태6/17/201523537.NET Framework: 517. calli IL 호출이 DllImport 호출보다 빠를까요? [1]파일 다운로드1
10807정성태6/16/201524989.NET Framework: 516. Microsoft.AspNet.Membership.OpenAuth 사용 시 "Local Database Runtime error occurred" 오류
10806정성태6/16/201542350.NET Framework: 515. OpenAuth.VerifyAuthentication 호출 시 The remote server returned an error: (400) Bad Request
10805정성태6/15/201524153Java: 17. 자바의 재미있는 상수 처리 방식
... 121  122  123  124  [125]  126  127  128  129  130  131  132  133  134  135  ...