快捷導(dǎo)航

.NET?6中的dotnet?monitor講解

更新時(shí)間：2021年12月24日 16:55:05 作者：曉晨Master

dotnet?monitor為Azure?App?Service（Linux）提供.NET?應(yīng)用程序的診斷工具提供支持。這篇文章講解了.NET?6中的dotnet?monitor，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

一.什么是 dotnet monitor

在不同的環(huán)境中運(yùn)行 .NET 應(yīng)用程序可能會(huì)使收集診斷信息（例如日志、跟蹤、dump）變得困難。dotnet monitor 是一種工具，它提供了一種統(tǒng)一的方法來(lái)收集這些診斷信息，而不管您是在桌面計(jì)算機(jī)（desktop machine 可理解為我們?nèi)粘Ｊ褂玫碾娔X）還是在 kubernetes 集群中運(yùn)行。

收集這些診斷信息有兩種不同的機(jī)制：

按需收集診斷信息的 HTTP API。當(dāng)您的應(yīng)用程序遇到問(wèn)題并且想收集更多信息時(shí)，可以調(diào)用這些 HTTP API。
基于規(guī)則配置的觸發(fā)器。您可以配置規(guī)則，以便在滿(mǎn)足所需條件時(shí)收集診斷信息，例如在 CPU 持續(xù)一段時(shí)間保持較高的指標(biāo)時(shí)收集進(jìn)程轉(zhuǎn)儲(chǔ)（process dump）。

二.入門(mén)

dotnet monitor 可以通過(guò)兩種不同的分發(fā)機(jī)制獲得：

.NET CLI 工具
通過(guò) Microsoft Container Registry (MCR) 獲得的容器鏡像

.NET CLI 工具

dotnet monitor CLI 工具首先需要安裝 .NET 6 SDK，如果你沒(méi)有足夠新的 SDK，可以通過(guò) .NET 下載網(wǎng)頁(yè)獲取安裝包進(jìn)行安裝。

你可以使用一下命令獲取最新版的 dotnet monitor：

dotnet tool install -g dotnet-monitor --version 6.0.0

如果你已經(jīng)安裝但是想更新到最新，可以運(yùn)行以下命令：

dotnet tool update -g dotnet-monitor --version 6.0.0

容器鏡像

dotnet monitor 容器鏡像在 MCR 上可用，你可以通過(guò)以下命令獲取最新的鏡像：

docker pull mcr.microsoft.com/dotnet/monitor:6.0.0

三.HTTP API

dotnet monitor 公開(kāi)了一個(gè) HTTP API 來(lái)查詢(xún)可用進(jìn)程、收集診斷信息并檢查請(qǐng)求信息的狀態(tài)。

暴露了以下 HTTP API：

/processes- 獲取可被發(fā)現(xiàn)的進(jìn)程的詳細(xì)信息
/dump- 在不使用調(diào)試器的情況下捕獲進(jìn)程的 dump
/gcdump- 捕獲進(jìn)程的 GC dump
/trace- 不使用 profiler 來(lái)追蹤進(jìn)程
/metrics- 以 Prometheus exposition 格式捕獲默認(rèn)進(jìn)程的指標(biāo)快照
/livemetrics- 捕獲進(jìn)程的實(shí)時(shí)指標(biāo)流
/logs- 捕獲進(jìn)程的日志
/info- 獲取有關(guān) dotnet monitor 的信息
/operations- 獲取操作狀態(tài)和取消操作

下面的示例演示如何使用 dotnet monitor 從目標(biāo)進(jìn)程開(kāi)始，在60秒的時(shí)間內(nèi)從Microsoft.AspNetCore.Server.Kestrel.Connections 日志級(jí)別為 Debug 的日志流數(shù)據(jù)。

PS> curl.exe -X POST "https://localhost:52323/logs?name=myWebApp&durationSeconds=60" `
    -H "Accept: application/x-ndjson" `
    -H "Content-Type: application/json" `
    --negotiate -u $(whoami)`
    -d '{"filterSpecs": {"Microsoft.AspNetCore.Server.Kestrel.Connections": "Debug"}}' 

{"Timestamp":"2021-11-05 08:12:54Z","LogLevel":"Debug","EventId":39,"EventName":"ConnectionAccepted","Category":"Microsoft.AspNetCore.Server.Kestrel.Connections","Message":"Connection id u00220HMD06BUKL2CUu0022 accepted.","State":{"Message":"Connection id u00220HMD06BUKL2CUu0022 accepted.","ConnectionId":"0HMD06BUKL2CU","{OriginalFormat}":"Connection id u0022{ConnectionId}u0022 accepted."}}
{"Timestamp":"2021-11-05 08:12:54Z","LogLevel":"Debug","EventId":1,"EventName":"ConnectionStart","Category":"Microsoft.AspNetCore.Server.Kestrel.Connections","Message":"Connection id u00220HMD06BUKL2CUu0022 started.","State":{"Message":"Connection id u00220HMD06BUKL2CUu0022 started.","ConnectionId":"0HMD06BUKL2CU","{OriginalFormat}":"Connection id u0022{ConnectionId}u0022 started."}}
{"Timestamp":"2021-11-05 08:12:54Z","LogLevel":"Debug","EventId":9,"EventName":"ConnectionKeepAlive","Category":"Microsoft.AspNetCore.Server.Kestrel.Connections","Message":"Connection id u00220HMD06BUKL2CUu0022 completed keep alive response.","State":{"Message":"Connection id u00220HMD06BUKL2CUu0022 completed keep alive response.","ConnectionId":"0HMD06BUKL2CU","{OriginalFormat}":"Connection id u0022{ConnectionId}u0022 completed keep alive response."},"Scopes":[{"ConnectionId":"0HMD06BUKL2CU"},{"RequestId":"0HMD06BUKL2CU:00000002","RequestPath":"/"}]}

如上面的示例所示，您可以使用 dotnet monitor 按需從目標(biāo)進(jìn)程中捕獲診斷信息。除了日志，您還可以從目標(biāo)進(jìn)程收集跟蹤、內(nèi)存轉(zhuǎn)儲(chǔ)、GC轉(zhuǎn)儲(chǔ)和 metrics。

四.觸發(fā)器

dotnet monitor 可以配置為根據(jù)發(fā)現(xiàn)的進(jìn)程中的條件自動(dòng)收集診斷信息。發(fā)現(xiàn)新進(jìn)程時(shí)，如果該進(jìn)程數(shù)據(jù)與規(guī)則匹配，則 dotnet monitor 將嘗試應(yīng)用配置的規(guī)則。應(yīng)用的規(guī)則將開(kāi)始監(jiān)視觸發(fā)器描述的條件的過(guò)程。如果滿(mǎn)足該條件，則假定尚未達(dá)到指定的限制來(lái)執(zhí)行操作列表。

示例：如果 dotnet monitor 檢測(cè)到持續(xù)超過(guò)一分鐘的CPU使用率在80%以上，則它將收集進(jìn)程 dump，限制每小時(shí)不超過(guò)1個(gè)。

{
  "CollectionRules": {
    "HighCpuRule": {
      "Filters": [
        {
          "Key": "ProcessName",
          "Value": "MyApp",
          "MatchType": "Exact"
        }
      ],
      "Trigger": {
        "Type": "EventCounter",
        "Settings": {
          "ProviderName": "System.Runtime",
          "CounterName": "cpu-usage",
          "GreaterThan": 80,
          "SlidingWindowDuration": "00:01:00"
        }
      },
      "Limits": {
        "ActionCount": 1,
        "ActionCountSlidingWindowDuration": "1:00:00"
      },
      "Actions": [
        {
          "Type": "CollectDump",
          "Settings": {
            "Type": "Triage",
            "Egress": "myBlobStorageAccount"
          }
        }
      ]
    }
  }
}

規(guī)則文檔：https://github.com/dotnet/dotnet-monitor/blob/main/documentation/collectionrules.md