.NET의 EventCounters
이 문서의 적용 대상: ✔️ .NET Core 3.0 SDK 이상 버전
EventCounters는 경량, 플랫폼 간 및 근 실시간 성능 메트릭 컬렉션에 사용되는 .NET API입니다. EventCounters는 Windows에서 .NET Framework의 “성능 카운터”에 대한 교차 플랫폼 대체 항목으로 추가되었습니다. 이 문서에서는 EventCounters의 정의, 구현 방법 및 사용 방법에 대해 알아봅니다.
.NET 런타임 및 일부 .NET 라이브러리는 .NET Core 3.0부터 EventCounters를 사용하여 기본 진단 정보를 게시합니다. .NET 런타임에서 제공하는 EventCounters 외에도 고유한 EventCounters를 구현하도록 선택할 수 있습니다. EventCounters를 사용하여 다양한 메트릭을 추적할 수 있습니다. .NET의 잘 알려진 EventCounters에서 자세히 알아보세요.
EventCounters는 EventSource의 일부로 사용되며, 주기적으로 수신기 도구에 자동으로 푸시됩니다. EventSource의 다른 모든 이벤트와 마찬가지로 EventListener 및 EventPipe를 통해 in-proc 및 out-of-proc에서 사용할 수 있습니다. 이 문서에서는 EventCounters의 교차 플랫폼 기능을 중점적으로 설명하며, PerfView 및 ETW(Windows용 이벤트 추적)를 둘 다 EventCounters와 함께 사용할 수 있지만 여기서는 의도적으로 다루지 않습니다.
EventCounter API 개요
EventCounters에는 두 가지 기본 범주가 있습니다. 일부는 총 예외 수, 총 GC 수, 총 요청 수 등의 “비율” 값에 대한 카운터입니다. 힙 사용량, CPU 사용량, 작업 세트 크기 등의 “스냅샷” 값에 대한 카운터도 있습니다. 이러한 각 카운터 범주 내에는 값을 가져오는 방법에 따라 두 가지 유형의 카운터가 있습니다. 폴링 카운터는 콜백을 통해 해당 값을 검색하고 비폴링 카운터는 카운터 인스턴스에서 직접 해당 값을 설정합니다.
카운터는 다음 구현으로 표시됩니다.
이벤트 수신기는 측정 간격의 길이를 지정합니다. 각 간격의 끝에서 각 카운터에 대한 수신기로 값이 전송됩니다. 카운터의 구현에 따라 각 간격 값을 생성하는 데 사용되는 API 및 계산이 결정됩니다.
EventCounter는 값 세트를 기록합니다. EventCounter.WriteMetric 메서드는 세트에 새 값을 추가합니다. 간격마다 min, max 및 mean과 같은 세트에 대한 통계 요약이 계산됩니다. dotnet-counters 도구는 항상 평균 값을 표시합니다. EventCounter는 불연속 작업 세트를 설명하는 데 유용합니다. 일반적인 사용에는 최근 IO 작업의 평균 크기(바이트) 또는 재무 트랜잭션 세트의 평균 통화 값 모니터링이 포함될 수 있습니다.
IncrementingEventCounter는 각 시간 간격의 누계를 기록합니다. IncrementingEventCounter.Increment 메서드는 더하여 합계를 구합니다. 예를 들어 값
1,2및5를 사용하여 하나의 간격 동안Increment()를 세 번 호출하는 경우8의 누계는 이 간격의 카운터 값으로 보고됩니다. dotnet-counters 도구는 이 비율을 기록된 합계/시간으로 표시합니다. IncrementingEventCounter는 초당 처리된 요청 수와 같이 작업이 발생하는 빈도를 측정하는 데 유용합니다.PollingCounter는 콜백을 사용하여 보고되는 값을 확인합니다. 시간 간격마다 사용자가 제공한 콜백 함수가 호출되고 반환 값이 카운터 값으로 사용됩니다. PollingCounter를 사용하여 외부 소스에서 메트릭을 쿼리할 수 있습니다. 예를 들어 디스크의 현재 사용 가능한 바이트를 가져올 수 있습니다. 애플리케이션에서 요청 시에 계산될 수 있는 사용자 지정 통계를 보고하는 데도 사용할 수 있습니다. 최근 요청 대기 시간의 95번째 백분위 수, 캐시의 현재 적중 또는 누락 비율을 보고하는 경우를 예로 들 수 있습니다.
IncrementingPollingCounter는 콜백을 사용하여 보고된 증분 값을 결정합니다. 시간 간격마다 콜백이 호출된 다음, 현재 호출과 마지막 호출 간의 차이가 보고됩니다. dotnet-counters 도구는 항상 차이를 보고된 값/시간 비율로 표시합니다. 이 카운터는 발생할 때마다 API를 호출하는 것이 불가능하지만 총 발생 횟수를 쿼리할 수 있는 경우에 유용합니다. 예를 들어 바이트를 쓸 때마다 알림이 표시되지 않더라도 초당 파일에 쓴 바이트 수를 보고할 수 있습니다.
EventSource 구현
다음 코드에서는 명명된 "Sample.EventCounter.Minimal" 공급자로 노출되는 샘플 EventSource를 구현합니다. 이 소스에는 요청 처리 시간을 나타내는 EventCounter가 포함되어 있습니다. 이러한 카운터에는 이름(즉, 원본의 고유 ID)과 표시 이름이 있으며 둘 다 dotnet-counters와 같은 수신기 도구에서 사용됩니다.
using System.Diagnostics.Tracing;
[EventSource(Name = "Sample.EventCounter.Minimal")]
public sealed class MinimalEventCounterSource : EventSource
{
public static readonly MinimalEventCounterSource Log = new MinimalEventCounterSource();
private EventCounter _requestCounter;
private MinimalEventCounterSource() =>
_requestCounter = new EventCounter("request-time", this)
{
DisplayName = "Request Processing Time",
DisplayUnits = "ms"
};
public void Request(string url, long elapsedMilliseconds)
{
WriteEvent(1, url, elapsedMilliseconds);
_requestCounter?.WriteMetric(elapsedMilliseconds);
}
protected override void Dispose(bool disposing)
{
_requestCounter?.Dispose();
_requestCounter = null;
base.Dispose(disposing);
}
}
dotnet-counters ps를 사용하여 모니터링할 수 있는 .NET 프로세스의 목록을 표시합니다.
dotnet-counters ps
1398652 dotnet C:\Program Files\dotnet\dotnet.exe
1399072 dotnet C:\Program Files\dotnet\dotnet.exe
1399112 dotnet C:\Program Files\dotnet\dotnet.exe
1401880 dotnet C:\Program Files\dotnet\dotnet.exe
1400180 sample-counters C:\sample-counters\bin\Debug\netcoreapp3.1\sample-counters.exe
EventSource 이름을 --counters 옵션에 전달하여 카운터 모니터링을 시작합니다.
dotnet-counters monitor --process-id 1400180 --counters Sample.EventCounter.Minimal
다음 예제에서는 모니터 출력을 보여 줍니다.
Press p to pause, r to resume, q to quit.
Status: Running
[Samples-EventCounterDemos-Minimal]
Request Processing Time (ms) 0.445
q를 눌러 모니터링 명령을 중지합니다.
조건부 카운터
EventSource를 구현할 때 EventCommand.Enable의 Command 값을 사용하여 EventSource.OnEventCommand 메서드가 호출되는 경우 포함하는 카운터를 조건부로 인스턴스화할 수 있습니다. null인 경우에만 카운터 인스턴스를 안전하게 인스턴스화하려면 null 병합 대입 연산자를 사용합니다. 또한 사용자 지정 메서드는 IsEnabled 메서드를 평가하여 현재 이벤트 소스를 사용할 수 있는지를 확인할 수 있습니다.
using System.Diagnostics.Tracing;
[EventSource(Name = "Sample.EventCounter.Conditional")]
public sealed class ConditionalEventCounterSource : EventSource
{
public static readonly ConditionalEventCounterSource Log = new ConditionalEventCounterSource();
private EventCounter _requestCounter;
private ConditionalEventCounterSource() { }
protected override void OnEventCommand(EventCommandEventArgs args)
{
if (args.Command == EventCommand.Enable)
{
_requestCounter ??= new EventCounter("request-time", this)
{
DisplayName = "Request Processing Time",
DisplayUnits = "ms"
};
}
}
public void Request(string url, float elapsedMilliseconds)
{
if (IsEnabled())
{
_requestCounter?.WriteMetric(elapsedMilliseconds);
}
}
protected override void Dispose(bool disposing)
{
_requestCounter?.Dispose();
_requestCounter = null;
base.Dispose(disposing);
}
}
팁
조건부 카운터는 조건부로 인스턴스화되는 마이크로 최적화에 해당하는 카운터입니다. 런타임에서는 카운터가 일반적으로 사용되지 않는 시나리오에 대해 이 패턴을 사용하여 시간(밀리초)을 절약합니다.
.NET Core 런타임 예제 카운터
.NET Core 런타임에는 많은 유용한 예제 구현이 있습니다. 다음은 애플리케이션의 작업 세트 크기를 추적하는 카운터에 대한 런타임 구현입니다.
var workingSetCounter = new PollingCounter(
"working-set",
this,
() => (double)(Environment.WorkingSet / 1_000_000))
{
DisplayName = "Working Set",
DisplayUnits = "MB"
};
PollingCounter는 특정 시점에 메트릭을 캡처하기 때문에 앱의 프로세스(작업 세트)에 매핑되는 실제 메모리의 현재 크기를 보고합니다. 값 폴링에 대한 콜백은 제공된 람다 식으로, System.Environment.WorkingSet API에 대한 호출에 불과합니다. DisplayName 및 DisplayUnits는 카운터의 소비자 쪽에서 값을 보다 명확하게 표시하는 데 도움이 되도록 설정할 수 있는 선택적 속성입니다. 예를 들어 dotnet-counters는 이러한 속성을 사용하여 좀 더 친숙한 카운터 이름 버전을 표시합니다.
중요
DisplayName 속성은 지역화되지 않습니다.
PollingCounter 및 IncrementingPollingCounter의 경우 다른 작업을 수행할 필요가 없습니다. 소비자가 요청한 간격으로 값 자체를 폴링합니다.
IncrementingPollingCounter를 사용하여 구현된 런타임 카운터의 예제는 다음과 같습니다.
var monitorContentionCounter = new IncrementingPollingCounter(
"monitor-lock-contention-count",
this,
() => Monitor.LockContentionCount
)
{
DisplayName = "Monitor Lock Contention Count",
DisplayRateTimeScale = TimeSpan.FromSeconds(1)
};
IncrementingPollingCounter는 Monitor.LockContentionCount API를 사용하여 총 잠금 경합 수의 증분을 보고합니다. DisplayRateTimeScale 속성은 선택 사항이지만 이 속성을 사용하면 카운터가 가장 잘 표시되는 시간 간격에 대한 힌트를 제공할 수 있습니다. 예를 들어 잠금 경합 횟수는 ‘초당 횟수’로 가장 잘 표시되므로 DisplayRateTimeScale은 1초로 설정됩니다. 표시 비율은 다른 유형의 비율 카운터에 맞게 조정될 수 있습니다.
참고
DisplayRateTimeScale은 dotnet-counters에서 사용되지 ‘않으며’ 이를 사용하는 데 이벤트 수신기가 필요하지 않습니다.
.NET 런타임 리포지토리에 참조로 사용할 수 있는 더 많은 카운터 구현이 있습니다.
동시성
팁
EventCounters API는 스레드 보안을 보장하지 않습니다. PollingCounter 또는 IncrementingPollingCounter 인스턴스에 전달된 대리자가 여러 스레드에서 호출되는 경우 대리자가 스레드로부터 안전한지 보장하는 것은 사용자의 책임입니다.
예를 들어 다음 EventSource를 사용하여 요청을 추적하는 것이 좋습니다.
using System;
using System.Diagnostics.Tracing;
public class RequestEventSource : EventSource
{
public static readonly RequestEventSource Log = new RequestEventSource();
private IncrementingPollingCounter _requestRateCounter;
private long _requestCount = 0;
private RequestEventSource() =>
_requestRateCounter = new IncrementingPollingCounter("request-rate", this, () => _requestCount)
{
DisplayName = "Request Rate",
DisplayRateTimeScale = TimeSpan.FromSeconds(1)
};
public void AddRequest() => ++ _requestCount;
protected override void Dispose(bool disposing)
{
_requestRateCounter?.Dispose();
_requestRateCounter = null;
base.Dispose(disposing);
}
}
AddRequest() 메서드는 요청 처리기에서 호출될 수 있으며, RequestRateCounter는 카운터 소비자가 지정한 간격에 따라 값을 폴링합니다. 그러나 한 번에 여러 스레드에서 AddRequest() 메서드를 호출하여 _requestCount가 경합 상태가 될 수 있습니다. 스레드로부터 안전하게 _requestCount를 증분하는 방법은 Interlocked.Increment를 사용하는 것입니다.
public void AddRequest() => Interlocked.Increment(ref _requestCount);
long 필드 _requestCount의 읽기 중단(32비트 아키텍처)을 방지하려면 Interlocked.Read을 사용합니다.
_requestRateCounter = new IncrementingPollingCounter("request-rate", this, () => Interlocked.Read(ref _requestCount))
{
DisplayName = "Request Rate",
DisplayRateTimeScale = TimeSpan.FromSeconds(1)
};
EventCounters 사용
EventCounters를 사용하는 두 가지 기본 방법은 in-proc 및 out-of-proc입니다. EventCounters의 사용은 세 가지 계층의 다양한 사용 기술로 구분할 수 있습니다.
ETW 또는 EventPipe를 통해 원시 스트림에서 이벤트 전송:
ETW API는 Windows OS와 함께 제공되며 EventPipe는 .NET API 또는 진단 IPC 프로토콜로서 액세스할 수 있습니다.
이진 이벤트 스트림을 이벤트로 디코드:
TraceEvent 라이브러리는 ETW 및 EventPipe 스트림 형식을 둘 다 처리합니다.
명령줄 및 GUI 도구:
PerfView(ETW 또는 EventPipe), dotnet-counters(EventPipe 전용) 및 dotnet-monitor(EventPipe 전용)와 같은 도구
out-of-proc 사용
out-of-proc에서 EventCounters를 사용하는 것은 일반적인 방식입니다. dotnet-counters를 사용하여 EventPipe를 통해 플랫폼 간 방식으로 사용할 수 있습니다. dotnet-counters 도구는 카운터 값을 모니터링하는 데 사용할 수 있는 플랫폼 간 dotnet CLI 전역 도구입니다. dotnet-counters를 사용하여 카운터를 모니터링하는 방법을 알아보려면 dotnet-counters를 참조하거나 EventCounters를 사용하여 성능 측정 자습서를 참조하세요.
dotnet-trace
dotnet-trace 도구는 EventPipe를 통해 카운터 데이터를 사용하는 데 사용할 수 있습니다. 다음은 dotnet-trace를 사용하여 카운터 데이터를 수집 하는 예제입니다.
dotnet-trace collect --process-id <pid> Sample.EventCounter.Minimal:0:0:EventCounterIntervalSec=1
시간 경과에 따른 카운터 값 수집 방법에 대한 자세한 내용은 dotnet-trace 설명서를 참조하세요.
Azure Application Insights
EventCounters는 Azure Monitor에서, 특히 Azure Application Insights에서 사용할 수 있습니다. 카운터를 추가 및 제거할 수 있으며 사용자 지정 카운터 또는 잘 알려진 카운터를 자유롭게 지정할 수 있습니다. 자세한 내용은 수집할 카운터 사용자 지정을 참조하세요.
dotnet-monitor
dotnet-monitor 도구를 사용하면 원격 및 자동화된 방식으로 .NET 프로세스에서 진단에 더 쉽게 액세스할 수 있습니다. 추적 외에도, 메트릭을 모니터링하고 메모리 덤프를 수집하고 GC 덤프를 수집할 수 있습니다. CLI 도구와 Docker 이미지 둘 다로 배포됩니다. 해당 도구가 REST API를 노출하면 진단 아티팩트의 컬렉션이 REST 호출을 통해 발생합니다.
자세한 내용은 dotnet-monitor를 참조하세요.
In-proc에서 사용
EventListener API를 통해 카운터 값을 사용할 수 있습니다. EventListener는 애플리케이션의 모든 EventSource 인스턴스에서 작성된 모든 이벤트를 사용하는 in-proc 방법입니다. EventListener API를 사용하는 방법에 대한 자세한 내용은 EventListener를 참조하세요.
먼저 카운터 값을 생성하는 EventSource를 사용하도록 설정해야 합니다. EventSource가 생성될 때 알림을 받을 수 있도록 EventListener.OnEventSourceCreated 메서드를 재정의합니다. 이것이 EventCounters에서 올바른 EventSource인 경우 EventListener.EnableEvents을 호출할 수 있습니다. 다음은 재정의 예입니다.
protected override void OnEventSourceCreated(EventSource source)
{
if (!source.Name.Equals("System.Runtime"))
{
return;
}
EnableEvents(source, EventLevel.Verbose, EventKeywords.All, new Dictionary<string, string>()
{
["EventCounterIntervalSec"] = "1"
});
}
예제 코드
다음은 매초마다 내부 카운터(System.Runtime)를 게시하기 위해 .NET 런타임의 EventSource에서 모든 카운터 이름 및 값을 출력하는 샘플 EventListener 클래스입니다.
using System;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
public class SimpleEventListener : EventListener
{
public SimpleEventListener()
{
}
protected override void OnEventSourceCreated(EventSource source)
{
if (!source.Name.Equals("System.Runtime"))
{
return;
}
EnableEvents(source, EventLevel.Verbose, EventKeywords.All, new Dictionary<string, string>()
{
["EventCounterIntervalSec"] = "1"
});
}
protected override void OnEventWritten(EventWrittenEventArgs eventData)
{
if (!eventData.EventName.Equals("EventCounters"))
{
return;
}
for (int i = 0; i < eventData.Payload.Count; ++ i)
{
if (eventData.Payload[i] is IDictionary<string, object> eventPayload)
{
var (counterName, counterValue) = GetRelevantMetric(eventPayload);
Console.WriteLine($"{counterName} : {counterValue}");
}
}
}
private static (string counterName, string counterValue) GetRelevantMetric(
IDictionary<string, object> eventPayload)
{
var counterName = "";
var counterValue = "";
if (eventPayload.TryGetValue("DisplayName", out object displayValue))
{
counterName = displayValue.ToString();
}
if (eventPayload.TryGetValue("Mean", out object value) ||
eventPayload.TryGetValue("Increment", out value))
{
counterValue = value.ToString();
}
return (counterName, counterValue);
}
}
위와 같이 EnableEvents를 호출할 때 filterPayload 인수에 "EventCounterIntervalSec" 인수가 설정되어 있는지 ‘반드시’ 확인해야 합니다. 그러지 않으면 카운터는 플러시 간격을 알 수 없으므로 값을 플러시할 수 없습니다.
참조
.NET
피드백
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요. https://aka.ms/ContentUserFeedback
다음에 대한 사용자 의견 제출 및 보기