在.NET程序崩潰時自動創建Dump的思路詳解
目錄
- Windows平臺
- .NET Core全平臺
- 試一試
- 總結
- 參考文獻
今天在瀏覽張隊轉載文章的留言時，遇到一個讀者問了這樣的問題，如下圖所示：
首先能明確的一點是"程序崩潰退出了是不能用常規的方式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 ExpandStringNew-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生成。默認值為：0COMPlus_DbgMiniDumpType或DOTNET_DbgMiniDumpType: 要收集的轉儲類型。 有關詳細信息，請看下文的說明。默認值為：2COMPlus_DbgMiniDumpName或DOTNET_DbgMiniDumpName: 寫入轉儲的文件路徑。 確保運行 dotnet 進程的用戶具有指定目錄的寫入權限。默認值為：/tmp/coredump.<pid>COMPlus_CreateDumpDiagnostics或DOTNET_CreateDumpDiagnostics: 如果設置為 1，則啟用轉儲進程的診斷日志記錄。默認值為：0COMPlus_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 = 1DOTNET_DbgMiniDumpName = [有權限的Path目錄]DOTNET_CreateDumpDiagnostics = 1DOTNET_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
到此這篇關于如何在.NET程序崩潰時自動創建Dump的文章就介紹到這了,更多相關.net程序崩潰自動創建Dump內容請搜索以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持！
網公網安備