說明
- 本文主要描述 Linux 環境下 .NET Core 程序的問題分析方案，也會提及如何將 Linux 系統中保存好的
core dump文件轉移到其他位置進行分析，Mac 環境中未嘗試成功，Windows 中推薦使用 WSL。 - 將依次講解如何在 .NET Core 2.x、.NET Core 3.x、.NET 5.x 中使用 SOS 命令。.NET Core 3.x 與 .NET 5.x 一致，以.NET 3.x 為例。
- .NET Core 2.x 的例子中使用
plugin load /usr/share/dotnet/shared/Microsoft.NETCore.App/運行時版本號/libsosplugin.so的方式加載 SOS 插件。.NET Core 3.x 開始提供了dotnet-sos來實現自動加載。且可以直接在.NET Core 2.x 環境中用dotnet tool安裝到，后面也會講到具體的操作。 - 使用 createdump 必須開啟 SYS_PTRACE，3.x 和 5.x 中使用 dotnet-dump 不需要開啟 SYS_PTRACE。
准備一個方便的學習環境
為了方便我們的學習，我們可以准備一下 Linux 的開發測試環境，借助 VS Code 的 Remote Containers 功能可以很方便的構建出純凈的 Linux 測試環境。這里需要確保 Docker 運行正常。
如果不需要通過此方式構建環境，可以直接跳到下一節。
- 安裝 VS Code 插件
Remote - Containers
- 創建一個文件夾並用 VS Code 打開，在該文件夾下創建下列文件結構
工作目錄
└── .devcontainer
├── devcontainer.json
├── docker-compose.yml
└── Dockerfile
2.x 配置內容
devcontainer.json
{
"name": ".NET Core 2.x",
"dockerComposeFile": "docker-compose.yml",
"service": "dotnet-core-2.x", // 名字要和 docker-compose.yml 中定義的 service 名字一致
"workspaceFolder": "/workspace",
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
"extensions": ["ms-dotnettools.csharp"] // 安裝容器中 VS Code Server 的 C# 插件
}
docker-compose.yml
version: '3'
services:
dotnet-core-2.x:
build:
context: .
dockerfile: Dockerfile
volumes:
# 把 VS Code 的工作目錄掛載到容器的 workspace 目錄下
- .:/workspace:cached
# 需要開啟 SYS_PTRACE 的配置
cap_add:
- SYS_PTRACE
# 避免容器主進程執行結束而退出
command: /bin/sh -c "while sleep 1000; do :; done"
Dockerfile
FROM microsoft/dotnet:2.1.300-sdk
# 直接寫入阿里源，方便 lldb 等工具的下載
RUN echo "deb http://mirrors.aliyun.com/debian/ stretch main non-free contrib\n\
deb-src http://mirrors.aliyun.com/debian/ stretch main non-free contrib\n\
deb http://mirrors.aliyun.com/debian-security stretch/updates main\n\
deb-src http://mirrors.aliyun.com/debian-security stretch/updates main\n\
deb http://mirrors.aliyun.com/debian/ stretch-updates main non-free contrib\n\
deb-src http://mirrors.aliyun.com/debian/ stretch-updates main non-free contrib\n\
deb http://mirrors.aliyun.com/debian/ stretch-backports main non-free contrib\n\
deb-src http://mirrors.aliyun.com/debian/ stretch-backports main non-free contrib"\
> /etc/apt/sources.list
# 安裝在鏡像內，避免下次用的時候重復安裝
RUN apt update && apt install -y lldb-3.9
3.x 配置內容
devcontainer.json
{
"name": ".NET Core 3.x",
"dockerComposeFile": "docker-compose.yml",
"service": "dotnet-core-3.x",
"workspaceFolder": "/workspace",
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
"extensions": ["ms-dotnettools.csharp"]
}
docker-compose.yml
version: '3'
services:
dotnet-core-3.x:
build:
context: .
dockerfile: Dockerfile
volumes:
# 把 VS Code 的工作目錄掛載到容器的 workspace 目錄下
- .:/workspace:cached
# 后面需要使用 基於 ptrace 的 lldb，這里需要開啟 SYS_PTRACE 的配置
cap_add:
- SYS_PTRACE
# 避免容器主進程執行結束而退出
command: /bin/sh -c "while sleep 1000; do :; done"
Dockerfile
FROM mcr.microsoft.com/dotnet/sdk:3.1
# 把所有后面可能會用到工具都提前裝好
RUN dotnet tool install --global dotnet-counters &&\
dotnet tool install -g dotnet-dump &&\
dotnet tool install -g dotnet-gcdump &&\
dotnet tool install --global dotnet-trace &&\
dotnet tool install -g dotnet-symbol &&\
dotnet tool install -g dotnet-sos
# 將上述工具所在的文件夾添加到 PATH
ENV PATH /root/.dotnet/tools:$PATH
# 替換成阿里源
RUN echo "deb http://mirrors.aliyun.com/debian/ buster main non-free contrib\n\
deb-src http://mirrors.aliyun.com/debian/ buster main non-free contrib\n\
deb http://mirrors.aliyun.com/debian-security buster/updates main\n\
deb-src http://mirrors.aliyun.com/debian-security buster/updates main\n\
deb http://mirrors.aliyun.com/debian/ buster-updates main non-free contrib\n\
deb-src http://mirrors.aliyun.com/debian/ buster-updates main non-free contrib\n\
deb http://mirrors.aliyun.com/debian/ buster-backports main non-free contrib\n\
deb-src http://mirrors.aliyun.com/debian/ buster-backports main non-free contrib"\
> /etc/apt/sources.list
在完成了 Remote - Containers 插件的安裝 並完成了上述三個文件的配置之后。
直接通過 VS Code 左下角的按鈕在自動構建的容器中打開工作目錄。
完成之后，我們就擁有了一個自由玩耍的空間了。
可以直接在里面寫代碼或者把寫好的代碼拖到 VS Code 工作目錄中。
工具介紹
lldb sos plugin
lldb 是一個軟件調試器，支持 C/C++ 的調試和 Linux core dump 文件的分析。
微軟提供了 lldb 的 SOS(Son of Strike) 插件，可以通過這個插件獲取運行時的線程，托管堆中的對象等信息。
官方推薦使用的 lldb 版本是 3.9 到 9。實測 3.8 版本有問題，會無法查看 thread 的 stack 信息。
Ubuntu/Debian安裝方式 apt install lldb-3.9。
.NET Core 2.x 版本中，SOS 插件直接在 .NET Core 的安裝目錄中可以找到，不強依賴 sdk，runtime 中也是自帶的。
/usr/share/dotnet/shared/Microsoft.NETCore.App/2.1.0/libsosplugin.so
其中 2.1.0 是版本號，需根據實際的 dotnet runtime 版本號（通過 dotnet --info 獲取信息）進行替換。
一共有兩種使用方式：
1. attach 到進程上進行調試
lldb-3.9 dotnet -p 進程號 -o "plugin load /usr/share/dotnet/shared/Microsoft.NETCore.App/運行時版本號/libsosplugin.so"
注意：這種方式會停掉進程。如果是線上服務，使用請慎重，最好先下掉流量。
等效 lldb-3.9 dotnet -p 進程號 再在lldb cli內執行 plugin load 插件路徑。
2. 分析core dump文件
首先我們需要得到 dotnet 程序的 core dump 文件。創建 dump 文件的方式有很多。最簡單可以使用 dotnet runtime 中自帶的 createdump 工具。
/usr/share/dotnet/shared/Microsoft.NETCore.App/2.1.0/createdump 進程id
創建 dump 的同時，進程會短暫暫停，完成 dump 后恢復運行。文件的大小取決於應用所占內存的大小。這樣我們就可以得到了 coredump 文件。
針對線上環境，有條件的同學可以直接在線上環境內分析，如果你的容器配置不是很高，是在一個短暫存活的 k8s pod中，建議下到本地進行分析，如果文件過大，傳輸過程中建議先壓縮。
加載 dump 文件的方式如如下：
lldb-3.9 dotnet -c dump文件路徑 -o "plugin load 插件路徑"
SOS
無論使用上面哪種方式，接下來操作都是一樣的，使用 lldb 的命令以及 sos 的擴展
soshelp 可以看到所有支持的 sos 命令。點擊跳轉官方文檔
soshelp <functionname> 可以看到每種命令具體的使用方式
使用 sos 完整命令名字 或者直接使用 別名
案例分析
無論是采取的 attach 到進程的方式，還是分析 core dump 文件的方式。最后都會進入一樣 lldb cli 界面。接下來伴隨實際的案例介紹一個新朋友，sos 指令。
CPU 占用過高
測試代碼
[Route("api/[controller]")]
public class TestController : ControllerBase
{
[HttpGet("highcpu/{milliseconds}")]
public string HighCpu(int milliseconds)
{
var sw = Stopwatch.StartNew();
while (true)
{
sw.Stop();
if (sw.ElapsedMilliseconds > milliseconds) break;
sw.Start();
}
return "success:highcpu";
}
}
使用 ps 進行線上問題可能性排查。
注意：這一步是一定要做的，否則后面沒辦法定位具有問題的線程。
ps [options] [--help]
options:
- a 顯示現行終端機下的所有程序，包括其他用戶的程序。
- u 以用戶為主的格式來顯示程序狀況。
- x 顯示所有程序，不以終端機來區分。
- -T 以線程維度展示。
精簡版鏡像可能沒有 ps 工具。可自行安裝，如 apt install procps。
實際進程可能比較多，可以加上 grep dotnet 進行過濾
其中 ps aux -T | head -n1 是為了保留標題行
關鍵列說明：
- PID: 進程ID
- SPID: 線程ID
- %CPU: CPU使用率
- TIME: 運行時間
可以看到，我們的應用進程ID是 1069，問題線程ID為 1709，102%CPU。
利用上文所述的兩種方式之一進入 lldb cli。
如果使用 createdump 的方式，一定要加上 -u 進行全量的dump，否則線程棧信息不全，影響問題分析。
/usr/share/dotnet/shared/Microsoft.NETCore.App/2.1.0/createdump -u 1069
1. clrthreads 指令查看概覽托管線程的信息。
2. thread select 線程編號 選中線程，或者使用簡化指令 t 線程編號
我們需要注意上圖圈紅的那兩列，其中 OSID 是用 16進制 表示的操作系統的線程編號，1709（10進制）等於 6ad（16進制）。需要通過一次換算來在 clrthreads 的結果中匹配 ps 找到的線程。
thread select 后面跟的參數是第一列，而非 ID 那一列。
6ad 對應的第一列線程編號 21，所以執行 thread select 21 或者 t 21。
3. clrstack 查看選中線程的調用棧 棧幀確定線程執行的內容。
- Child SP: Thread Stack Poiner
- IP Call Site: Instruction Pointer Call Site
從而，可以定位到問題代碼
內存泄漏
使用 attach 或者 core dump 方式進行分析。createdump 也需要全量。
排查內存問題，我們需要用到 dumpheap 指令。
dumpheap [options]
常用 options:
- -stat –只輸出堆上所有類型對象的統計摘要，它們的數量和它們自身的大小（不含引用）。
- -min
最小大小，單位 byte。 - -max
最大大小，單位 byte。 - -mt
根據 MethodTable 地址過濾對象。 - -type
類型名和給定的字符串部分匹配的類型的所有實例對象。
MethodTable 是 CLR 中維護類型方法信息等原數據的重要數據結構。和類型是一一對應的關系。
測試代碼
[Route("api/[controller]")]
public class TestController : ControllerBase
{
private static ConcurrentBag<MemoryLeak> _cache = new ConcurrentBag<MemoryLeak>();
[HttpGet("memoryleak/{count}")]
public string MemoryLeak(int count)
{
for (int i = 0; i < count; i++)
{
_cache.Add(new MemoryLeak());
}
return "success:memoryleak";
}
}
public class MemoryLeak
{
private byte[] _data;
public MemoryLeak()
{
_data = new byte[1024];
}
}
1. 分析什么類型的對象占的內存最大
-stat 是為了只看摘要信息。
占內存最大的是 MemoryLeak[] 類型的實例。
如果你能夠根據該類型定位到是哪塊代碼出了問題，那我們的故事就到此結束了。不是的話就要注意到這個線索 MemoryLeak 的 MethodTable 地址為 00007fb64b1e4488。
2. dumpheap -mt <address> 根據 MethodTable 找到有問題的對象的地址。取其中一個對象的地址。如 00007fb5d8042c68。
3. gcroot <address> 找到可能存在內存泄漏的根
如果能從上面的引用鏈上能找到能定位問題的地方，那故事也到此結束。如我們可以看到內存泄漏是發生在一個 Concurrent.ConcurrentBag<Test2.x.Controllers.MemoryLeak> 類型的容器上的。
4. 尋找靜態字段所在的類型（暫未解決）
pinned handle 表示這是一個靜態字段。那么怎么去定位這個靜態字段所在的類呢。本人能力有限，僅找到了一篇 windbg 的老文章，暫時不知道 lldb 中如何操作。
https://dzone.com/articles/pinpointing-static-gc-root-sos
Monitor導致的死鎖
測試代碼
class Program
{
private static readonly object LockObj1 = new object();
private static readonly object LockObj2 = new object();
static void Main(string[] args)
{
Method1();
Method2();
Console.ReadLine();
}
static void Method1()
{
Task.Run(() =>
{
lock (LockObj1)
{
Thread.Sleep(1000);
lock (LockObj2)
{
Console.WriteLine("Hello World Method1");
}
}
});
}
static void Method2()
{
Task.Run(() =>
{
lock (LockObj2)
{
Thread.Sleep(1000);
lock (LockObj1)
{
Console.WriteLine("Hello World Method2");
}
}
});
}
}
執行這段代碼后沒有任何結果輸出。
1. 利用 clrthreads，Lock Count 1 表示正在等待一個 Monitor 鎖。這個數字也就是線程持有的同步塊數量。除去第一個是 Console.ReadLine() 中的鎖。另外兩個標識着 Threadpool Worker 的的線程就是上面代碼死鎖的兩個線程。
2. 選中線程，用 clrstack 查看當前線程執行的內容從而定位到問題。
.NET Core 3.x 的不同點
3.x 開始提供了一套診斷工具。
- dotnet-sos
使用 lldb 時會自動加載 sos 插件, createdump 在 3.1 下依舊存在 - dotnet-dump
在不涉及本機調試的情況下收集和分析托管代碼相關的 dump，可以運行在 lldb 無法正常運行的平台 - dotnet-gcdump
基於 EventPipe 收集實時 .NET 進程的 GC 信息 - dotnet-counters
基於 EventCounter API 發布的 Metrics 快速定位問題的臨時性監控工具 - dotnet-trace
基於 EventPipe 收集 正在運行的進程中收集信息 - dotnet-symbol
在其他地方分析 dump 文件時，需要下載對應的 symbol 文件
本文只介紹和 SOS 相關的部分。
dotnet-sos
dotnet 安裝目錄中不再包含 libsosplugin.so。取而代之的是 dotnet-sos。
安裝完畢后，每次使用lldb都會自動加載sos 插件。
也可以用於 .NET Core 2.x。
安裝方式
dotnet tool install –g dotnet-sos
dotnet-sos install
如果 dotnet-sos 安裝目錄的環境變量沒有設置成功，需要到對應目錄下進行安裝
用戶home目錄/.dotnet/tools/dotnet-sos install
在新的sos插件中也增加了一些新的 sos 命令，例如 syncblk。
分析之前的那個 Monitor 死鎖的 core dump，得到持有同步塊的線程 id
dotnet-dump
dotnet-dump 的出現並不是為了完全取代上面一直在用的 lldb，它只能查看托管代碼相關的信息。
且不能用 .NET Core 2.x。
dotnet-dump ps
查看 dotnet-dump 能夠進行分析的進程
dotnet-dump collect [-p] [--type] [-o]
-
-p 進程ID
-
--type <Full|Heap|Mini> 指定轉儲類型，它確定從進程收集的信息的類型。 有三種類型：
Full - 最大的轉儲，包含所有內存（包括模塊映像）。
Heap - 大型且相對全面的轉儲，其中包含模塊列表、線程列表、所有堆棧、異常信息、句柄信息和除映射圖像以外的所有內存。
Mini - 小型轉儲，其中包含模塊列表、線程列表、異常信息和所有堆棧。
如果未指定，則 Full 為默認類型。 -
-o dump 保存路徑，如果沒有指定，默認當前路徑
dotnet-dump analyze <dump_path>
進入之后，一樣可以用到之前提到的那些 sos 命令
因為沒有 lldb 的 thread select <tid> 命令可以切換線程，需要使用 setthread
如何將 createdump 創建的 coredump 文件轉移到其他位置分析
上面分析 coredump 文件的例子都是直接在現場分析的。但實際情況中，我們可能會選擇將文件從服務器中保存下來，放到其他位置去分析，建議使用 Linux 環境或者 Windows WSL。
1. 環境准備
- 安裝好dotnet，最好與分析的應用程序一致
- 安裝 lldb，3.9 到 9 版本
dotnet tool install –g dotnet-sos && dotnet-sos install實現 sos 插件的自動加載dotnet tool install -g dotnet-symbol下載分析 coredump 所需的模塊和符號- 應用的pdb文件
2. 將應用的pdb文件放到和線上運行環境一樣的目錄下。若線上部署目錄是/app，則也需要在當前機器的/app下放置相同的文件，或者通過 setsymbolserver -directory
3. lldb-3.9 dotnet -c <coredump path> 加載 dump 文件。即可開始分析。
4. 如果在上一步執行 sos 失敗，則需要先在 coredump 所在的文件夾執行 dotnet-symbol --host-only --debugging <dump file path> 下載需要的文件。
如何將 dotnet-dump 創建的 coredump 文件轉移到其他位置分析
1. 環境准備
- 安裝好dotnet，最好與分析的應用程序一致
dotnet tool install –g dotnet-dumpdotnet tool install -g dotnet-symbol下載分析 coredump 所需的模塊和符號- 應用的pdb文件
2. 將應用的pdb文件放到和線上運行環境一樣的目錄下。
3. dotnet-dump analyze <dump_path> 加載 dump 文件。即可開始分析。
4. 如果在上一步執行 sos 失敗，則需要先在 coredump 所在的文件夾執行 dotnet-symbol --host-only --debugging <dump file path> 下載需要的文件。