在.NET程序崩溃时自动创建Dump的思路详解_Asp.net

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

首先能明确的一点是"程序崩溃退出了是不能用常规的方式dump的"，因为整个进程树都已经退出。现场已经无法使用常规的方式读取到。

一般来说常规的方法是没办法读取到的，也有一些特殊的方式，比如有关部门在调查取证时，就可以通过一些工具读取到内存中的信息。当然这是一些hack手段，不在本文讨论中。

不过好消息是，虽然您无法在程序崩溃退出以后创建dump，但是您可以在程序崩溃时自动创建dump，这样下次遇到程序崩溃，那么就可以有分析的现场了。

windows平台

在 windows 中，可以将 windows 错误报告（wer）配置为在应用程序崩溃时生成转储。

这个方式对所有程序都有效果，不仅仅是.net程序，如c++、go等等都可以；而且和.net、.net core版本无关

打开regedit.exe
打开目录hkey_local_machine\software\microsoft\windows\windows error reporting\localdumps
创建key dumpfolder 类型为reg_expand_sz用于配置存放dump文件的目录
另外可以创建key dumpcount 类型为reg_dword配置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 expandstring

new-itemproperty -path "hklm:\software\microsoft\windows\windows error reporting\localdumps" -name "dumpcount" -value 10 -propertytype dword

按照上面的配置，如果程序发生了异常退出，那么就会在%localappdata%\crashdumps目录创建程序的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的说明如下所示：

1: mini 小型dump，其中包含模块列表、线程列表、异常信息和所有堆栈。
2: heap 大型且相对全面的dump，其中包含模块列表、线程列表、所有堆栈、异常信息、句柄信息和除映射图像以外的所有内存。
3: triage 与 mini 相同，但会删除个人用户信息，如路径和密码。
4: full 最大的转储，包含所有内存（包括模块映像）。

一般情况下，我们会配置下面的环境变量：

dotnet_dbgenableminidump = 1
dotnet_dbgminidumpname = [有权限的path目录]
dotnet_createdumpdiagnostics = 1
dotnet_enablecrashreport = 1

试一试

我们写一段代码来试一把，如下有一段代码首先输出了当前dtonet_前缀对的环境变量，然后抛出一个异常。

using system.collections;

foreach (dictionaryentry environmentvariable in environment.getenvironmentvariables())
{
    if(environmentvariable.key.tostring()?.startswith("dotnet_") == false) continue;
    console.writeline($"{environmentvariable.key}={environmentvariable.value}");
}

throw new exception("crash");

然后编写一个run.bat脚本，用于设置环境变量顺便启动我们的程序。

@set dotnet_dbgenableminidump=1
@set dotnet_dbgminidumpname="g:\temp\crashdump\crashdump\bin\debug\net6.0\dump.dmp"
@set dotnet_createdumpdiagnostics=1
@set dotnet_enablecrashreport=1

@crashdump.exe

运行run.bat可以看到环境变量正确的读到了，另外也成功的生成了dump。