如何在.NET程序崩溃时自动创建Dump?

今天在浏览张队转载文章的留言时,遇到一个读者问了这样的问题,如下图所示:

如何在.NET程序崩溃时自动创建Dump?

文章插图
首先能明确的一点是"程序崩溃退出了是不能用常规的方式dump的",因为整个进程树都已经退出 。现场已经无法使用常规的方式读取到 。
一般来说常规的方法是没办法读取到的 , 也有一些特殊的方式,比如有关部门在调查取证时,就可以通过一些工具读取到内存中的信息 。当然这是一些hack手段,不在本文讨论中 。
不过好消息是,虽然您无法在程序崩溃退出以后创建Dump,但是您可以在程序崩溃时自动创建Dump,这样下次遇到程序崩溃,那么就可以有分析的现场了 。
Windows平台在 Windows 中 , 可以将 Windows 错误报告 (WER) 配置为在应用程序崩溃时生成转储 。
这个方式对所有程序都有效果 , 不仅仅是.NET程序,如C++、Go等等都可以;而且和.NET、.NET Core版本无关
  1. 打开regedit.exe
  2. 打开目录HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps
  3. 创建KEY DumpFolder 类型为REG_EXPAND_SZ用于配置存放Dump文件的目录
  4. 另外可以创建KEY DumpCount 类型为REG_DWORD配置Dump的总数量
    如何在.NET程序崩溃时自动创建Dump?

    文章插图
当然也可以使用PowerShell命令来配置这些:
New-Item -Path "HKLM:\SOFTWARE\Microsoft\Windows\Windows Error Reporting" -Name "LocalDumps"New-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps" -Name "DumpFolder" -Value "%LOCALAPPDATA%\CrashDumps" -PropertyType ExpandStringNew-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps" -Name "DumpCount" -Value 10 -PropertyType DWord按照上面的配置,如果程序发生了异常退出 , 那么就会在%LOCALAPPDATA%\CrashDumps目录创建程序的Dump 。如下图所示:
如何在.NET程序崩溃时自动创建Dump?

文章插图
.NET Core全平台那么如果您是.NET Core跨平台应用 , 那么在Linux、MacOS等操作系统上,有更简单和更丰富的方式 , 下方有一些环境变量的参数:
  • COMPlus_DbgEnableMiniDump 或 DOTNET_DbgEnableMiniDump: 如果设置为 1,则发生故障时启用CoreDump生成 。默认值为:0
  • COMPlus_DbgMiniDumpType 或 DOTNET_DbgMiniDumpType: 要收集的转储类型 。有关详细信息,请看下文的说明 。默认值为:2
  • COMPlus_DbgMiniDumpName 或 DOTNET_DbgMiniDumpName: 写入转储的文件路径 。确保运行 dotnet 进程的用户具有指定目录的写入权限 。默认值为:/tmp/coredump.<pid>
  • COMPlus_CreateDumpDiagnostics 或 DOTNET_CreateDumpDiagnostics: 如果设置为 1,则启用转储进程的诊断日志记录 。默认值为:0
  • COMPlus_EnableCrashReport 或 DOTNET_EnableCrashReport:(需要.NET 6 或更高版本,目前仅Linux和MacOS可用)如果设为 1,运行时会生成 JSON 格式的故障报表,其中包括有关故障应用程序的线程和堆栈帧的信息 。故障报表名称是追加了 .crashreport.json 的转储路径/名称 。
  • COMPlus_CreateDumpVerboseDiagnostics 或 DOTNET_CreateDumpVerboseDiagnostics:(需要 .NET 7 或更高版本)如果设为 1,则启用转储进程的详细诊断日志记录 。
  • COMPlus_CreateDumpLogToFile 或 DOTNET_CreateDumpLogToFile:(需要 .NET 7 或更高版本)应写入诊断消息的文件路径 。如果未设置,则将诊断消息写入故障应用程序的控制台 。
对于这些环境变量,.NET 7 标准化前缀 DOTNET_,而不是 COMPlus_ 。但是,COMPlus_ 前缀仍将继续正常工作 。如果使用的是早期版本的 .NET 运行时,则环境变量仍应该使用 COMPlus_ 前缀 。
关于DOTNET_DbgMiniDumpType的说明如下所示: