前言 最近幾個月一直在研究開源的APM和監控方案,並對比使用了Zipkin,CAT,Sky walking,PinPoint(僅對比,未實際部署),Elastic APM,TICK Stack,Prometheus等開源產品,其中不乏功能強大的監控和追蹤系統,但它們都對.NET/.NET Core沒 ...
前言
最近幾個月一直在研究開源的APM和監控方案,並對比使用了Zipkin,CAT,Sky-walking,PinPoint(僅對比,未實際部署),Elastic APM,TICK Stack,Prometheus等開源產品,其中不乏功能強大的監控和追蹤系統,但它們都對.NET/.NET Core沒有支持或支持不夠完備。而在.NET/.NET Core平臺也僅有Metrics.NET,AppMetrics,MiniProfiler等輕量級監控組件,它們也都和功能完備的APM系統差距甚遠,也無法完全滿足對當前流行的微服務系統進行全鏈路追蹤和端對端監控的需求。為了滿足實際的監控需求以及自身對APM系統的研究刨析,我決定從零開發.NET/.NET Core的APM,它應該包含
- Http請求監控
- 應用健康檢查
- 方法執行監控
- 應用內資料庫訪問監控
- 應用內緩存訪問監控(Redis)
- CLR/CoreCLR Runtime/GC/Threading監控
- 請求鏈路監控
- 分散式追蹤
為了實現如上需求,我創建了AspectCoreAPM(基於AspectCore AOP的APM client agent)和Butterfly(獨立的分散式追蹤Server)兩個開源項目,你可以在dotnet-lab[https://github.com/dotnet-lab]這個github organization下找到它們。下麵將分別對兩個項目進行簡單介紹。
Butterfly--A distributed tracing server
Butterfly被設計為分散式追蹤和APM的Server端,它將包含Collector,Storage,獨立的Web UI,並使用Open Tracing規範來設計追蹤數據。目前僅根據規範實現了Open Tracing API。
AspectCoreAPM
AspectCoreAPM抽象了APM的應用探針設計,它將會使用自動探針(收集CLR/CoreCLR數據),AOP探針(收集方法執行數據)和手動探針(業務數據)三種方式來收集數據發送到不同Collector Server或Storage。鑒於Butterfly Server並未完全實現,現階段使用InfluxDB作為數據存儲,並使用Grafana進行監控展示(在Butterfly Server完成後在Web UI進行統一的監控數據展示)。AspectCoreAPM目前已經完成了Http請求監控,簡單的GC/Threading監控和RedisClient監控。
在使用AspectCoreAPM之前,我們需要先安裝InfluxDB和Grafana。
在這裡我使用ubuntu作為演示,如需在其他系統安裝InfluxDB和Grafana,請各自參考它們的文檔:
InfluxDb:https://portal.influxdata.com/downloads
Grafana:https://grafana.com/grafana/download
安裝InfluxDB:
wget https://dl.influxdata.com/influxdb/releases/influxdb_1.4.2_amd64.deb
sudo dpkg -i influxdb_1.4.2_amd64.deb
安裝之後,執行influx
進入influxdb的CLI,並創建一個名稱為aspectcore
的database:
CREATE DATABASE aspectcore
然後安裝Grafana:
wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.6.2_amd64.deb
sudo dpkg -i grafana_4.6.2_amd64.deb
Grafana預設綁定的http地址為localhost,我們需要修改http_addr才可在外部訪問Grafana,使用vi打開Grafana的配置文件:
sudo vi /etc/grafana/grafana.ini
找到http_addr
配置修改為0.0.0.0:3000
或你的外網IP。
在瀏覽器打開Grafana,預設賬號和密碼均為admin,然後添加DataSource。Type選擇influxdb,並且database填寫我們上面創建的aspectcore
:
下載並導入AspectCoreAPM的Dashborad : https://grafana.com/dashboards/3837
接下來創建一個Asp.Net Core項目,並從nuget添加AspectCoreAPM:
Install-Package AspectCore.APM.AspNetCore
Install-Package AspectCore.APM.LineProtocolCollector
Install-Package AspectCore.APM.ApplicationProfiler
修改Startup.cs
:
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public IServiceProvider ConfigureServices(IServiceCollection services)
{
services.AddMvc();
services.AddAspectCoreAPM(component =>
{
component.AddApplicationProfiler(); //註冊ApplicationProfiler收集GC和ThreadPool數據
component.AddHttpProfiler(); //註冊HttpProfiler收集Http請求數據
component.AddLineProtocolCollector(options => //註冊LineProtocolCollector將數據發送到InfluxDb
{
options.Server = "http://192.168.3.4:8086"; //你自己的InfluxDB Http地址
options.Database = "aspectcore"; //你自己創建的Database
});
});
return services.BuildAspectCoreServiceProvider(); //返回AspectCore AOP的ServiceProvider,這句代碼一定要有
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseAspectCoreAPM(); //啟動AspectCoreAPM,這句代碼一定要有
app.UseHttpProfiler(); //啟動Http請求監控
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseMvc();
}
}
啟動應用並訪問頁面。最後回到Grafana,在DataSource處選擇aspectcore
,就能看到我們的監控數據啦。
有問題反饋
希望有更多的.NET/.NET Core開發者能關註到這個項目並參與進來。
如果您有任何問題,請提交 Issue 給我們。
Github : https://github.com/dotnet-lab/AspectCore-APM
如果您覺得此項目對您有幫助,請點個Star~
AspectCore QQ群: 306531723