ASP.NET Core整合Zipkin鏈路跟蹤的實(shí)現(xiàn)方法

sr - cs = 請(qǐng)求在網(wǎng)絡(luò)上的耗時(shí)
ss - sr = 服務(wù)端處理請(qǐng)求的耗時(shí)
cr - ss = 回應(yīng)在網(wǎng)絡(luò)上的耗時(shí)
cr - cs = 一次調(diào)用的整體耗時(shí)

version: "3.6"
services:
 elasticsearch:
 # 我使用的是7.5.0版本
 image: elasticsearch:7.5.0
 container_name: elasticsearch
 restart: always
 #暴露es端口
 ports:
 - 9200:9200
 environment:
 - discovery.type=single-node
 - bootstrap.memory_lock=true
 #es有內(nèi)存要求
 - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
 ulimits:
 memlock:
 soft: -1
 hard: -1
 networks:
 default:
 aliases:
 - elasticsearch

 zipkin:
 image: openzipkin/zipkin
 container_name: zipkin
 restart: always
 networks:
 default:
 aliases:
 - zipkin
 environment:
 #存儲(chǔ)類型為es
 - STORAGE_TYPE=elasticsearch
 #es地址
 - ES_HOSTS=elasticsearch:9200
 ports:
 - 9411:9411
 #依賴es所以在es啟動(dòng)完成后在啟動(dòng)zipkin
 depends_on:
 - elasticsearch

PackageReference Include="zipkin4net" Version="1.5.0" />
PackageReference Include="zipkin4net.middleware.aspnetcore" Version="1.5.0" />

PackageReference Include="zipkin4net" Version="1.5.0" />
PackageReference Include="zipkin4net.middleware.aspnetcore" Version="1.5.0" />

public void RegisterZipkinTrace(IApplicationBuilder app, ILoggerFactory loggerFactory, IHostApplicationLifetime lifetime)
{
 lifetime.ApplicationStarted.Register(() =>
 {
 //記錄數(shù)據(jù)密度，1.0代表全部記錄
 TraceManager.SamplingRate = 1.0f;
 //鏈路日志
 var logger = new TracingLogger(loggerFactory, "zipkin4net");
 //zipkin服務(wù)地址和內(nèi)容類型
 var httpSender = new HttpZipkinSender("http://localhost:9411/", "application/json");
 var tracer = new ZipkinTracer(httpSender, new JSONSpanSerializer(), new Statistics());
 var consoleTracer = new zipkin4net.Tracers.ConsoleTracer();

 TraceManager.RegisterTracer(tracer);
 TraceManager.RegisterTracer(consoleTracer);
 TraceManager.Start(logger);

 });
 //程序停止時(shí)停止鏈路跟蹤
 lifetime.ApplicationStopped.Register(() => TraceManager.Stop());
 //引入zipkin中間件，用于跟蹤服務(wù)請(qǐng)求,這邊的名字可自定義代表當(dāng)前服務(wù)名稱
 app.UseTracing(Configuration["nacos:ServiceName"]);
}

public void ConfigureServices(IServiceCollection services)
{
 //由于我使用了Nacos作為服務(wù)注冊(cè)中心
 services.AddNacosAspNetCore(Configuration);
 services.AddScopedNacosDiscoveryDelegatingHandler>();
 services.AddHttpClient(ServiceName.ProductService,client=> {
 client.BaseAddress = new Uri($"http://{ServiceName.ProductService}");
 })
 .AddHttpMessageHandlerNacosDiscoveryDelegatingHandler>()
 //引入zipkin trace跟蹤httpclient請(qǐng)求，名稱配置當(dāng)前服務(wù)名稱即可
 .AddHttpMessageHandler(provider =>TracingHandler.WithoutInnerHandler(Configuration["nacos:ServiceName"]));
 services.AddControllers();
}

using (HttpClient client = new HttpClient(new TracingHandler("OrderApi")))
{
}

[Route("orderapi/[controller]")]
public class OrderController : ControllerBase
{
 private ListOrderDto> orderDtos = new ListOrderDto>();
 private readonly IHttpClientFactory _clientFactory;

 public OrderController(IHttpClientFactory clientFactory)
 {
 orderDtos.Add(new OrderDto { Id = 1, TotalMoney=222,Address="北京市",Addressee="me",From="淘寶",SendAddress="武漢" });
 _clientFactory = clientFactory;
 }

 /// summary>
 /// 獲取訂單詳情接口
 /// /summary>
 /// param name="id">訂單id/param>
 /// returns>/returns>
 [HttpGet("getdetails/{id}")]
 public async TaskOrderDto> GetOrderDetailsAsync(long id)
 {
 OrderDto orderDto = orderDtos.FirstOrDefault(i => i.Id == id);
 if (orderDto != null)
 {
 OrderDetailDto orderDetailDto = new OrderDetailDto
 {
 Id = orderDto.Id,
 TotalMoney = orderDto.TotalMoney,
 Address = orderDto.Address,
 Addressee = orderDto.Addressee,
 From = orderDto.From,
 SendAddress = orderDto.SendAddress
 };
 //調(diào)用ProductApi服務(wù)接口
 var client = _clientFactory.CreateClient(ServiceName.ProductService);
 var response = await client.GetAsync($"/productapi/product/getall");
 var result = await response.Content.ReadAsStringAsync();

 orderDetailDto.Products = JsonConvert.DeserializeObjectListOrderProductDto>>(result);
 return orderDetailDto;
 }
 return orderDto;
 }
}

[Route("productapi/[controller]")]
public class ProductController : ControllerBase
{
 private ListProductDto> productDtos = new ListProductDto>();
 public ProductController()
 {
 productDtos.Add(new ProductDto { Id = 1,Name="酒精",Price=22.5m });
 productDtos.Add(new ProductDto { Id = 2, Name = "84消毒液", Price = 19.9m });
 }

 /// summary>
 /// 獲取所有商品信息
 /// /summary>
 /// returns>/returns>
 [HttpGet("getall")]
 public IEnumerableProductDto> GetAll()
 {
 return productDtos;
 }
}

protected override async TaskHttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
{
 FuncHttpRequestMessage, string> _getClientTraceRpc = _getClientTraceRpc = getClientTraceRpc ?? (request => request.Method.ToString());
 IInjectorHttpHeaders> _injector = Propagations.B3String.InjectorHttpHeaders>((carrier, key, value) => carrier.Add(key, value));
 //記錄發(fā)起請(qǐng)求客戶端鏈路信息的類是ClientTrace
 using (var clientTrace = new ClientTrace(_serviceName, _getClientTraceRpc(request)))
 {
 if (clientTrace.Trace != null)
 {
 _injector.Inject(clientTrace.Trace.CurrentSpan, request.Headers);
 }

 var result = await clientTrace.TracedActionAsync(base.SendAsync(request, cancellationToken));
 //AddAnnotation是記錄標(biāo)簽信息，我們可以在zipkin鏈路詳情中看到這些標(biāo)簽
 if (clientTrace.Trace != null)
 {
 //記錄請(qǐng)求路徑
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_PATH, result.RequestMessage.RequestUri.LocalPath));
 //記錄請(qǐng)求的http方法
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_METHOD, result.RequestMessage.Method.Method));
 if (_logHttpHost)
 {
 //記錄主機(jī)
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_HOST, result.RequestMessage.RequestUri.Host));
 }
 if (!result.IsSuccessStatusCode)
 {
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_STATUS_CODE, ((int)result.StatusCode).ToString()));
 }
 }
 return result;
 }
}

public class HttpDiagnosticListener: ITraceDiagnosticListener
{
 public string DiagnosticName => "HttpHandlerDiagnosticListener";

 private ClientTrace clientTrace;
 private readonly IInjectorHttpHeaders> _injector = Propagations.B3String.InjectorHttpHeaders>((carrier, key, value) => carrier.Add(key, value));

 [DiagnosticName("System.Net.Http.Request")]
 public void HttpRequest(HttpRequestMessage request)
 {
 clientTrace = new ClientTrace("apigateway", request.Method.Method);
 if (clientTrace.Trace != null)
 {
 _injector.Inject(clientTrace.Trace.CurrentSpan, request.Headers);
 }
 }

 [DiagnosticName("System.Net.Http.Response")]
 public void HttpResponse(HttpResponseMessage response)
 {
 if (clientTrace.Trace != null)
 {
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_PATH, response.RequestMessage.RequestUri.LocalPath));
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_METHOD, response.RequestMessage.Method.Method));
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_HOST, response.RequestMessage.RequestUri.Host));
 if (!response.IsSuccessStatusCode)
 {
 clientTrace.AddAnnotation(Annotations.Tag(zipkinCoreConstants.HTTP_STATUS_CODE, ((int)response.StatusCode).ToString()));
 }
 }
 }

 [DiagnosticName("System.Net.Http.Exception")]
 public void HttpException(HttpRequestMessage request,Exception exception)
 {
 }
}

public class TraceObserver :IObserverDiagnosticListener>
{
 private IEnumerableITraceDiagnosticListener> _traceDiagnostics;
 public TraceObserver(IEnumerableITraceDiagnosticListener> traceDiagnostics)
 {
 _traceDiagnostics = traceDiagnostics;
 }

 public void OnCompleted()
 {
 }

 public void OnError(Exception error)
 {
 }

 public void OnNext(DiagnosticListener listener)
 {
 //這樣的話我們可以更輕松的擴(kuò)展其他DiagnosticListener的操作
 var traceDiagnostic = _traceDiagnostics.FirstOrDefault(i=>i.DiagnosticName==listener.Name);
 if (traceDiagnostic!=null)
 {
 //適配訂閱
 listener.SubscribeWithAdapter(traceDiagnostic);
 }
 }
}

services.AddSingletonTraceObserver>();
services.AddSingletonITraceDiagnosticListener, HttpDiagnosticListener>();

public class ClientTrace : BaseStandardTrace, IDisposable
{
 public ClientTrace(string serviceName, string rpc)
 {
 if (Trace.Current != null)
 {
 Trace = Trace.Current.Child();
 }

 Trace.Record(Annotations.ClientSend());
 Trace.Record(Annotations.ServiceName(serviceName));
 Trace.Record(Annotations.Rpc(rpc));
 }

 public void Dispose()
 {
 Trace.Record(Annotations.ClientRecv());
 }
}

public class ServerTrace : BaseStandardTrace, IDisposable
{
 public override Trace Trace
 {
 get
 {
 return Trace.Current;
 }
 }

 public ServerTrace(string serviceName, string rpc)
 {
 Trace.Record(Annotations.ServerRecv());
 Trace.Record(Annotations.ServiceName(serviceName));
 Trace.Record(Annotations.Rpc(rpc));
 }

 public void Dispose()
 {
 Trace.Record(Annotations.ServerSend());
 }
}

var trace = Trace.Create();
trace.Record(Annotations.ServerRecv());
trace.Record(Annotations.ServiceName(serviceName));
trace.Record(Annotations.Rpc("GET"));
trace.Record(Annotations.ServerSend());
trace.Record(Annotations.Tag("http.url", "url>"));