Skip to content

Commit ff617d9

Browse files
authored
EventPipe diagnostics article updates (#36242)
1 parent 01aaea0 commit ff617d9

File tree

3 files changed

+14
-16
lines changed

3 files changed

+14
-16
lines changed

.github/workflows/blazor-hybrid-issue-processing.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
issue_number: context.issue.number,
1818
owner: context.repo.owner,
1919
repo: context.repo.repo,
20-
body: `### 🏖️🌞 **_Summertime!! Woot!!_** 🏐⛵
20+
body: `### 🧟💀 ***Happy Halloween!!*** 🎃🧛
2121
2222
A green dinosaur 🦖 will be along shortly to assist. *Stand-by ........*`
2323
})

.github/workflows/blazor-issue-processing.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
issue_number: context.issue.number,
2424
owner: context.repo.owner,
2525
repo: context.repo.repo,
26-
body: `### 🧟💀 *Happy Halloween!!_** 🎃🧛
26+
body: `### 🧟💀 ***Happy Halloween!!*** 🎃🧛
2727
2828
*Stand-by!* ... A green dinosaur 🦖 will be along shortly to assist.`
2929
})

aspnetcore/blazor/performance/webassembly-event-pipe-diagnostics.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn about Event Pipe diagnostics and how to get a Garbage Collect
55
monikerRange: '>= aspnetcore-10.0'
66
ms.author: wpickett
77
ms.custom: mvc
8-
ms.date: 06/04/2025
8+
ms.date: 10/21/2025
99
uid: blazor/performance/webassembly-event-pipe
1010
---
1111
# ASP.NET Core Blazor WebAssembly Event Pipe diagnostics
@@ -31,14 +31,13 @@ dotnet workload install wasm-tools
3131
In the app's project file (`.csproj`), add following properties for the duration of the investigation:
3232

3333
```xml
34-
<!-- do not enable diagnostics in production, as it has a negative performance impact -->
3534
<PropertyGroup>
3635
<EnableDiagnostics>true</EnableDiagnostics>
3736
</PropertyGroup>
3837
```
3938

4039
> [!WARNING]
41-
> Don't enable diagnostics in production because it has a negative performance impact.
40+
> Don't enable diagnostics in production because it has a negative performance impact.
4241
4342
Build your app with the `wasm-tools` workload.
4443

@@ -50,9 +49,9 @@ Take a managed memory dump by calling `collectGcDump` JavaScript API:
5049
globalThis.getDotnetRuntime(0).collectGcDump();
5150
```
5251

53-
Call the preceding API from either a browser devoloper tools console or JavaScript code of the app.
52+
Call the preceding API from either a browser developer tools console or JavaScript code of the app.
5453

55-
A `.nettrace` file is downloaded from the browser into a local folder.
54+
A `.nettrace` file is downloaded from the browser into a local folder, usually the `Downloads` folder on Windows.
5655

5756
Convert the dump to `.gcdump` format using the `dotnet-gcdump` tool. To view the converted `.gcdump` file, use Visual Studio or PrefView.
5857

@@ -63,12 +62,11 @@ For more information, see [View the GC dump captured from dotnet-gcdump](/dotnet
6362
In the app's project file (`.csproj`), add following properties for the duration of the investigation:
6463

6564
```xml
66-
<!-- do not enable diagnostics in production, as it has a negative performance impact -->
6765
<PropertyGroup>
6866
<EnableDiagnostics>true</EnableDiagnostics>
69-
<!-- disable debugger -->
67+
<!-- Disable debugger -->
7068
<WasmDebugLevel>0</WasmDebugLevel>
71-
<!-- sampling in all methods, see below for filtering options -->
69+
<!-- Sampling in all methods, see below for filtering options -->
7270
<WasmPerformanceInstrumentation>all</WasmPerformanceInstrumentation>
7371
</PropertyGroup>
7472
```
@@ -86,11 +84,11 @@ Start colllecting CPU samples for 60 seconds by calling the `collectCpuSamples`
8684
globalThis.getDotnetRuntime(0).collectCpuSamples({durationSeconds: 60});
8785
```
8886

89-
Call the preceding API from either a browser devoloper tools console or JavaScript code of the app.
87+
Call the preceding API from either a browser developer tools console or JavaScript code of the app.
9088

9189
Start using the app to run problematic code.
9290

93-
After the predefined period, the browser downloads a `.nettrace` file into a local folder. To view the `.nettrace` file, use Visual Studio or PrefView.
91+
After the predefined period, the browser downloads a `.nettrace` file into a local folder, usually the `Downloads` folder on Windows. To view the `.nettrace` file, use Visual Studio or PrefView.
9492

9593
For more information, see [Use EventPipe to trace your .NET application](/dotnet/core/diagnostics/eventpipe#use-eventpipe-to-trace-your-net-application).
9694

@@ -101,7 +99,6 @@ The [`Timing-Allow-Origin` HTTP header](https://developer.mozilla.org/docs/Web/H
10199
In the app's project file (`.csproj`), add following properties for the duration of the investigation:
102100

103101
```xml
104-
<!-- do not enable diagnostics in production, as it has a negative performance impact -->
105102
<PropertyGroup>
106103
<EnableDiagnostics>true</EnableDiagnostics>
107104
<MetricsSupport>true</MetricsSupport>
@@ -122,9 +119,9 @@ Start colllecting metrics for 60 seconds by calling the `collectMetrics` JavaScr
122119
globalThis.getDotnetRuntime(0).collectMetrics({durationSeconds: 60});
123120
```
124121

125-
Call the preceding API from either a browser devoloper tools console or JavaScript code of the app.
122+
Call the preceding API from either a browser developer tools console or JavaScript code of the app.
126123

127-
After the predefined period, the browser downloads a `.nettrace` file into a local folder. To view the `.nettrace` file, use Visual Studio or PrefView.
124+
After the predefined period, the browser downloads a `.nettrace` file into a local folder, usually the `Downloads` folder on Windows. To view the `.nettrace` file, use Visual Studio or PrefView.
128125

129126
For more information, see [Use EventPipe to trace your .NET application](/dotnet/core/diagnostics/eventpipe#use-eventpipe-to-trace-your-net-application).
130127

@@ -152,7 +149,8 @@ The following table describes permissable `<WasmPerformanceInstrumentation>` val
152149

153150
Your code should yield to main browser loop often to allow the trace to be collected. When executing long running loops, the internal diagnostic buffers could overflow.
154151

155-
**Enabling profilers and diagnostic tools has negative size and performance impacts, so don't publish an app for production with profilers enabled.**
152+
> [!CAUTION]
153+
> Enabling profilers and diagnostic tools has negative size and performance impacts, so don't publish an app for production with profilers enabled.
156154
157155
## Additional resources
158156

0 commit comments

Comments
 (0)