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 메서드 호출만을 회피하는 정도입니다.
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]