Skip to content

Commit 15ed17b

Browse files
JamesNKgewarren
andauthored
Add detail about known error types to Kestrel connection metric (#43584)
Co-authored-by: Genevieve Warren <[email protected]>
1 parent 73a9c70 commit 15ed17b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/core/diagnostics/built-in-metrics-aspnetcore.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ Available starting in: .NET 8.0.
249249

250250
| Attribute | Type | Description | Examples | Presence |
251251
|---|---|---|---|---|
252-
| `error.type` | string | The full name of exception type. | `System.OperationCanceledException`; `Contoso.MyException` | If an exception was thrown. |
252+
| `error.type` | string | Describes a type of error the connection ended with, or the unhandled exception type thrown during the connection pipeline. Known connection errors can be found at [Semantic Conventions for Kestrel web server metrics](https://opentelemetry.io/docs/specs/semconv/dotnet/dotnet-kestrel-metrics/). | `connection_reset`; `invalid_request_headers`; `System.OperationCanceledException` | If the connection ended with a known error or an exception was thrown. |
253253
| `network.protocol.name` | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. | `http`; `web_sockets` | Always |
254254
| `network.protocol.version` | string | Version of the protocol specified in `network.protocol.name`. | `1.1`; `2` | Always |
255255
| `network.transport` | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://en.wikipedia.org/wiki/Inter-process_communication). | `tcp`; `unix` | Always |
@@ -260,7 +260,9 @@ Available starting in: .NET 8.0.
260260

261261
As this metric is tracking the connection duration, and ideally http connections are used for multiple requests, the buckets should be longer than those used for request durations. For example, using [ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300] provides an upper bucket of 5 mins.
262262

263-
Available starting in: .NET 8.0.
263+
Starting in .NET 9, when a connection ends with a known error, the `error.type` attribute value is set to the known error type. Known connection errors can be found at [Semantic Conventions for Kestrel web server metrics](https://opentelemetry.io/docs/specs/semconv/dotnet/dotnet-kestrel-metrics/).
264+
265+
Available starting in: .NET 8.
264266

265267
##### Metric: `kestrel.rejected_connections`
266268

0 commit comments

Comments
 (0)