Skip to content

Commit 055dea7

Browse files
sdmacleamairaw
authored andcommitted
Update the diagnostic scenarios sample target readme (#1857)
* Update the diagnostic scenarios sample target readme * Update readme.md
1 parent acb8e8b commit 055dea7

File tree

1 file changed

+17
-8
lines changed
  • core/diagnostics/DiagnosticScenarios

1 file changed

+17
-8
lines changed

core/diagnostics/DiagnosticScenarios/readme.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,47 @@ languages:
44
products:
55
- dotnet-core
66
page_type: sample
7-
name: "Diagnostic Scenarios"
7+
name: "Diagnostic scenarios sample debug target"
88
urlFragment: "diagnostic-scenarios"
99
description: "A .NET Core sample with methods that trigger undesirable behaviors to diagnose."
1010
---
11-
# DiagnosticScenarios sample debug target
11+
# Diagnostic scenarios sample debug target
1212

13-
This sample is for the [diagnostics tutorials](https://docs.microsoft.com/dotnet/core/diagnostics/tutorial/diagnostic-scenarios) in the .NET Core Guide.
13+
The sample debug target is a simple `webapi` application. The sample triggers undesirable behaviors for the [.NET Core diagnostics tutorials](https://docs.microsoft.com/dotnet/core/diagnostics/index#net-core-diagnostics-tutorials) to diagnose.
1414

15-
The scenarios are implemented using a `webapi` target with methods that trigger undesirable behaviors for us to diagnose.
15+
## Build and run the target
16+
17+
After downloading the source, you can easily run the webapi using:
18+
19+
```console
20+
dotnet build
21+
dotnet run
22+
```
1623

1724
## Target methods
1825

26+
The target triggers undesirable behaviors when hitting specific URLs.
27+
1928
### Deadlock
2029

21-
http://localhost:5000/api/diagscenario/deadlock
30+
`http://localhost:5000/api/diagscenario/deadlock`
2231

2332
This method will cause the target to hang and accumulate many threads.
2433

2534
### High CPU usage
2635

27-
http://localhost:5000/api/diagscenario/highcpu/{milliseconds}
36+
`http://localhost:5000/api/diagscenario/highcpu/{milliseconds}`
2837

2938
The method will cause to target to heavily use the CPU for a duration specified by {milliseconds}.
3039

3140
### Memory leak
3241

33-
http://localhost:5000/api/diagscenario/memleak/{kb}
42+
`http://localhost:5000/api/diagscenario/memleak/{kb}`
3443

3544
This method will cause the target to leak memory (amount specified by {kb}).
3645

3746
### Memory usage spike
3847

39-
http://localhost:5000/api/diagscenario/memspike/{seconds}
48+
`http://localhost:5000/api/diagscenario/memspike/{seconds}`
4049

4150
This method will cause intermittent memory spikes over the specified number of seconds. Memory will go from base line to spike and back to baseline several times.

0 commit comments

Comments
 (0)