Skip to content

dotnet dump docs: mention Triage dump type #47107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

skarfie123
Copy link

@skarfie123 skarfie123 commented Jul 5, 2025

Summary

Add the Triage dump type to the dotnet dump docs page with the help text as shown in the CLI.

Fixes #47106

❯ dotnet dump collect -h
Description:
  Capture dumps from a process

Usage:
  dotnet-dump collect [options]

Options:
  -p, --process-id                The process id to collect a memory dump.
  -o, --output                    The path where collected dumps should be written. Defaults to
                                  '.\dump_YYYYMMDD_HHMMSS.dmp' on Windows and './core_YYYYMMDD_HHMMSS'
                                  on Linux where YYYYMMDD is Year/Month/Day and HHMMSS is Hour/Minute/Second.
                                  Otherwise, it is the full path and file name of the dump.
  --diag                          Enable dump collection diagnostic logging.
  --crashreport                   Enable crash report generation.
  --type <Full|Heap|Mini|Triage>  The dump type determines the kinds of information that are collected from the
                                  process. There are several types: Full - The largest dump containing all memory
                                  including the module images. Heap - A large and relatively comprehensive dump
                                  containing module lists, thread lists, all stacks, exception information, handle
                                  information, and all memory except for mapped images. Mini - A small dump containing
                                  module lists, thread lists, exception information and all stacks. Triage - A small
                                  dump containing module lists, thread lists, exception information, all stacks and PII
                                  removed. [default: Full]
  -n, --name                      The name of the process to collect a memory dump.
  --diagnostic-port, --dport      The path to a diagnostic port to be used. Must be a runtime connect port.
  -?, -h, --help                  Show help and usage information

Internal previews

📄 File 🔗 Preview link
docs/core/diagnostics/dotnet-dump.md docs/core/diagnostics/dotnet-dump

@skarfie123 skarfie123 requested review from tommcdon and a team as code owners July 5, 2025 10:47
@dotnetrepoman dotnetrepoman bot added this to the July 2025 milestone Jul 5, 2025
@dotnet-policy-service dotnet-policy-service bot added dotnet-fundamentals/svc community-contribution Indicates PR is created by someone from the .NET community. labels Jul 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-fundamentals/svc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dotnet dump docs doesn't mention Triage dump type
1 participant