Skip to content

Commit 83702f4

Browse files
CopilotCopilot
authored
Fix code fence issues in metrics and tracing documentation to prevent over-localization (#47586)
1 parent 17acabc commit 83702f4

File tree

4 files changed

+143
-143
lines changed

4 files changed

+143
-143
lines changed

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

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -26,42 +26,42 @@ You can enable these metrics by calling the <xref:Microsoft.Extensions.Dependenc
2626

2727
| Name | Instrument Type | Unit (UCUM) | Description |
2828
| ---- | --------------- | ----------- | ----------- |
29-
| `dotnet.health_check.reports` | Counter | `{report}` | Number of times a health report reported the health status of an application. |
29+
| `dotnet.health_check.reports` | <xref:System.Diagnostics.Metrics.Counter`1> | `{report}` | Number of times a health report reported the health status of an application. |
3030

31-
| Attribute | Type | Description | Examples | Presence |
32-
|---|---|---|---|---|
33-
| `dotnet.health_check.status` | string | The health status of an application. | `Healthy`; `Unhealthy` | Always |
31+
| Attribute | Type | Description | Examples | Presence |
32+
|------------------------------|----------|--------------------------------------|------------------------|----------|
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

37-
| Value | Description |
38-
|---|---|
39-
| `Degraded` | An application was in degraded state. |
40-
| `Healthy` | An application was healthy. |
41-
| `Unhealthy` | An application was unhealthy. |
37+
| Value | Description |
38+
|-------------|---------------------------------------|
39+
| `Degraded` | An application was in degraded state. |
40+
| `Healthy` | An application was healthy. |
41+
| `Unhealthy` | An application was unhealthy. |
4242

43-
Available starting in: .NET 8.0.
43+
Available starting in: .NET 8.
4444

4545
##### Metric: `dotnet.health_check.unhealthy_checks`
4646

4747
| Name | Instrument Type | Unit (UCUM) | Description |
4848
| ---- | --------------- | ----------- | ----------- |
49-
| `dotnet.health_check.unhealthy_checks` | Counter | `{unhealthy_check}` | Number of times a health check reported the health status of an application as `Degraded` or `Unhealthy`. |
49+
| `dotnet.health_check.unhealthy_checks` | <xref:System.Diagnostics.Metrics.Counter`1> | `{unhealthy_check}` | Number of times a health check reported the health status of an application as `Degraded` or `Unhealthy`. |
5050

51-
| Attribute | Type | Description | Examples | Presence |
52-
|---|---|---|---|---|
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 |
51+
| Attribute | Type | Description | Examples | Presence |
52+
|------------------------------|----------|--------------------------------------|------------------------|----------|
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

58-
| Value | Description |
59-
|---|---|
60-
| `Degraded` | An application was in degraded state. |
61-
| `Healthy` | An application was healthy. |
62-
| `Unhealthy` | An application was unhealthy. |
58+
| Value | Description |
59+
|-------------|---------------------------------------|
60+
| `Degraded` | An application was in degraded state. |
61+
| `Healthy` | An application was healthy. |
62+
| `Unhealthy` | An application was unhealthy. |
6363

64-
Available starting in: .NET 8.0.
64+
Available starting in: .NET 8.
6565

6666
## `Microsoft.Extensions.Diagnostics.ResourceMonitoring`
6767

@@ -85,7 +85,7 @@ The instrument is only available on a system running on containers both on Windo
8585

8686
| Name | Instrument Type | Unit (UCUM) | Description |
8787
| ---- | --------------- | ----------- | ----------- |
88-
| `container.cpu.limit.utilization` | ObservableGauge | `1` | The CPU consumption of the running containerized application relative to resource limit in range `[0, 1]`. |
88+
| `container.cpu.limit.utilization` | <xref:System.Diagnostics.Metrics.ObservableGauge`1> | `1` | The CPU consumption of the running containerized application relative to resource limit in range `[0, 1]`. |
8989

9090
Available starting in `Microsoft.Extensions.Diagnostics.ResourceMonitoring` 8.8.0.
9191

@@ -95,7 +95,7 @@ The instrument is only available on a system running on containers on Linux.
9595

9696
| Name | Instrument Type | Unit (UCUM) | Description |
9797
| ---- | --------------- | ----------- | ----------- |
98-
| `container.cpu.request.utilization` | ObservableGauge | `1` | The CPU consumption of the running containerized application relative to resource request in range `[0, 1]`. |
98+
| `container.cpu.request.utilization` | <xref:System.Diagnostics.Metrics.ObservableGauge`1> | `1` | The CPU consumption of the running containerized application relative to resource request in range `[0, 1]`. |
9999

100100
Available starting in `Microsoft.Extensions.Diagnostics.ResourceMonitoring` 8.8.0.
101101

@@ -105,7 +105,7 @@ The instrument is only available on a system running on a container either on Wi
105105

106106
| Name | Instrument Type | Unit (UCUM) | Description |
107107
| ---- | --------------- | ----------- | ----------- |
108-
| `container.cpu.time` | ObservableCounter | `s` | CPU time used by the container. |
108+
| `container.cpu.time` | <xref:System.Diagnostics.Metrics.ObservableCounter`1> | `s` | CPU time used by the container. |
109109

110110
Available starting in `Microsoft.Extensions.Diagnostics.ResourceMonitoring` 9.8.0.
111111

@@ -115,7 +115,7 @@ The instrument is only available on a system running on containers both on Windo
115115

116116
| Name | Instrument Type | Unit (UCUM) | Description |
117117
| ---- | --------------- | ----------- | ----------- |
118-
| `container.memory.limit.utilization` | ObservableGauge | `1` | The memory consumption of the running containerized application relative to resource limit in range `[0, 1]`. |
118+
| `container.memory.limit.utilization` | <xref:System.Diagnostics.Metrics.ObservableGauge`1> | `1` | The memory consumption of the running containerized application relative to resource limit in range `[0, 1]`. |
119119

120120
Available starting in `Microsoft.Extensions.Diagnostics.ResourceMonitoring` 8.8.0.
121121

@@ -125,35 +125,35 @@ The instrument is only available on a system running on containers either on Win
125125

126126
| Name | Instrument Type | Unit (UCUM) | Description |
127127
| ---- | --------------- | ----------- | ----------- |
128-
| `container.memory.usage` | ObservableUpDownCounter | `By` | Memory usage of all processes in the container measured in bytes. |
128+
| `container.memory.usage` | <xref:System.Diagnostics.Metrics.ObservableUpDownCounter`1> | `By` | Memory usage of all processes in the container measured in bytes. |
129129

130130
Available starting in `Microsoft.Extensions.Diagnostics.ResourceMonitoring` 9.8.0.
131131

132132
##### Metric: `process.cpu.utilization`
133133

134134
| Name | Instrument Type | Unit (UCUM) | Description |
135135
| ---- | --------------- | ----------- | ----------- |
136-
| `process.cpu.utilization` | ObservableGauge | `1` | The CPU consumption of the running application in range `[0, 1]`. |
136+
| `process.cpu.utilization` | <xref:System.Diagnostics.Metrics.ObservableGauge`1> | `1` | The CPU consumption of the running application in range `[0, 1]`. |
137137

138-
Available starting in: .NET 8.0.
138+
Available starting in: .NET 8.
139139

140140
##### Metric: `dotnet.process.memory.virtual.utilization`
141141

142142
| Name | Instrument Type | Unit (UCUM) | Description |
143143
| ---- | --------------- | ----------- | ----------- |
144-
| `dotnet.process.memory.virtual.utilization` | ObservableGauge | `1` | The memory consumption of the running application in range `[0, 1]`. |
144+
| `dotnet.process.memory.virtual.utilization` | <xref:System.Diagnostics.Metrics.ObservableGauge`1> | `1` | The memory consumption of the running application in range `[0, 1]`. |
145145

146-
Available starting in: .NET 8.0.
146+
Available starting in: .NET 8.
147147

148148
##### Metric: `system.network.connections`
149149

150150
| Name | Instrument Type | Unit (UCUM) | Description |
151151
| ---- | --------------- | ----------- | ----------- |
152-
| `system.network.connections` | ObservableUpDownCounter | `{connection}` | Number of network connections by state. |
152+
| `system.network.connections` | <xref:System.Diagnostics.Metrics.ObservableUpDownCounter`1> | `{connection}` | Number of network connections by state. |
153153

154-
| Attribute | Type | Description | Examples | Presence |
155-
|---|---|---|---|---|
156-
| `network.type` | string | OSI network layer or non-OSI equivalent. | `ipv4`; `ipv6` | Always |
157-
| `system.network.state` | string | The state of a network connection. | `close`; `listen` | Always |
154+
| Attribute | Type | Description | Examples | Presence |
155+
|------------------------|----------|------------------------------------------|-------------------|----------|
156+
| `network.type` | `string` | OSI network layer or non-OSI equivalent. | `ipv4`; `ipv6` | Always |
157+
| `system.network.state` | `string` | The state of a network connection. | `close`; `listen` | Always |
158158

159-
Available starting in: .NET 8.0.
159+
Available starting in: .NET 8.

0 commit comments

Comments
 (0)