如何使用 HttpReports 監控 .NET Core 應用程式

SpringLeee發表於2021-03-05
HTTP

簡介

HttpReports 基於.NET Core 開發的APM監控系統，使用MIT開源協議，主要功能包括，統計, 分析, 視覺化， 監控，追蹤等，適合在中小專案中使用。

github：https://github.com/dotnetcore/HttpReports

我也很榮幸在.NET Conf 2020 大會上, 做了簡單的分享，開源不易，感興趣的同學歡迎Star，支援一下...

線上預覽： http://apm.nonop.cn/
賬號: admin 密碼 123456

專案結構

使用者訪問了我們的三個程式，每個程式都安裝了HttpReports，它負責採集一些程式的資料和指標，然後通過Http的方式傳送到Collector，簡單處理後，會錄入到不同的資料庫中，同時，HttpReports.UI 負責把這些資料多維度的展示出來。

快速開始

接下來，我會構建監控的 Dashboard，然後在我們的.NET Core 程式中安裝HttpReports來收集資料，最後展示到UI上，讓我們看看這有多簡單！

首先，需要初始化資料庫，來儲存收集的資料，這裡我使用的是MySql資料庫（或者是SqlServer,PostgreSQL), 我手動建立了一個資料庫 HttpReports, 記住這個地址，後邊會用到。

引用 HttpReports.Dashboard

首先，我們需要構建 Dashboard 來接收，處理和展示資料，Dashboard 使用了 Vue + Antv + ElementUI 構建了頁面，然後把靜態檔案打包到了程式集，我們只要在.NET Core 應用中，通過Nuget安裝即可。

新建一個 .Net Core 的空的Web專案，支援 2.1 及以上版本

新建完成後，通過Nuget包分別安裝 HttpReports.Dashboard ，HttpReports.MySQL（或者是HttpReports.SqlServer, HttpReports.PostgreSQL）。

安裝完成之後，需要簡單的配置一下，我們直接修改專案的 appsetting.json 檔案

{
 "HttpReportsDashboard": { 
    "ExpireDay": 3,
    "Storage": {
      "ConnectionString": "DataBase=HttpReports;Data Source=localhost;User Id=root;Password=123456;", 
      "DeferSecond": 3,
      "DeferThreshold": 10
    },
   "Check": {
      "Mode": "Self",
      "Switch": true,
      "Endpoint": "",
      "Range": "500,2000"
    },
    "Mail": {
      "Server": "smtp.163.com",
      "Port": 465,
      "Account": "HttpReports@qq.com",
      "Password": "*******",
      "EnableSsL": true,
      "Switch": true
    }
  } 
}

現在引數有很多，不要擔心，我們現在只需要檢查資料庫的連線字串，確保讓它可以成功的連線到你的資料庫，其他的引數，你可以在官方的文件中找到它們，本文就不再多說。

修改完 appsetting.json 後，我們接著修改 Dahboard 專案的 Startup.cs 檔案：

public void ConfigureServices(IServiceCollection services)
 { 
	services.AddHttpReportsDashboard().AddMySqlStorage(); 
}

 
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{ 
	app.UseHttpReportsDashboard(); 
}

然後 Run，如果沒有問題的話，會跳轉到Dashboard的登陸頁面，預設的賬號：admin 密碼: 123456

現在我們有了 Dashboard，但是沒有資料, 我們還需要在我們的.NET Core 應用中安裝HttpReports,它負責採集和傳送資料。

引用HttpReports

我新建了一個 WebAPI 專案 UserService（使用者服務) ，然後我們通過 Nuget 分別安裝 HttpReports , HttpReports.Transport.Http。

安裝完成後，同樣的，我們修改 appsettings.json，簡單配置一下

{
 "HttpReports": {
   "Transport": {
     "CollectorAddress": "http://localhost:5000/",
     "DeferSecond": 10,
     "DeferThreshold": 100
   },
   "Server": "http://localhost:7000",
   "Service": "User",
   "Switch": true,
   "RequestFilter": [ "/api/health/*", "/HttpReports*" ],
   "WithRequest": true,
   "WithResponse": true,
   "WithCookie": true,
   "WithHeader": true
 }
}

引數介紹：
Transport - CollectorAddress - 資料批量傳送的地址，配置Dashboard 的專案地址即可
Server - 服務的地址，User服務我用了localhost:7000
Service - 服務名稱 User

修改完成後，我們接著修改 UserService 專案的 Startup.cs 檔案

app.UseHttpReports();
這一行一定要放到 UseRouting() 和 UseEndpoints（）方法 的上面。

修改 UserService 專案的啟動埠為7000，然後在解決方案中設定多專案啟動， 同時執行 UserService 和 Dashboard專案。

我們多請求幾次 UserService 的介面，然後再回到 Dashboard的頁面，選擇一下時間，現在已經可以看到資料了!

到目前為止，我們已經在.NET Core 的程式中簡單的使用了HttpReports，還有一些其他的功能，你可以在官方文件中更詳細的介紹。

語雀 - https://www.yuque.com/httpreports/docs/uyaiil

總結

在中小的專案中，你可以使用 HttpReports監控你的 .NET Core程式，這很簡單， 並且它是開源的。

另外 HttpReports 也有一些其他的問題，比如，難以應對海量資料，沒有完全按照 OpenTrace 規範，這些和專案早期的設計有很大的關係，我也願意接受大家的批評和意見，開源不能只是崇高的理想主義，社群需要各懷鬼胎的求同存異。

但是沒有關係，現在有 OpenTelemetry，它相容了OpenTracing和OpenCensus, 目前 1.0 版本也才釋出了一個月左右，未來它會有更多的應用場景。

所以，我在最近啟動了一個新專案 Furtuna，是按照 OpenTelemetry 規範去設計，你完全可以在 java, dotnet,php, go等語言中使用它，當然目前還只是在開發階段。

關於這個名字，Furtuna 是羅馬神話最古老的女神之一，能夠帶來幸福和機遇，寓意也很簡單，保護我們的程式，讓它變的更好！

相關文章