You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: aspnetcore/log-mon/metrics/metrics.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,7 @@ For more information, see [dotnet-counters](/dotnet/core/diagnostics/dotnet-coun
90
90
## Enrich the ASP.NET Core request metric
91
91
92
92
ASP.NET Core has many built-in metrics. The `http.server.request.duration` metric:
93
+
93
94
* Records the duration of HTTP requests on the server.
94
95
* Captures request information in tags, such as the matched route and response status code.
95
96
@@ -106,7 +107,25 @@ The proceeding example:
106
107
* The tag allows requests to be categorized by marketing medium type, which could be useful when analyzing web app traffic.
107
108
108
109
> [!NOTE]
109
-
> Follow the [multi-dimensional metrics](/dotnet/core/diagnostics/metrics-instrumentation#multi-dimensional-metrics) best practices when enriching with custom tags. Too many tags, or tags with an unbound range cause a large combination of tags. Collection tools have a limit on how many combinations they support for a counter and may start filtering results out to avoid excessive memory usage.
110
+
> Follow the [multi-dimensional metrics](/dotnet/core/diagnostics/metrics-instrumentation#multi-dimensional-metrics) best practices when enriching with custom tags. Too many tags, or tags with an unbound range cause a large combination of tags, which creates many dimensions. Collection tools have a limit on how many dimensions they support for a counter and may start filtering results out to avoid excessive memory usage.
111
+
112
+
## Opt-out of HTTP metrics on certain endpoints and requests
113
+
114
+
Opting out of recording metrics is beneficial for endpoints frequently called by automated systems, such as health checks. Recording metrics for these requests is generally unnecessary. Unwanted telemetry costs resources to collect and store, and can distort results displayed in a telemetry dashboard.
115
+
116
+
HTTP requests to an endpoint can be excluded from metrics by adding metadata. Either:
117
+
118
+
* Add the [DisableHttpMetrics](xref:Microsoft.AspNetCore.Http.DisableHttpMetricsAttribute) attribute to the Web API controller, SignalR hub or gRPC service.
119
+
* Call [DisableHttpMetrics()](xref:Microsoft.AspNetCore.Builder.HttpMetricsEndpointConventionBuilderExtensions.DisableHttpMetrics<TBuilder>(TBuilder)) when mapping endpoints in app startup:
Alternatively, the <xref:Microsoft.AspNetCore.Http.Features.IHttpMetricsTagsFeature.MetricsDisabled?displayProperty=nameWithType> property has been added for:
124
+
125
+
* Advanced scenarios where a request doesn't map to an endpoint.
126
+
* Dynamically disabling metrics collection for specific HTTP requests.
0 commit comments