diff --git a/docs/dotnet/dotnet-aspnetcore-metrics.md b/docs/dotnet/dotnet-aspnetcore-metrics.md
index b09a34d8b8..54b8fc04a0 100644
--- a/docs/dotnet/dotnet-aspnetcore-metrics.md
+++ b/docs/dotnet/dotnet-aspnetcore-metrics.md
@@ -43,9 +43,9 @@ All routing metrics are reported by the `Microsoft.AspNetCore.Routing` meter.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.routing.is_fallback` | boolean | A value that indicates whether the matched route is a fallback route. | `True` | Conditionally Required: if and only if a route was successfully matched. |
-| `aspnetcore.routing.match_status` | string | Match result - success or failure | `success`; `failure` | Required |
-| [`http.route`](../attributes-registry/http.md) | string | The matched route, that is, the path template in the format used by the respective server framework. [1] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: if and only if a route was successfully matched. |
+| `aspnetcore.routing.is_fallback` | boolean | 
A value that indicates whether the matched route is a fallback route. | `True` | Conditionally Required: if and only if a route was successfully matched. |
+| `aspnetcore.routing.match_status` | string | 
Match result - success or failure | `success`; `failure` | Required |
+| [`http.route`](../attributes-registry/http.md) | string | 
The matched route, that is, the path template in the format used by the respective server framework. [1] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: if and only if a route was successfully matched. |
**[1]:** MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it.
SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one.
@@ -75,9 +75,9 @@ Exceptions Metric is reported by the `Microsoft.AspNetCore.Diagnostics` meter.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.diagnostics.exception.result` | string | ASP.NET Core exception middleware handling result | `handled`; `unhandled` | Required |
-| `aspnetcore.diagnostics.handler.type` | string | Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. | `Contoso.MyHandler` | Conditionally Required: [1] |
-| [`error.type`](../attributes-registry/error.md) | string | The full name of exception type. [2] | `System.OperationCanceledException`; `Contoso.MyException` | Required |
+| `aspnetcore.diagnostics.exception.result` | string | 
ASP.NET Core exception middleware handling result | `handled`; `unhandled` | Required |
+| `aspnetcore.diagnostics.handler.type` | string | 
Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. | `Contoso.MyHandler` | Conditionally Required: [1] |
+| [`error.type`](../attributes-registry/error.md) | string | 
The full name of exception type. [2] | `System.OperationCanceledException`; `Contoso.MyException` | Required |
**[1]:** if and only if the exception was handled by this handler.
@@ -130,7 +130,7 @@ All rate-limiting metrics are reported by the `Microsoft.AspNetCore.RateLimiting
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.rate_limiting.policy` | string | Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
+| `aspnetcore.rate_limiting.policy` | string | 
Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
**[1]:** if the matched endpoint for the request had a rate-limiting policy.
@@ -152,7 +152,7 @@ of `[ 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
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.rate_limiting.policy` | string | Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
+| `aspnetcore.rate_limiting.policy` | string | 
Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
**[1]:** if the matched endpoint for the request had a rate-limiting policy.
@@ -170,7 +170,7 @@ of `[ 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
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.rate_limiting.policy` | string | Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
+| `aspnetcore.rate_limiting.policy` | string | 
Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
**[1]:** if the matched endpoint for the request had a rate-limiting policy.
@@ -192,8 +192,8 @@ of `[ 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
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.rate_limiting.policy` | string | Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
-| `aspnetcore.rate_limiting.result` | string | Rate-limiting result, shows whether the lease was acquired or contains a rejection reason | `acquired`; `request_canceled` | Required |
+| `aspnetcore.rate_limiting.policy` | string | 
Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
+| `aspnetcore.rate_limiting.result` | string | 
Rate-limiting result, shows whether the lease was acquired or contains a rejection reason | `acquired`; `request_canceled` | Required |
**[1]:** if the matched endpoint for the request had a rate-limiting policy.
@@ -225,8 +225,8 @@ Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `aspnetcore.rate_limiting.policy` | string | Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
-| `aspnetcore.rate_limiting.result` | string | Rate-limiting result, shows whether the lease was acquired or contains a rejection reason | `acquired`; `request_canceled` | Required |
+| `aspnetcore.rate_limiting.policy` | string | 
Rate limiting policy name. | `fixed`; `sliding`; `token` | Conditionally Required: [1] |
+| `aspnetcore.rate_limiting.result` | string | 
Rate-limiting result, shows whether the lease was acquired or contains a rejection reason | `acquired`; `request_canceled` | Required |
**[1]:** if the matched endpoint for the request had a rate-limiting policy.
diff --git a/docs/dotnet/dotnet-kestrel-metrics.md b/docs/dotnet/dotnet-kestrel-metrics.md
index 96f400ab19..81ea6e79a4 100644
--- a/docs/dotnet/dotnet-kestrel-metrics.md
+++ b/docs/dotnet/dotnet-kestrel-metrics.md
@@ -94,9 +94,9 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| [`error.type`](../attributes-registry/error.md) | string | The full name of exception type. [1] | `System.OperationCanceledException`; `Contoso.MyException` | Conditionally Required: if and only if an error has occurred. |
-| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [2] | `http`; `web_sockets` | Recommended |
-| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [3] | `1.1`; `2` | Recommended |
+| [`error.type`](../attributes-registry/error.md) | string | 
The full name of exception type. [1] | `System.OperationCanceledException`; `Contoso.MyException` | Conditionally Required: if and only if an error has occurred. |
+| [`network.protocol.name`](../attributes-registry/network.md) | string | 
[OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [2] | `http`; `web_sockets` | Recommended |
+| [`network.protocol.version`](../attributes-registry/network.md) | string | 
Version of the protocol specified in `network.protocol.name`. [3] | `1.1`; `2` | Recommended |
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [4] | `tcp`; `unix` | Recommended |
| [`network.type`](../attributes-registry/network.md) | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [5] | `ipv4`; `ipv6` | Recommended: if the transport is `tcp` or `udp` |
| [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
@@ -252,8 +252,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [1] | `http`; `web_sockets` | Recommended |
-| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [2] | `1.1`; `2` | Recommended |
+| [`network.protocol.name`](../attributes-registry/network.md) | string | 
[OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [1] | `http`; `web_sockets` | Recommended |
+| [`network.protocol.version`](../attributes-registry/network.md) | string | 
Version of the protocol specified in `network.protocol.name`. [2] | `1.1`; `2` | Recommended |
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [3] | `tcp`; `unix` | Recommended |
| [`network.type`](../attributes-registry/network.md) | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [4] | `ipv4`; `ipv6` | Recommended: if the transport is `tcp` or `udp` |
| [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
@@ -358,7 +358,7 @@ of `[ 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
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| [`error.type`](../attributes-registry/error.md) | string | The full name of exception type. [1] | `System.OperationCanceledException`; `Contoso.MyException` | Conditionally Required: if and only if an error has occurred. |
+| [`error.type`](../attributes-registry/error.md) | string | 
The full name of exception type. [1] | `System.OperationCanceledException`; `Contoso.MyException` | Conditionally Required: if and only if an error has occurred. |
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [2] | `tcp`; `unix` | Recommended |
| [`network.type`](../attributes-registry/network.md) | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [3] | `ipv4`; `ipv6` | Recommended: if the transport is `tcp` or `udp` |
| [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [4] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
diff --git a/docs/dotnet/dotnet-signalr-metrics.md b/docs/dotnet/dotnet-signalr-metrics.md
index dc2b04ed06..931d5f4bf3 100644
--- a/docs/dotnet/dotnet-signalr-metrics.md
+++ b/docs/dotnet/dotnet-signalr-metrics.md
@@ -32,8 +32,8 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `signalr.connection.status` | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | Recommended |
-| `signalr.transport` | string | [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | Recommended |
+| `signalr.connection.status` | string | 
SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | Recommended |
+| `signalr.transport` | string | 
[SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | Recommended |
`signalr.connection.status` MUST be one of the following:
@@ -65,8 +65,8 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `signalr.connection.status` | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | Recommended |
-| `signalr.transport` | string | [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | Recommended |
+| `signalr.connection.status` | string | 
SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | Recommended |
+| `signalr.transport` | string | 
[SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | Recommended |
`signalr.connection.status` MUST be one of the following:
diff --git a/model/metrics/dotnet/dotnet-aspnetcore.yaml b/model/metrics/dotnet/dotnet-aspnetcore.yaml
index 8369e068d5..89ce151d2d 100644
--- a/model/metrics/dotnet/dotnet-aspnetcore.yaml
+++ b/model/metrics/dotnet/dotnet-aspnetcore.yaml
@@ -7,6 +7,7 @@ groups:
- id: rate_limiting.policy
type: string
brief: Rate limiting policy name.
+ stability: stable
examples: ["fixed", "sliding", "token"]
requirement_level:
conditionally_required: if the matched endpoint for the request had a rate-limiting policy.
@@ -26,17 +27,20 @@ groups:
- id: request_canceled
value: 'request_canceled'
brief: "Lease request was canceled"
+ stability: stable
brief: Rate-limiting result, shows whether the lease was acquired or contains a rejection reason
examples: ["acquired", "request_canceled"]
requirement_level: required
- id: routing.is_fallback
type: boolean
+ stability: stable
brief: A value that indicates whether the matched route is a fallback route.
examples: [true]
requirement_level:
conditionally_required: If and only if a route was successfully matched.
- id: diagnostics.handler.type
type: string
+ stability: stable
brief: Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler)
implementation that handled the exception.
examples: ["Contoso.MyHandler"]
@@ -44,6 +48,7 @@ groups:
conditionally_required: if and only if the exception was handled by this handler.
- id: request.is_unhandled
type: boolean
+ stability: stable
brief: Flag indicating if request was handled by the application pipeline.
examples: [true]
requirement_level:
@@ -53,6 +58,7 @@ groups:
- id: metric.aspnetcore.routing.match_attempts
type: metric
metric_name: aspnetcore.routing.match_attempts
+ stability: stable
brief: Number of requests that were attempted to be matched to an endpoint.
instrument: counter
unit: "{match_attempt}"
@@ -75,6 +81,7 @@ groups:
- id: failure
value: 'failure'
brief: 'Match failed'
+ stability: stable
requirement_level: required
brief: Match result - success or failure
examples: ["success", "failure"]
@@ -83,6 +90,7 @@ groups:
- id: metric.aspnetcore.diagnostics.exceptions
type: metric
metric_name: aspnetcore.diagnostics.exceptions
+ stability: stable
brief: Number of exceptions caught by exception handling middleware.
instrument: counter
unit: "{exception}"
@@ -109,6 +117,7 @@ groups:
- id: aborted
value: 'aborted'
brief: "Exception handling didn't run because the request was aborted."
+ stability: stable
requirement_level: required
brief: ASP.NET Core exception middleware handling result
examples: ["handled", "unhandled"]
@@ -117,6 +126,7 @@ groups:
- id: metric.aspnetcore.rate_limiting.active_request_leases
type: metric
metric_name: aspnetcore.rate_limiting.active_request_leases
+ stability: stable
brief: Number of requests that are currently active on the server that hold a rate limiting lease.
instrument: updowncounter
unit: "{request}"
@@ -128,6 +138,7 @@ groups:
- id: metric.aspnetcore.rate_limiting.request_lease.duration
type: metric
metric_name: aspnetcore.rate_limiting.request_lease.duration
+ stability: stable
brief: The duration of rate limiting lease held by requests on the server.
instrument: histogram
unit: "s"
@@ -139,6 +150,7 @@ groups:
- id: metric.aspnetcore.rate_limiting.request.time_in_queue
type: metric
metric_name: aspnetcore.rate_limiting.request.time_in_queue
+ stability: stable
brief: The time the request spent in a queue waiting to acquire a rate limiting lease.
instrument: histogram
unit: "s"
@@ -151,6 +163,7 @@ groups:
- id: metric.aspnetcore.rate_limiting.queued_requests
type: metric
metric_name: aspnetcore.rate_limiting.queued_requests
+ stability: stable
brief: Number of requests that are currently queued, waiting to acquire a rate limiting lease.
instrument: updowncounter
unit: "{request}"
@@ -162,6 +175,7 @@ groups:
- id: metric.aspnetcore.rate_limiting.requests
type: metric
metric_name: aspnetcore.rate_limiting.requests
+ stability: stable
brief: Number of requests that tried to acquire a rate limiting lease.
instrument: counter
unit: "{request}"
diff --git a/model/metrics/dotnet/dotnet-kestrel.yaml b/model/metrics/dotnet/dotnet-kestrel.yaml
index e04714a9b5..9a4a231f51 100644
--- a/model/metrics/dotnet/dotnet-kestrel.yaml
+++ b/model/metrics/dotnet/dotnet-kestrel.yaml
@@ -14,6 +14,7 @@ groups:
- id: metric.kestrel.active_connections
type: metric
metric_name: kestrel.active_connections
+ stability: stable
brief: Number of connections that are currently active on the server.
instrument: updowncounter
unit: "{connection}"
@@ -24,6 +25,7 @@ groups:
- id: metric.kestrel.connection.duration
type: metric
metric_name: kestrel.connection.duration
+ stability: stable
brief: The duration of connections on the server.
instrument: histogram
unit: "s"
@@ -36,6 +38,7 @@ groups:
- ref: network.protocol.version
examples: ["1.1", "2"]
- ref: tls.protocol.version
+ stability: experimental
- ref: error.type
brief: The full name of exception type.
requirement_level:
@@ -46,6 +49,7 @@ groups:
- id: metric.kestrel.rejected_connections
type: metric
metric_name: kestrel.rejected_connections
+ stability: stable
brief: Number of connections rejected by the server.
instrument: counter
unit: "{connection}"
@@ -57,6 +61,7 @@ groups:
- id: metric.kestrel.queued_connections
type: metric
metric_name: kestrel.queued_connections
+ stability: stable
brief: Number of connections that are currently queued and are waiting to start.
instrument: updowncounter
unit: "{connection}"
@@ -67,6 +72,7 @@ groups:
- id: metric.kestrel.queued_requests
type: metric
metric_name: kestrel.queued_requests
+ stability: stable
brief: Number of HTTP requests on multiplexed connections (HTTP/2 and HTTP/3) that are currently queued and are waiting to start.
instrument: updowncounter
unit: "{request}"
@@ -82,6 +88,7 @@ groups:
- id: metric.kestrel.upgraded_connections
type: metric
metric_name: kestrel.upgraded_connections
+ stability: stable
brief: Number of connections that are currently upgraded (WebSockets). .
instrument: updowncounter
unit: "{connection}"
@@ -94,6 +101,7 @@ groups:
- id: metric.kestrel.tls_handshake.duration
type: metric
metric_name: kestrel.tls_handshake.duration
+ stability: stable
brief: The duration of TLS handshakes on the server.
instrument: histogram
unit: "s"
@@ -102,6 +110,7 @@ groups:
extends: common.kestrel.attributes
attributes:
- ref: tls.protocol.version
+ stability: experimental
- ref: error.type
brief: The full name of exception type.
note: "Captures the exception type when a TLS handshake fails."
@@ -112,6 +121,7 @@ groups:
- id: metric.kestrel.active_tls_handshakes
type: metric
metric_name: kestrel.active_tls_handshakes
+ stability: stable
brief: Number of TLS handshakes that are currently in progress on the server.
instrument: updowncounter
unit: "{handshake}"
diff --git a/model/metrics/dotnet/dotnet-signalr.yaml b/model/metrics/dotnet/dotnet-signalr.yaml
index 3333669c57..b47ebf6908 100644
--- a/model/metrics/dotnet/dotnet-signalr.yaml
+++ b/model/metrics/dotnet/dotnet-signalr.yaml
@@ -16,6 +16,7 @@ groups:
- id: app_shutdown
value: 'app_shutdown'
brief: "The connection was closed because the app is shutting down."
+ stability: stable
brief: SignalR HTTP connection closure status.
examples: ["app_shutdown", "timeout"]
- id: transport
@@ -32,11 +33,13 @@ groups:
- id: web_sockets
value: 'web_sockets'
brief: "WebSockets protocol"
+ stability: stable
examples: ["web_sockets", "long_polling"]
- id: metric.signalr.server.connection.duration
type: metric
metric_name: signalr.server.connection.duration
+ stability: stable
brief: The duration of connections on the server.
instrument: histogram
unit: "s"
@@ -49,6 +52,7 @@ groups:
- id: metric.signalr.server.active_connections
type: metric
metric_name: signalr.server.active_connections
+ stability: stable
brief: Number of connections that are currently active on the server.
instrument: updowncounter
unit: "{connection}"