今天在浏覽張隊轉載文章的留言時,遇到一個讀者問了這樣的問題,如下圖所示:
首先能明确的一點是"程式崩潰退出了是不能用正常的方式 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
: 如果設定為 1,則發生故障時啟用 CoreDump 生成。預設值為:0DOTNET_DbgEnableMiniDump
-
或COMPlus_DbgMiniDumpType
: 要收集的轉儲類型。有關詳細資訊,請看下文的說明。預設值為:2DOTNET_DbgMiniDumpType
-
或COMPlus_DbgMiniDumpName
: 寫入轉儲的檔案路徑。確定運作 dotnet 程序的使用者具有指定目錄的寫入權限。預設值為:DOTNET_DbgMiniDumpName
/tmp/coredump.<pid>
-
或COMPlus_CreateDumpDiagnostics
: 如果設定為 1,則啟用轉儲程序的診斷日志記錄。預設值為:0DOTNET_CreateDumpDiagnostics
-
或COMPlus_EnableCrashReport
:(需要.NET 6 或更高版本,目前僅 Linux 和 MacOS 可用)如果設為 1,運作時會生成 JSON 格式的故障報表,其中包括有關故障應用程式的線程和堆棧幀的資訊。故障報表名稱是追加了 .crashreport.json 的轉儲路徑/名稱。DOTNET_EnableCrashReport
-
或COMPlus_CreateDumpVerboseDiagnostics
:(需要 .NET 7 或更高版本)如果設為 1,則啟用轉儲程序的詳細診斷日志記錄。DOTNET_CreateDumpVerboseDiagnostics
-
或COMPlus_CreateDumpLogToFile
:(需要 .NET 7 或更高版本)應寫入診斷消息的檔案路徑。如果未設定,則将診斷消息寫入故障應用程式的控制台。DOTNET_CreateDumpLogToFile
對于這些環境變量,.NET 7 标準化字首,而不是
DOTNET_
。但是,
COMPlus_
字首仍将繼續正常工作。如果使用的是早期版本的 .NET 運作時,則環境變量仍應該使用
COMPlus_
字首。
COMPlus_
關于
DOTNET_DbgMiniDumpType
的說明如下所示:
- 1:
小型 Dump,其中包含子產品清單、線程清單、異常資訊和所有堆棧。Mini
- 2:
大型且相對全面的 Dump,其中包含子產品清單、線程清單、所有堆棧、異常資訊、句柄資訊和除映射圖像以外的所有記憶體。Heap
- 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