Skip to content

Commit 0e92e7f

Browse files
authored
Warn about dotnet-dump memory usage (#45841)
There has been a long known issue ( dotnet/runtime#71472 ) that dotnet-dump increases memory usage, sometimes substantially. We haven't identified any quick/easy solution to reduce that memory usage so far. I want to make sure users are aware of it as a known limitation when working with the tool.
1 parent 8333f50 commit 0e92e7f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/core/diagnostics/dotnet-dump.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,11 @@ dotnet-dump collect [-h|--help] [-p|--process-id] [-n|--name] [--type] [-o|--out
123123
> [!NOTE]
124124
> To collect a dump using `dotnet-dump`, 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.
125125
126+
> [!NOTE]
127+
> Collecting a full or heap dump may cause the OS to page in substantial virtual memory for the target process. If the target process is running in a container with an enforced memory limit, the increased memory usage
128+
> may cause the OS to terminate the container if the limit was exceeded. We recommend testing to ensure the memory limit is set high enough. Another option is to temporarily change or remove the limit
129+
> prior to dump collection if your environment supports doing so.
130+
126131
## dotnet-dump analyze
127132

128133
Starts an interactive shell to explore a dump. The shell accepts various [SOS commands](#analyze-sos-commands).

0 commit comments

Comments
 (0)