Skip to content

Commit d8acfcd

Browse files
authored
fix build suggestions (#48467)
1 parent 77bca5f commit d8acfcd

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

docs/core/compatibility/cryptography/10.0/mldsa-slhdsa-secretkey-to-privatekey.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ byte[] output = new byte[targetSize];
4444

4545
## Affected APIs
4646

47-
- <xref:System.Security.Cryptography.MLDsa.ImportMLDsaSecretKey*?displayProperty=fullName>
48-
- <xref:System.Security.Cryptography.MLDsa.ExportMLDsaSecretKey*?displayProperty=fullName>
49-
- <xref:System.Security.Cryptography.MLDsaAlgorithm.SecretKeySizeInBytes?displayProperty=fullName>
50-
- <xref:System.Security.Cryptography.SlhDsa.ImportSlhDsaSecretKey*?displayProperty=fullName>
51-
- <xref:System.Security.Cryptography.SlhDsa.ExportSlhDsaSecretKey*?displayProperty=fullName>
52-
- <xref:System.Security.Cryptography.SlhDsaAlgorithm.SecretKeySizeInBytes?displayProperty=fullName>
47+
- `System.Security.Cryptography.MLDsa.ImportMLDsaSecretKey()`
48+
- `System.Security.Cryptography.MLDsa.ExportMLDsaSecretKey()`
49+
- `System.Security.Cryptography.MLDsaAlgorithm.SecretKeySizeInBytes`
50+
- `System.Security.Cryptography.SlhDsa.ImportSlhDsaSecretKey()`
51+
- `System.Security.Cryptography.SlhDsa.ExportSlhDsaSecretKey()`
52+
- `System.Security.Cryptography.SlhDsaAlgorithm.SecretKeySizeInBytes`

docs/core/diagnostics/dotnet-counters.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ dotnet-counters [-h|--help] [--version] <command>
4848

4949
- **`--version`**
5050

51-
Displays the version of the dotnet-counters utility.
51+
Displays the version of the `dotnet-counters` utility.
5252

5353
- **`-h|--help`**
5454

@@ -90,15 +90,15 @@ dotnet-counters collect [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
9090
9191
- **`--diagnostic-port <port-address[,(listen|connect)]>`**
9292

93-
Sets the [diagnostic port](diagnostic-port.md) used to communicate with the process to be monitored. dotnet-counters and the .NET runtime inside the target process must agree on the port-address, with one listening and the other connecting. dotnet-counters automatically determines the correct port when attaching using the `--process-id` or `--name` options, or when launching a process using the `-- <command>` option. It's usually only necessary to specify the port explicitly when waiting for a process that will start in the future or communicating to a process that is running inside a container that isn't part of the current process namespace.
93+
Sets the [diagnostic port](diagnostic-port.md) used to communicate with the process to be monitored. `dotnet-counters` and the .NET runtime inside the target process must agree on the port-address, with one listening and the other connecting. `dotnet-counters` automatically determines the correct port when attaching using the `--process-id` or `--name` options, or when launching a process using the `-- <command>` option. It's usually only necessary to specify the port explicitly when waiting for a process that will start in the future or communicating to a process that's running inside a container that isn't part of the current process namespace.
9494

9595
The `port-address` differs by OS:
9696

9797
- Linux and macOS - a path to a Unix domain socket such as `/foo/tool1.socket`.
9898
- Windows - a path to a named pipe such as `\\.\pipe\my_diag_port1`.
9999
- Android, iOS, and tvOS - an IP:port such as `127.0.0.1:9000`.
100-
101-
By default, dotnet-counters listens at the specified address. You can request dotnet-counters to connect instead by appending `,connect` after the address. For example, `--diagnostic-port /foo/tool1.socket,connect` will connect to a .NET runtime process that's listening to the `/foo/tool1.socket` Unix domain socket.
100+
101+
By default, `dotnet-counters` listens at the specified address. You can request `dotnet-counters` to connect instead by appending `,connect` after the address. For example, `--diagnostic-port /foo/tool1.socket,connect` will connect to a .NET runtime process that's listening to the `/foo/tool1.socket` Unix domain socket.
102102

103103
For information about how to use this option to start monitoring counters from app startup, see [using diagnostic port](#using-diagnostic-port).
104104

@@ -108,7 +108,7 @@ dotnet-counters collect [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
108108

109109
- **`--counters <COUNTERS>`**
110110

111-
A comma-separated list of counters. Counters can be specified `provider_name[:counter_name]`. If the `provider_name` is used without a qualifying list of counters, then all counters from the provider are shown. To discover provider and counter names, consult [built-in metrics docs](https://learn.microsoft.com/dotnet/core/diagnostics/built-in-metrics). For [EventCounters](event-counters.md), `provider_name` is the name of the EventSource and for [Meters](metrics.md), `provider_name` is the name of the Meter.
111+
A comma-separated list of counters. Counters can be specified `provider_name[:counter_name]`. If the `provider_name` is used without a qualifying list of counters, then all counters from the provider are shown. To discover provider and counter names, see [built-in metrics](built-in-metrics.md). For [EventCounters](event-counters.md), `provider_name` is the name of the EventSource and for [Meters](metrics.md), `provider_name` is the name of the Meter.
112112

113113
- **`--format <csv|json>`**
114114

@@ -120,13 +120,13 @@ dotnet-counters collect [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
120120

121121
- **`-- <command>`**
122122

123-
After the collection configuration parameters, the user can append `--` followed by a command to start a .NET application. `dotnet-counters` will launch a process with the provided command and collect the requested metrics. This is often useful to collect metrics for the application's startup path and can be used to diagnose or monitor issues that happen early before or shortly after the main entrypoint.
123+
After the collection configuration parameters, the user can append `--` followed by a command to start a .NET application. `dotnet-counters` launches a process with the provided command and collect the requested metrics. This is often useful to collect metrics for the application's startup path and can be used to diagnose or monitor issues that happen early before or shortly after the main entry point.
124124

125125
> [!NOTE]
126-
> Using this option monitors the first .NET process that communicates back to the tool, which means if your command launches multiple .NET applications, it will only collect the first app. Therefore, it is recommended you use this option on self-contained applications, or using the `dotnet exec <app.dll>` option.
126+
> Using this option monitors the first .NET process that communicates back to the tool, which means if your command launches multiple .NET applications, it will only collect the first app. Therefore, it's recommended you use this option on self-contained applications, or using the `dotnet exec <app.dll>` option.
127127
128128
> [!NOTE]
129-
> Launching a .NET executable via dotnet-counters will redirect its input/output and you won't be able to interact with its stdin/stdout. Exiting the tool via CTRL+C or SIGTERM will safely end both the tool and the child process. If the child process exits before the tool, the tool will exit as well. If you need to use stdin/stdout, you can use the `--diagnostic-port` option. See [Using diagnostic port](#using-diagnostic-port) for more information.
129+
> If you launch a .NET executable via `dotnet-counters`, its input/output will be redirected and you won't be able to interact with its stdin/stdout. You can exit the tool via <kbd>Ctrl+C</kbd> or SIGTERM to safely end both the tool and the child process. If the child process exits before the tool, the tool will exit as well. If you need to use stdin/stdout, you can use the `--diagnostic-port` option. For more information, see [Using diagnostic port](#using-diagnostic-port).
130130
131131
> [!NOTE]
132132
> To collect metrics using `dotnet-counters`, it needs to be run as the same user as the user running target process or as root. Otherwise, the tool will fail to establish a connection with the target process.
@@ -180,17 +180,17 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
180180

181181
- **`--counters <COUNTERS>`**
182182

183-
A comma-separated list of counters. Counters can be specified `provider_name[:counter_name]`. If the `provider_name` is used without a qualifying list of counters, then all counters from the provider are shown. To discover provider and counter names, consult [built-in metrics docs](https://learn.microsoft.com/dotnet/core/diagnostics/built-in-metrics). For [EventCounters](event-counters.md), `provider_name` is the name of the EventSource and for [Meters](metrics.md), `provider_name` is the name of the Meter.
183+
A comma-separated list of counters. Counters can be specified `provider_name[:counter_name]`. If the `provider_name` is used without a qualifying list of counters, then all counters from the provider are shown. To discover provider and counter names, see [built-in metrics](built-in-metrics.md). For [EventCounters](event-counters.md), `provider_name` is the name of the EventSource and for [Meters](metrics.md), `provider_name` is the name of the Meter.
184184

185185
**`-- <command>`**
186186

187-
After the collection configuration parameters, the user can append `--` followed by a command to start a .NET application. `dotnet-counters` will launch a process with the provided command and monitor the requested metrics. This is often useful to collect metrics for the application's startup path and can be used to diagnose or monitor issues that happen early before or shortly after the main entrypoint.
187+
After the collection configuration parameters, you can append `--` followed by a command to start a .NET application. `dotnet-counters` will launch a process with the provided command and monitor the requested metrics. This is often useful to collect metrics for the application's startup path and can be used to diagnose or monitor issues that happen early before or shortly after the main entry point.
188188

189189
> [!NOTE]
190-
> Using this option monitors the first .NET process that communicates back to the tool, which means if your command launches multiple .NET applications, it will only collect the first app. Therefore, it is recommended you use this option on self-contained applications, or using the `dotnet exec <app.dll>` option.
190+
> Using this option monitors the first .NET process that communicates back to the tool, which means if your command launches multiple .NET applications, it will only collect the first app. Therefore, it's recommended you use this option on self-contained applications, or using the `dotnet exec <app.dll>` option.
191191
192192
> [!NOTE]
193-
> Launching a .NET executable via dotnet-counters will redirect its input/output and you won't be able to interact with its stdin/stdout. Exiting the tool via CTRL+C or SIGTERM will safely end both the tool and the child process. If the child process exits before the tool, the tool will exit as well. If you need to use stdin/stdout, you can use the `--diagnostic-port` option. See [Using diagnostic port](#using-diagnostic-port) for more information.
193+
> Launching a .NET executable via `dotnet-counters` will redirect its input/output and you won't be able to interact with its stdin/stdout. You can exit the tool via <kbd>Ctrl+C</kbd> or SIGTERM to safely end both the tool and the child process. If the child process exits before the tool, the tool will exit as well. If you need to use stdin/stdout, you can use the `--diagnostic-port` option. For more information, see [Using diagnostic port](#using-diagnostic-port).
194194
195195
> [!NOTE]
196196
> On Linux and macOS, this command expects the target application and `dotnet-counters` to share the same `TMPDIR` environment variable.
@@ -199,7 +199,7 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
199199
> To monitor metrics using `dotnet-counters`, it needs to be run as the same user as the user running target process or as root.
200200
201201
> [!NOTE]
202-
> If you see an error message similar to the following one: `[ERROR] System.ComponentModel.Win32Exception (299): A 32 bit processes cannot access modules of a 64 bit process.`, you are trying to use `dotnet-counters` that has mismatched bitness against the target process. Make sure to download the correct bitness of the tool in the [install](#install) link.
202+
> If you see an error message similar to the following one: `[ERROR] System.ComponentModel.Win32Exception (299): A 32 bit processes cannot access modules of a 64 bit process.`, you're trying to use `dotnet-counters` that has mismatched bitness against the target process. Make sure to download the correct bitness of the tool in the [install](#install) link.
203203
204204
### Examples
205205

@@ -255,9 +255,9 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
255255
```
256256

257257
> [!NOTE]
258-
> If the app uses .NET version 8 or lower the [System.Runtime Meter](https://learn.microsoft.com/dotnet/core/diagnostics/built-in-metrics-runtime#systemruntime) didn't exist yet and dotnet-counters will fall back to display the older [System.Runtime EventCounters](https://learn.microsoft.com/dotnet/core/diagnostics/available-counters#systemruntime-counters) instead. The UI will look slightly different as shown below.
258+
> If the app uses .NET version 8 or lower, the [System.Runtime Meter](built-in-metrics-runtime.md#systemruntime) doesn't exist in those versions and `dotnet-counters` will fall back to display the older [System.Runtime EventCounters](available-counters.md#systemruntime-counters) instead. The UI looks slightly different, as shown here.
259259
260-
```
260+
```output
261261
[System.Runtime]
262262
% Time in GC since last GC (%) 0
263263
Allocation Rate (B / 1 sec) 5,376
@@ -284,10 +284,10 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
284284
Working Set (MB) 19
285285
```
286286

287-
- Monitor just GC collections and GC heap allocation from `System.Runtime`:
287+
- Monitor just garbage collections and garbage collection heap allocation from `System.Runtime`:
288288

289289
```dotnetcli
290-
> dotnet-counters monitor --process-id 1902 --counters System.Runtime[dotnet.gc.collections,dotnet.gc.heap.total_allocated]
290+
> dotnet-counters monitor --process-id 1902 --counters System.Runtime[dotnet.gc.collections,dotnet.gc.heap.total_allocated]
291291
292292
Press p to pause, r to resume, q to quit.
293293
Status: Running
@@ -324,7 +324,7 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
324324
[System.Runtime]
325325
dotnet.assembly.count ({assembly}) 11
326326
```
327-
327+
328328
- Launch `my-aspnet-server.exe` with `arg1` and `arg2` as command-line arguments and monitor its working set and GC heap size from its startup:
329329

330330
```dotnetcli
@@ -348,8 +348,8 @@ dotnet-counters monitor [-h|--help] [-p|--process-id] [-n|--name] [--diagnostic-
348348

349349
## dotnet-counters ps
350350

351-
Lists the dotnet processes that can be monitored by `dotnet-counters`.
352-
`dotnet-counters` version 6.0.320703 and later, also display the command-line arguments that each process was started with, if available.
351+
Lists the dotnet processes that can be monitored by `dotnet-counters`.
352+
`dotnet-counters` version 6.0.320703 and later also displays the command-line arguments that each process was started with, if available.
353353

354354
### Synopsis
355355

@@ -359,24 +359,24 @@ dotnet-counters ps [-h|--help]
359359

360360
### Example
361361

362-
Suppose you start a long-running app using the command ```dotnet run --configuration Release```. In another window, you run the ```dotnet-counters ps``` command. The output you'll see is as follows. The command-line arguments, if any, are shown in `dotnet-counters` version 6.0.320703 and later.
362+
Suppose you start a long-running app using the command ```dotnet run --configuration Release```. In another window, you run the ```dotnet-counters ps``` command. The output you see is as follows. The command-line arguments, if any, are shown in `dotnet-counters` version 6.0.320703 and later.
363363

364364
```dotnetcli
365365
> dotnet-counters ps
366-
366+
367367
21932 dotnet C:\Program Files\dotnet\dotnet.exe run --configuration Release
368368
36656 dotnet C:\Program Files\dotnet\dotnet.exe
369369
```
370370

371371
## Using diagnostic port
372372

373-
[Diagnostic port](./diagnostic-port.md) is a runtime feature that allows you to start monitoring or collecting counters from app startup. To do this using `dotnet-counters`, you can either use `dotnet-counters <collect|monitor> -- <command>` as described in the examples above, or use the `--diagnostic-port` option.
373+
[Diagnostic port](./diagnostic-port.md) is a runtime feature that allows you to start monitoring or collecting counters from app startup. To do this using `dotnet-counters`, you can either use `dotnet-counters <collect|monitor> -- <command>` as described in the previous examples, or use the `--diagnostic-port` option.
374374

375375
Using `dotnet-counters <collect|monitor> -- <command>` to launch the application as a child process is the simplest way to quickly monitor it from its startup.
376376

377377
However, when you want to gain a finer control over the lifetime of the app being monitored (for example, monitor the app for the first 10 minutes only and continue executing) or if you need to interact with the app using the CLI, using `--diagnostic-port` option allows you to control both the target app being monitored and `dotnet-counters`.
378378

379-
1. The command below makes dotnet-counters create a diagnostics socket named `myport.sock` and wait for a connection.
379+
1. The following command makes `dotnet-counters` create a diagnostics socket named `myport.sock` and wait for a connection.
380380

381381
> ```dotnetcli
382382
> dotnet-counters collect --diagnostic-port myport.sock
@@ -396,7 +396,7 @@ However, when you want to gain a finer control over the lifetime of the app bein
396396
> ./my-dotnet-app arg1 arg2
397397
> ```
398398
399-
This should then enable `dotnet-counters` to start collecting counters on `my-dotnet-app`:
399+
This enables `dotnet-counters` to start collecting counters on `my-dotnet-app`:
400400
401401
> ```output
402402
> Waiting for connection on myport.sock
@@ -405,4 +405,4 @@ However, when you want to gain a finer control over the lifetime of the app bein
405405
> ```
406406
407407
> [!IMPORTANT]
408-
> Launching your app with `dotnet run` can be problematic because the dotnet CLI may spawn many child processes that are not your app and they can connect to `dotnet-counters` before your app, leaving your app to be suspended at run time. It is recommended you directly use a self-contained version of the app or use `dotnet exec` to launch the application.
408+
> Launching your app with `dotnet run` can be problematic because the dotnet CLI might spawn many child processes that aren't your app and they can connect to `dotnet-counters` before your app, leaving your app to be suspended at run time. It's recommended you directly use a self-contained version of the app or use `dotnet exec` to launch the application.

0 commit comments

Comments
 (0)