wbudowane metryki ASP.NET Core

W tym artykule opisano wbudowane metryki dla platformy ASP.NET Core utworzone przy użyciu interfejsu System.Diagnostics.Metrics API. Aby uzyskać listę metryk na podstawie starszego interfejsu API EventCounters , zobacz Dostępne liczniki.

Aby uzyskać informacje na temat zbierania, raportowania, wzbogacania i testowania za pomocą metryk ASP.NET Core, zobacz ASP.NET Core metrics (Metryki podstawowe ASP.NET).

Metryka: http.server.request.duration

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
http.server.request.duration	Histogram	s	Mierzy czas trwania przychodzących żądań HTTP.

Atrybut	Typ	Opis	Przykłady	Obecność
http.route	sznurek	Dopasowana trasa.	{controller}/{action}/ {id?}	Jeśli jest dostępna.
error.type	sznurek	Opisuje klasę błędów zakończoną operacją.	timeout; name_resolution_error; 500	Jeśli żądanie zakończyło się błędem.
http.request.method	sznurek	Metoda żądania HTTP.	GET; POST; HEAD	Zawsze
http.response.status_code	Int	kod stanu odpowiedzi HTTP.	200	Jeśli został wysłany.
network.protocol.version	sznurek	Wersja protokołu określonego w pliku network.protocol.name.	3.1.1	Zawsze
url.scheme	sznurek	Schemat identyfikatora URI składnik identyfikujący używany protokół.	http; https	Zawsze
aspnetcore.request.is_unhandled	Boolowski	Wartość true, gdy żądanie nie zostało obsłużone przez potok aplikacji.	true	Jeśli żądanie nie zostało nieobsługiwane.

Czas używany do obsługi przychodzącego żądania HTTP mierzony w warstwie hostingu ASP.NET Core. Pomiar czasu rozpoczyna się po utworzeniu bazowego hosta internetowego:

• Wystarczająco przeanalizowano nagłówki żądań HTTP w strumieniu sieci przychodzącej, aby zidentyfikować nowe żądanie.
• Zainicjowano struktury danych kontekstu, takie jak HttpContext.

Czas kończy się, gdy:

• Potok obsługi ASP.NET Core jest wykonywany.
• Wszystkie dane odpowiedzi zostały wysłane.
• Struktury danych kontekstowych dla żądania są usuwane.

W przypadku korzystania z biblioteki OpenTelemetry domyślne zasobniki dla tej metryki są ustawione na [ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ].

Metryka: http.server.active_requests

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
http.server.active_requests	UpDownCounter	{request}	Mierzy liczbę współbieżnych żądań HTTP, które są obecnie w locie.

Atrybut	Typ	Opis	Przykłady	Obecność
http.request.method	sznurek	Metoda żądania HTTP. [1]	GET; POST; HEAD	Zawsze
url.scheme	sznurek	Schemat identyfikatora URI składnik identyfikujący używany protokół.	http; https	Zawsze

Microsoft.AspNetCore.Routing

Informacje Microsoft.AspNetCore.Routing o metrykach dotyczące routingu żądań HTTP do punktów końcowych ASP.NET Core:

• aspnetcore.routing.match_attempts

Metryka: aspnetcore.routing.match_attempts

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.routing.match_attempts	Licznik	{match_attempt}	Liczba żądań, które próbowano dopasować do punktu końcowego.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.routing.match_status	sznurek	Dopasuj wynik	success; failure	Zawsze
aspnetcore.routing.is_fallback_route	typ logiczny (boolowski)	Wartość wskazująca, czy dopasowana trasa jest trasą rezerwową.	True	Jeśli trasa została pomyślnie dopasowana.
http.route	sznurek	Dopasowana trasa	{controller}/{action}/ {id?}	Jeśli trasa została pomyślnie dopasowana.

Microsoft.AspNetCore.Diagnostics

Microsoft.AspNetCore.Diagnostics Metryki raportują informacje diagnostyczne z ASP.NET Core o błędzie obsługi oprogramowania pośredniczącego:

• aspnetcore.diagnostics.exceptions

Metryka: aspnetcore.diagnostics.exceptions

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.diagnostics.exceptions	Licznik	{exception}	Liczba wyjątków przechwyconych przez oprogramowanie pośredniczące obsługujące wyjątki.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.diagnostics.exception.result	sznurek	Wynik obsługi oprogramowania pośredniczącego ASP.NET Core	handled; unhandled	Zawsze
aspnetcore.diagnostics.handler.type	sznurek	Pełna nazwa typu implementacji IExceptionHandler , która obsłużyła wyjątek.	Contoso.MyHandler	Jeśli wyjątek został obsłużony przez tę procedurę obsługi.
exception.type	sznurek	Pełna nazwa typu wyjątku.	System.OperationCanceledException; Contoso.MyException	Zawsze

Microsoft.AspNetCore.RateLimiting

Microsoft.AspNetCore.RateLimiting Metryki zgłaszają informacje ograniczające szybkość z oprogramowania pośredniczącego ASP.NET Core:

• aspnetcore.rate_limiting.active_request_leases
• aspnetcore.rate_limiting.request_lease.duration
• aspnetcore.rate_limiting.queued_requests
• aspnetcore.rate_limiting.request.time_in_queue
• aspnetcore.rate_limiting.requests

Metryka: aspnetcore.rate_limiting.active_request_leases

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.rate_limiting.active_request_leases	UpDownCounter	{request}	Liczba żądań, które są obecnie aktywne na serwerze, na których jest przechowywana dzierżawa ograniczająca szybkość.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.rate_limiting.policy	sznurek	Nazwa zasad ograniczania szybkości.	fixed; sliding; token	Jeśli pasujący punkt końcowy żądania miał zasady ograniczania szybkości.

Metryka: aspnetcore.rate_limiting.request_lease.duration

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.rate_limiting.request_lease.duration	Histogram	s	Czas trwania dzierżawy ograniczania szybkości przechowywanej przez żądania na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.rate_limiting.policy	sznurek	Nazwa zasad ograniczania szybkości.	fixed; sliding; token	Jeśli pasujący punkt końcowy żądania miał zasady ograniczania szybkości.

Metryka: aspnetcore.rate_limiting.queued_requests

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.rate_limiting.queued_requests	UpDownCounter	{request}	Liczba żądań, które są obecnie w kolejce oczekujące na uzyskanie dzierżawy ograniczającej szybkość.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.rate_limiting.policy	sznurek	Nazwa zasad ograniczania szybkości.	fixed; sliding; token	Jeśli pasujący punkt końcowy żądania miał zasady ograniczania szybkości.

Metryka: aspnetcore.rate_limiting.request.time_in_queue

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.rate_limiting.request.time_in_queue	Histogram	s	Czas, przez który żądanie spędziło w kolejce oczekiwanie na uzyskanie dzierżawy ograniczającej szybkość.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.rate_limiting.policy	sznurek	Nazwa zasad ograniczania szybkości.	fixed; sliding; token	Jeśli pasujący punkt końcowy żądania miał zasady ograniczania szybkości.
aspnetcore.rate_limiting.result	sznurek	Wynik ograniczania szybkości pokazuje, czy dzierżawa została nabyta, czy zawiera przyczynę odrzucenia.	acquired; request_canceled	Zawsze

Metryka: aspnetcore.rate_limiting.requests

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.rate_limiting.requests	Licznik	{request}	Liczba żądań, które próbowały uzyskać dzierżawę ograniczającą szybkość.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.rate_limiting.policy	sznurek	Nazwa zasad ograniczania szybkości.	fixed; sliding; token	Jeśli pasujący punkt końcowy żądania miał zasady ograniczania szybkości.
aspnetcore.rate_limiting.result	sznurek	Wynik ograniczania szybkości pokazuje, czy dzierżawa została nabyta, czy zawiera przyczynę odrzucenia.	acquired; request_canceled	Zawsze

Microsoft.AspNetCore.HeaderParsing

Informacje Microsoft.AspNetCore.HeaderParsing raportu metryk dotyczące analizowania nagłówka ASP.NET Core:

• aspnetcore.header_parsing.parse_errors
• aspnetcore.header_parsing.cache_accesses

Metryka: aspnetcore.header_parsing.parse_errors

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.header_parsing.parse_errors	Licznik	{parse_error}	Liczba błędów, które wystąpiły podczas analizowania nagłówków żądań HTTP.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.header_parsing.header.name	sznurek	Nazwa nagłówka.	Content-Type	Zawsze
error.type	sznurek	Komunikat o błędzie.	Unable to parse media type value.	Zawsze

Metryka: aspnetcore.header_parsing.cache_accesses

Metryka jest emitowana tylko dla analizatorów nagłówków żądań HTTP obsługujących buforowanie.

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
aspnetcore.header_parsing.cache_accesses	Licznik	{cache_access}	Liczba prób uzyskania dostępu do pamięci podręcznej przechowujące przeanalizowane wartości nagłówka.

Atrybut	Typ	Opis	Przykłady	Obecność
aspnetcore.header_parsing.header.name	sznurek	Nazwa nagłówka.	Content-Type	Zawsze
aspnetcore.header_parsing.cache_access.type	sznurek	Wartość wskazująca, czy wartość nagłówka została znaleziona w pamięci podręcznej, czy nie.	Hit; Miss	Zawsze

Microsoft.AspNetCore.Server.Kestrel

Microsoft.AspNetCore.Server.Kestrel Metryki raportują informacje o połączeniu HTTP z serwera internetowego ASP.NET CoreKestrel:

• kestrel.active_connections
• kestrel.connection.duration
• kestrel.rejected_connections
• kestrel.queued_connections
• kestrel.queued_requests
• kestrel.upgraded_connections
• kestrel.tls_handshake.duration
• kestrel.active_tls_handshakes

Metryka: kestrel.active_connections

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.active_connections	UpDownCounter	{connection}	Liczba połączeń, które są obecnie aktywne na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.

Metryka: kestrel.connection.duration

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.connection.duration	Histogram	s	Czas trwania połączeń na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
error.type	sznurek	Opisuje typ błędu, z którym zakończyło się połączenie, lub nieobsługiwany typ wyjątku zgłoszony podczas potoku połączenia. Znane błędy połączeń można znaleźć w artykule Semantic Conventions for web server metrics (Konwencje semantyczne dotyczące Kestrel metryk serwera internetowego).	connection_reset; invalid_request_headers; System.OperationCanceledException	Jeśli połączenie zakończyło się znanym błędem lub został zgłoszony wyjątek.
network.protocol.name	sznurek	Warstwa aplikacji OSI lub odpowiednik inny niż OSI.	http; web_sockets	Zawsze
network.protocol.version	sznurek	Wersja protokołu określonego w pliku network.protocol.name.	1.1; 2	Zawsze
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.
tls.protocol.version	sznurek	Wersja protokołu TLS.	1.2; 1.3	Jeśli połączenie jest zabezpieczone przy użyciu protokołu TLS.

Ponieważ ta metryka śledzi czas trwania połączenia, a w idealnym przypadku połączenia HTTP są używane dla wielu żądań, zasobniki powinny być dłuższe niż te używane przez czas trwania żądań. Na przykład użycie wartości [ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300] zapewnia górną zasobnik 5 minut.

Gdy połączenie kończy się znanym błędem, wartość atrybutu error.type jest ustawiona na znany typ błędu. Znane błędy połączeń można znaleźć w artykule Semantic Conventions for web server metrics (Konwencje semantyczne dotyczące Kestrel metryk serwera internetowego).

Metryka: kestrel.rejected_connections

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.rejected_connections	Licznik	{connection}	Liczba połączeń odrzuconych przez serwer.

Atrybut	Typ	Opis	Przykłady	Obecność
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.

Połączenia są odrzucane, gdy aktualnie aktywna liczba przekracza wartość skonfigurowaną za pomocą MaxConcurrentConnectionspolecenia .

Metryka: kestrel.queued_connections

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.queued_connections	UpDownCounter	{connection}	Liczba połączeń, które są obecnie w kolejce i oczekuje na uruchomienie.

Atrybut	Typ	Opis	Przykłady	Obecność
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.

Metryka: kestrel.queued_requests

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.queued_requests	UpDownCounter	{request}	Liczba żądań HTTP dla połączeń multipleksowanych (HTTP/2 i HTTP/3), które są obecnie kolejkowane i oczekują na uruchomienie.

Atrybut	Typ	Opis	Przykłady	Obecność
network.protocol.name	sznurek	Warstwa aplikacji OSI lub odpowiednik inny niż OSI.	http; web_sockets	Zawsze
network.protocol.version	sznurek	Wersja protokołu określonego w pliku network.protocol.name.	1.1; 2	Zawsze
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.

Metryka: kestrel.upgraded_connections

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.upgraded_connections	UpDownCounter	{connection}	Liczba połączeń, które są obecnie uaktualnione (WebSocket).

Atrybut	Typ	Opis	Przykłady	Obecność
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.

Licznik śledzi tylko połączenia HTTP/1.1.

Metryka: kestrel.tls_handshake.duration

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.tls_handshake.duration	Histogram	s	Czas trwania uzgadniania protokołu TLS na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
error.type	sznurek	Pełna nazwa typu wyjątku.	System.OperationCanceledException; Contoso.MyException	Jeśli zgłoszono wyjątek.
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.
tls.protocol.version	sznurek	Wersja protokołu TLS.	1.2; 1.3	Jeśli połączenie jest zabezpieczone przy użyciu protokołu TLS.

W przypadku korzystania z biblioteki OpenTelemetry domyślne zasobniki dla tej metic są ustawione na [ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ].

Metryka: kestrel.active_tls_handshakes

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
kestrel.active_tls_handshakes	UpDownCounter	{handshake}	Liczba uzgadniań protokołu TLS, które są obecnie w toku na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
network.transport	sznurek	warstwy transportu OSI lub metody komunikacji między procesami.	tcp; unix	Zawsze
network.type	sznurek	warstwy sieciowej OSI lub nieprzyleżące do osi.	ipv4; ipv6	Jeśli transport to tcp lub udp.
server.address	sznurek	Nazwa domeny adresu serwera, jeśli jest dostępna bez wstecznego wyszukiwania DNS; w przeciwnym razie adres IP lub nazwa gniazda domeny systemu Unix.	example.com	Zawsze
server.port	Int	Numer portu serwera	80; 8080; 443	Jeśli transport to tcp lub udp.

Microsoft.AspNetCore.Http.Connections

Informacje o połączeniu Microsoft.AspNetCore.Http.Connections raportu metryk z ASP.NET Core SignalR:

• signalr.server.connection.duration
• signalr.server.active_connections

Metryka: signalr.server.connection.duration

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
signalr.server.connection.duration	Histogram	s	Czas trwania połączeń na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
signalr.connection.status	sznurek	SignalR Stan zamknięcia połączenia HTTP.	app_shutdown; timeout	Zawsze
signalr.transport	sznurek	SignalR typ transportu	web_sockets; long_polling	Zawsze

Wartość	Opis
normal_closure	Połączenie zostało zamknięte normalnie.
timeout	Połączenie zostało zamknięte z powodu przekroczenia limitu czasu.
app_shutdown	Połączenie zostało zamknięte, ponieważ aplikacja jest zamykana.

signalr.transport jest jednym z następujących elementów:

Wartość	Opis
server_sent_events	zdarzenia wysyłane przez serwer
long_polling	Długie sondowanie
web_sockets	Składnik WebSocket

Ponieważ ta metryka śledzi czas trwania połączenia i w idealnym przypadku SignalR połączenia są trwałe, zasobniki powinny być dłuższe niż te, które są używane przez czas trwania żądań. Na przykład użycie wartości [0, 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300] zapewnia górny zasobnik 5 minut.

Metryka: signalr.server.active_connections

Nazwa	Typ instrumentu	Jednostka (UCUM)	Opis
signalr.server.active_connections	UpDownCounter	{connection}	Liczba połączeń, które są obecnie aktywne na serwerze.

Atrybut	Typ	Opis	Przykłady	Obecność
signalr.connection.status	sznurek	SignalR Stan zamknięcia połączenia HTTP.	app_shutdown; timeout	Zawsze
signalr.transport	sznurek	SignalR typ transportu	web_sockets; long_polling	Zawsze