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

Posted 2022-11-29 dotNET跨平台

今天在浏览张队转载文章的留言时，遇到一个读者问了这样的问题，如下图所示：首先能明确的一点是"程序崩溃退出了是不能用常规的方式 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 的总数量

当然也可以使用 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。最后在对应的目录下，也生成了 Dump 文件。

如果是在容器环境中的话，直接修改 Dockerfile 即可，如下所示的那样：

如果在容器环境中，DOTNET_DbgMiniDumpName需要配置映射到 Host 的目录，不然容器退出，Dump 文件也会随之消失。

总结

本文主要是介绍了如何在 dotNet 程序崩溃时自动创建 Dump，Windows 上的方法对于.NET Freamwork 和.NET Core 版本都适用。.NET Core 全平台版本的话需要注意环境变量支持的.NET 版本。

参考文献

• https://learn.microsoft.com/en-us/troubleshoot/developer/webapps/aspnetcore/practice-troubleshoot-linux/lab-1-3-capture-core-crash-dumps

• https://www.meziantou.net/tip-automatically-create-a-crash-dump-file-on-error.htm

• https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/botr/xplat-minidump-generation.md