Skip to content

Commit 02eddb9

Browse files
Copilotgewarren
andcommitted
Fix code fence issues in metrics documentation - wrap type names in backticks
Co-authored-by: gewarren <[email protected]>
1 parent 49a5de1 commit 02eddb9

File tree

3 files changed

+35
-35
lines changed

3 files changed

+35
-35
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can enable these metrics by calling the <xref:Microsoft.Extensions.Dependenc
3030

3131
| Attribute | Type | Description | Examples | Presence |
3232
|---|---|---|---|---|
33-
| `dotnet.health_check.status` | string | The health status of an application. | `Healthy`; `Unhealthy` | Always |
33+
| `dotnet.health_check.status` | `string` | The health status of an application. | `Healthy`; `Unhealthy` | Always |
3434

3535
`dotnet.health_check.status` is one of the following:
3636

@@ -50,8 +50,8 @@ Available starting in: .NET 8.0.
5050

5151
| Attribute | Type | Description | Examples | Presence |
5252
|---|---|---|---|---|
53-
| `dotnet.health_check.name` | string | The name of the health check. | `ApplicationLifecycle` | Always |
54-
| `dotnet.health_check.status` | string | The health status of an application. | `Healthy`; `Unhealthy` | Always |
53+
| `dotnet.health_check.name` | `string` | The name of the health check. | `ApplicationLifecycle` | Always |
54+
| `dotnet.health_check.status` | `string` | The health status of an application. | `Healthy`; `Unhealthy` | Always |
5555

5656
`dotnet.health_check.status` is one of the following:
5757

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The `System.Runtime` Meter reports measurements from the GC, JIT, AssemblyLoader
2525

2626
| Attribute | Type | Description | Examples | Presence |
2727
|---|---|---|---|---|
28-
| `cpu.mode` | string | The mode of the CPU. | `user`; `system` | Always |
28+
| `cpu.mode` | `string` | The mode of the CPU. | `user`; `system` | Always |
2929

3030
This metric reports the same values as accessing the processor time properties on <xref:System.Diagnostics.Process?displayProperty=nameWithType> for the current process. The `system` mode corresponds to <xref:System.Diagnostics.Process.PrivilegedProcessorTime> and `user` mode corresponds to <xref:System.Diagnostics.Process.UserProcessorTime>
3131

@@ -83,7 +83,7 @@ Available starting in: .NET 9.0.
8383

8484
| Attribute | Type | Description | Examples | Presence |
8585
|---|---|---|---|---|
86-
| `gc.heap.generation` | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2`; `loh`; `poh` | Always |
86+
| `gc.heap.generation` | `string` | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2`; `loh`; `poh` | Always |
8787

8888
The .NET GC divides the heap into generations. In addition to the standard numbered generations, the GC also puts some objects into two special generations:
8989

@@ -102,7 +102,7 @@ Available starting in: .NET 9.0.
102102

103103
| Attribute | Type | Description | Examples | Presence |
104104
|---|---|---|---|---|
105-
| `gc.heap.generation` | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2`; `loh`; `poh` | Always |
105+
| `gc.heap.generation` | `string` | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2`; `loh`; `poh` | Always |
106106

107107
This metric reports the same values as calling <xref:System.GCGenerationInfo.FragmentationAfterBytes?displayProperty=nameWithType>.
108108

docs/core/diagnostics/built-in-metrics-system-net.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ The `System.Net.NameResolution` metrics report DNS name resolution from <xref:Sy
2727

2828
| Attribute | Type | Description | Examples | Presence |
2929
|---|---|---|---|---|
30-
| `dns.question.name` | string | The name being queried. | `www.example.com`; `dot.net` | Always |
31-
| `error.type` | string | A well-known error string or the full type name of an exception that occurred. | `host_not_found`; `System.Net.Sockets.SocketException` | If an error occurred |
30+
| `dns.question.name` | `string` | The name being queried. | `www.example.com`; `dot.net` | Always |
31+
| `error.type` | `string` | A well-known error string or the full type name of an exception that occurred. | `host_not_found`; `System.Net.Sockets.SocketException` | If an error occurred |
3232

3333
This metric measures the time take to make DNS requests. These requests can occur by calling methods on
3434
<xref:System.Net.Dns> or indirectly within higher level APIs on types such as <xref:System.Net.Http.HttpClient>.
@@ -66,12 +66,12 @@ The `System.Net.Http` metrics report HTTP request and connection information fro
6666

6767
| Attribute | Type | Description | Examples | Presence |
6868
|---|---|---|---|---|
69-
| `http.connection.state` | string | State of HTTP connection in the HTTP connection pool. | `active`; `idle` | Always |
70-
| `network.protocol.version` | string | Version of the HTTP protocol used. | `1.1`; `2` | Always |
71-
| `server.address` | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
72-
| `server.port` | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
73-
| `network.peer.address` | string | Peer IP address of the socket connection. | `10.5.3.2` | Always |
74-
| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
69+
| `http.connection.state` | `string` | State of HTTP connection in the HTTP connection pool. | `active`; `idle` | Always |
70+
| `network.protocol.version` | `string` | Version of the HTTP protocol used. | `1.1`; `2` | Always |
71+
| `server.address` | `string` | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
72+
| `server.port` | `int` | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
73+
| `network.peer.address` | `string` | Peer IP address of the socket connection. | `10.5.3.2` | Always |
74+
| `url.scheme` | `string` | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
7575

7676
<xref:System.Net.Http.HttpClient>, when configured to use the default <xref:System.Net.Http.SocketsHttpHandler>, maintains a cached pool of network connections for sending HTTP messages. This metric counts how many connections are currently in the pool. Active connections are handling active requests. Active connects could be transmitting data or awaiting the client or server. Idle connections aren't handling any requests, but are left open so that future requests can be handled more quickly.
7777

@@ -85,11 +85,11 @@ Available starting in: .NET 8
8585

8686
| Attribute | Type | Description | Examples | Presence |
8787
|---|---|---|---|---|
88-
| `network.protocol.version` | string | Version of the HTTP protocol used. | `1.1`; `2` | Always |
89-
| `server.address` | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
90-
| `server.port` | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
91-
| `network.peer.address` | string | IP address of the socket connection. | `10.5.3.2` | Always |
92-
| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
88+
| `network.protocol.version` | `string` | Version of the HTTP protocol used. | `1.1`; `2` | Always |
89+
| `server.address` | `string` | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
90+
| `server.port` | `int` | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
91+
| `network.peer.address` | `string` | IP address of the socket connection. | `10.5.3.2` | Always |
92+
| `url.scheme` | `string` | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
9393

9494
This metric is only captured when <xref:System.Net.Http.HttpClient> is configured to use the default <xref:System.Net.Http.SocketsHttpHandler>.
9595

@@ -105,13 +105,13 @@ Available starting in: .NET 8
105105

106106
| Attribute | Type | Description | Examples | Presence |
107107
|---|---|---|---|---|
108-
| `error.type` | string | Request failure reason: one of the [HTTP request errors](xref:System.Net.Http.HttpRequestError) in snake_case, or a full exception type, or an HTTP 4xx/5xx status code. | `System.Threading.Tasks.TaskCanceledException`; `name_resolution_error`; `secure_connection_error` ; `404` | If request has failed. |
109-
| `http.request.method` | string | HTTP request method. | `GET`; `POST`; `HEAD`; `_OTHER` [2] | Always |
110-
| `http.response.status_code` | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | If response was received. |
111-
| `network.protocol.version` | string | Version of the HTTP protocol used. | `1.1`; `2` | If response was received. |
112-
| `server.address` | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
113-
| `server.port` | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | Depends on .NET version. [3] |
114-
| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
108+
| `error.type` | `string` | Request failure reason: one of the [HTTP request errors](xref:System.Net.Http.HttpRequestError) in snake_case, or a full exception type, or an HTTP 4xx/5xx status code. | `System.Threading.Tasks.TaskCanceledException`; `name_resolution_error`; `secure_connection_error` ; `404` | If request has failed. |
109+
| `http.request.method` | `string` | HTTP request method. | `GET`; `POST`; `HEAD`; `_OTHER` [2] | Always |
110+
| `http.response.status_code` | `int` | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | If response was received. |
111+
| `network.protocol.version` | `string` | Version of the HTTP protocol used. | `1.1`; `2` | If response was received. |
112+
| `server.address` | `string` | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
113+
| `server.port` | `int` | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | Depends on .NET version. [3] |
114+
| `url.scheme` | `string` | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
115115

116116
**[1] `error.type`:** If the request has failed, the value is set to one of the following:
117117

@@ -143,11 +143,11 @@ Available starting in: .NET 8
143143

144144
| Attribute | Type | Description | Examples | Presence |
145145
|---|---|---|---|---|
146-
| `http.request.method` | string | HTTP request method. | `GET`; `POST`; `HEAD` | Always |
147-
| `network.protocol.version` | string | Version of the HTTP protocol used. | `1.1`; `2` | Always |
148-
| `server.address` | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
149-
| `server.port` | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
150-
| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
146+
| `http.request.method` | `string` | HTTP request method. | `GET`; `POST`; `HEAD` | Always |
147+
| `network.protocol.version` | `string` | Version of the HTTP protocol used. | `1.1`; `2` | Always |
148+
| `server.address` | `string` | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
149+
| `server.port` | `int` | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
150+
| `url.scheme` | `string` | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
151151

152152
<xref:System.Net.Http.HttpClient>, when configured to use the default <xref:System.Net.Http.SocketsHttpHandler>, sends HTTP requests using a pool of network connections. If all connections are busy handling other requests, new requests are placed in a queue and wait until a network connection is available for use. This instrument measures the amount of time HTTP requests spend waiting in that queue, prior to anything being sent across the network.
153153

@@ -161,10 +161,10 @@ Available starting in: .NET 8
161161

162162
| Attribute | Type | Description | Examples | Presence |
163163
|---|---|---|---|---|
164-
| `http.request.method` | string | HTTP request method. | `GET`; `POST`; `HEAD` | Always |
165-
| `server.address` | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
166-
| `server.port` | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
167-
| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
164+
| `http.request.method` | `string` | HTTP request method. | `GET`; `POST`; `HEAD` | Always |
165+
| `server.address` | `string` | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `example.com` | Always |
166+
| `server.port` | `int` | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. | `80`; `8080`; `443` | If not default (`80` for `http` scheme, `443` for `https`) |
167+
| `url.scheme` | `string` | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https`; `ftp` | Always |
168168

169169
This metric counts how many requests are considered active. Requests are active for the same time period that is measured by the [http.client.request.duration](#metric-httpclientrequestduration) instrument.
170170

0 commit comments

Comments
 (0)