如何在.NET程式崩潰時自動創建Dump？

2022 年 11 月 2 日
筆記
.NET, c#, 診斷與調試

今天在瀏覽張隊轉載文章的留言時，遇到一個讀者問了這樣的問題，如下圖所示：

首先能明確的一點是”程式崩潰退出了是不能用常規的方式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。

最後在對應的目錄下，也生成了Dump文件。

如果是在容器環境中的話，直接修改Dockerfile即可，如下所示的那樣：

如果在容器環境中，DOTNET_DbgMiniDumpName需要配置映射到Host的目錄，不然容器退出，Dump文件也會隨之消失。

總結

本文主要是介紹了如何在dotNet程式崩潰時自動創建Dump，Windows上的方法對於.NET Freamwork和.NET Core版本都適用。.NET Core全平台版本的話需要注意環境變數支援的.NET版本。

參考文獻

Tags: .NET c# 診斷與調試