目錄

• Windows平臺
• .NET Core全平臺
• 試一試
• 總結(jié)
• 參考文獻(xiàn)

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

首先能明確的一點是"程序崩潰退出了是不能用常規(guī)的方式dump的"，因為整個進(jìn)程樹都已經(jīng)退出。現(xiàn)場已經(jīng)無法使用常規(guī)的方式讀取到。

一般來說常規(guī)的方法是沒辦法讀取到的，也有一些特殊的方式，比如有關(guān)部門在調(diào)查取證時，就可以通過一些工具讀取到內(nèi)存中的信息。當(dāng)然這是一些hack手段，不在本文討論中。

不過好消息是，雖然您無法在程序崩潰退出以后創(chuàng)建Dump，但是您可以在程序崩潰時自動創(chuàng)建Dump，這樣下次遇到程序崩潰，那么就可以有分析的現(xiàn)場了。

Windows平臺

在 Windows 中，可以將 Windows 錯誤報告 （WER） 配置為在應(yīng)用程序崩潰時生成轉(zhuǎn)儲。

這個方式對所有程序都有效果，不僅僅是.NET程序，如C++、Go等等都可以；而且和.NET、.NET Core版本無關(guān)

• 打開regedit.exe
• 打開目錄HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps
• 創(chuàng)建KEY DumpFolder 類型為REG_EXPAND_SZ用于配置存放Dump文件的目錄
• 另外可以創(chuàng)建KEY DumpCount 類型為REG_DWORD配置Dump的總數(shù)量

當(dāng)然也可以使用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

按照上面的配置，如果程序發(fā)生了異常退出，那么就會在%LOCALAPPDATA%\CrashDumps目錄創(chuàng)建程序的Dump。如下圖所示：

.NET Core全平臺

那么如果您是.NET Core跨平臺應(yīng)用，那么在Linux、MacOS等操作系統(tǒng)上，有更簡單和更豐富的方式，下方有一些環(huán)境變量的參數(shù)：

• COMPlus_DbgEnableMiniDump 或 DOTNET_DbgEnableMiniDump: 如果設(shè)置為 1，則發(fā)生故障時啟用CoreDump生成。默認(rèn)值為：0
• COMPlus_DbgMiniDumpType 或 DOTNET_DbgMiniDumpType: 要收集的轉(zhuǎn)儲類型。 有關(guān)詳細(xì)信息，請看下文的說明。默認(rèn)值為：2
• COMPlus_DbgMiniDumpName 或 DOTNET_DbgMiniDumpName: 寫入轉(zhuǎn)儲的文件路徑。 確保運行 dotnet 進(jìn)程的用戶具有指定目錄的寫入權(quán)限。默認(rèn)值為：/tmp/coredump.<pid>
• COMPlus_CreateDumpDiagnostics 或 DOTNET_CreateDumpDiagnostics: 如果設(shè)置為 1，則啟用轉(zhuǎn)儲進(jìn)程的診斷日志記錄。默認(rèn)值為：0
• COMPlus_EnableCrashReport 或 DOTNET_EnableCrashReport：（需要.NET 6 或更高版本，目前僅Linux和MacOS可用）如果設(shè)為 1，運行時會生成 JSON 格式的故障報表，其中包括有關(guān)故障應(yīng)用程序的線程和堆棧幀的信息。 故障報表名稱是追加了 .crashreport.json 的轉(zhuǎn)儲路徑/名稱。
• COMPlus_CreateDumpVerboseDiagnostics 或 DOTNET_CreateDumpVerboseDiagnostics：（需要 .NET 7 或更高版本）如果設(shè)為 1，則啟用轉(zhuǎn)儲進(jìn)程的詳細(xì)診斷日志記錄。
• COMPlus_CreateDumpLogToFile 或 DOTNET_CreateDumpLogToFile：（需要 .NET 7 或更高版本）應(yīng)寫入診斷消息的文件路徑。 如果未設(shè)置，則將診斷消息寫入故障應(yīng)用程序的控制臺。

對于這些環(huán)境變量，.NET 7 標(biāo)準(zhǔn)化前綴DOTNET_，而不是COMPlus_。 但是，COMPlus_前綴仍將繼續(xù)正常工作。 如果使用的是早期版本的 .NET 運行時，則環(huán)境變量仍應(yīng)該使用COMPlus_前綴。

關(guān)于DOTNET_DbgMiniDumpType的說明如下所示：

• 1: Mini 小型Dump，其中包含模塊列表、線程列表、異常信息和所有堆棧。
• 2: Heap 大型且相對全面的Dump，其中包含模塊列表、線程列表、所有堆棧、異常信息、句柄信息和除映射圖像以外的所有內(nèi)存。
• 3: Triage 與 Mini 相同，但會刪除個人用戶信息，如路徑和密碼。
• 4: Full 最大的轉(zhuǎn)儲，包含所有內(nèi)存（包括模塊映像）。

一般情況下，我們會配置下面的環(huán)境變量：

DOTNET_DbgEnableMiniDump = 1DOTNET_DbgMiniDumpName = [有權(quán)限的Path目錄]DOTNET_CreateDumpDiagnostics = 1DOTNET_EnableCrashReport = 1

試一試

我們寫一段代碼來試一把，如下有一段代碼首先輸出了當(dāng)前DTONET_前綴對的環(huán)境變量，然后拋出一個異常。

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腳本，用于設(shè)置環(huán)境變量順便啟動我們的程序。

@SET DOTNET_DbgEnableMiniDump=1@SET DOTNET_DbgMiniDumpName="G:\Temp\CrashDump\CrashDump\bin\Debug\net6.0\dump.dmp"@SET DOTNET_CreateDumpDiagnostics=1@SET [email protected]

運行run.bat可以看到環(huán)境變量正確的讀到了，另外也成功的生成了Dump。

最后在對應(yīng)的目錄下，也生成了Dump文件。

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

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

總結(jié)

本文主要是介紹了如何在dotNet程序崩潰時自動創(chuàng)建Dump，Windows上的方法對于.NET Freamwork和.NET Core版本都適用。.NET Core全平臺版本的話需要注意環(huán)境變量支持的.NET版本。

參考文獻(xiàn)

• 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

到此這篇關(guān)于如何在.NET程序崩潰時自動創(chuàng)建Dump的文章就介紹到這了,更多相關(guān).net程序崩潰自動創(chuàng)建Dump內(nèi)容請搜索以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持！