http://blog.scoutapp.com/articles/2018/01/17/tutorial-distributed-tracing-in-ruby-with-opentracing
當(dāng)最終響應(yīng)是來源于一系列微服務(wù)時(shí)，將請求的生命周期串聯(lián)起來就是一件比較困難的事情。
然而，分布式鏈路追蹤通過將微服務(wù)之間的鏈路串聯(lián)可以讓這件事變得簡單。本文我將展示如何通過OpenTracing(提供平臺無關(guān)的API)和Jaeger(開源分布式追蹤系統(tǒng))將分布式鏈路追蹤應(yīng)用到你的Sinatra項(xiàng)目中。
OpenTracing，一套平臺無關(guān)的追蹤API
OpenTracing，一個(gè)平臺無關(guān)的分布式鏈路追蹤開放標(biāo)準(zhǔn)。OpenTracing解決了不同的分布式系統(tǒng)API不兼容的問題：如果通過OpenTracing API追蹤方法調(diào)用，就可以輕易的替換追蹤平臺。
現(xiàn)在有很多服務(wù)可以處理OpenTracing生成的交易追蹤記錄， 在本章中我們將從兩個(gè)Sinatra項(xiàng)目收集信息， 并通過Jaeger展示信息。
準(zhǔn)備工作
本文將用到以下組件：
- Jaeger All-in-one Docker鏡像：用于本地查看分布式追蹤
- 兩個(gè)Sinatra示例應(yīng)用
- Gem rack-tracer：追蹤發(fā)向Sinatra應(yīng)用的請求，我使用的版本是0.3.0。
- Gem jaeger-client：Jaeger OpenTracing追蹤器，用來將追蹤信息發(fā)送到Jaeger收集器。我使用的版本是0.4.1。
安裝Jaeger All-in-one
Jaeger All-in-one Docker鏡像專門用于本地的快速測試驗(yàn)證。它包含了Jaeger UI，收集器，query和agent，以及一個(gè)基于內(nèi)存的存儲組件。安裝在Sinatra項(xiàng)目中的jaeger-client發(fā)送追蹤信息給運(yùn)行容器中的Jaeger收集器。之后追蹤的信息就可以通過訪問http://localhost:16686
以web UI的形式展示。
你可以通過以下命令安裝并運(yùn)行Jaeger All-in-one（前提是你的機(jī)器上已經(jīng)安裝了Docker）
docker run -d -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 -p5775:5775/udp -p6831:6831/udp -p6832:6832/udp \
-p5778:5778 -p16686:16686 -p14268:14268 -p9411:9411 jaegertracing/all-in-one:latest
訪問Web UI http://localhost:16686來驗(yàn)證安裝是否成功?，F(xiàn)在Jaeger已經(jīng)在運(yùn)行了，讓我們來啟動第一個(gè)Sinatra應(yīng)用吧。
Sinatra App No. 1: "Hello"
該示例應(yīng)用在訪問http://localhost:4567時(shí)簡單的返回"Hello"，OpenTracing相關(guān)的部分已經(jīng)加在了下面代碼中：
# File name: hello.rb
# To run: ruby hello.rb
require 'sinatra'
require 'opentracing'
require 'jaeger/client'
require 'rack/tracer'
OpenTracing.global_tracer = Jaeger::Client.build(service_name: 'hello')
use Rack::Tracer
get '/' do
'Hello'
end
在同層級添加Gemfile
# Gemfile
source 'https://rubygems.org'
gem 'sinatra'
gem 'rack-tracer'
gem 'jaeger-client'
運(yùn)行bundle安裝gem成功之后啟動應(yīng)用：ruby hello.rb。
收集第一條鏈路信息
向http://localhost:4567發(fā)送web請求。然后回到Jaeger web UI http://localhost:16686，選擇"hello"服務(wù)，點(diǎn)擊"查找鏈路"按鈕。應(yīng)該可以看到第一條鏈路追蹤信息！
Sinatra App No. 2: "Hello World"
該應(yīng)用會向前一個(gè)"Hello"應(yīng)用發(fā)送請求。通過OpenTracing的魔力，我們可以看到請求從父應(yīng)用（Hello World）到微服務(wù)應(yīng)用（Hello）完整的生命周期。
以下是第二個(gè)應(yīng)用的代碼：
# File Name: hello_world.rb
# To run: ruby hello_world.rb -p 4570
require 'sinatra'
require 'opentracing'
require 'jaeger/client'
require 'rack/tracer'
OpenTracing.global_tracer = Jaeger::Client.build(service_name: 'hello-world')
use Rack::Tracer
get '/' do
"#{hello} world"
end
def hello
client = Net::HTTP.new("localhost",4567)
req = Net::HTTP::Get.new("/")
OpenTracing.inject(env['rack.span'].context, OpenTracing::FORMAT_RACK, req)
client.request(req).body
end
以4570端口ruby hello_world.rb -p4570啟動應(yīng)用。
收集第一條分布式鏈路信息
向http://localhost:4570發(fā)送請求后，刷新http://localhost:16686。可以看到最新的更豐富的追蹤信息：
分布式鏈路追蹤是如何工作的？
“Hello World”應(yīng)用返回了"Hello"應(yīng)用中的信息。OpenTracing是怎么抓取到這個(gè)請求的整個(gè)生命過程的呢？
OpenTracing為tracing across process boundaries定義了一項(xiàng)標(biāo)準(zhǔn)，該標(biāo)準(zhǔn)包含兩部分：
-
Tracer#inject：將SpanContext注入到我們從"Hello World"發(fā)出請求的請求頭中。 -
Tracer#extract：在"Hello" 中抽取出請求頭中的SpanContext。
在上面代碼中可以看到，我們在請求發(fā)送到"Hello"應(yīng)用之前手動將SpanContext注入到了請求頭：
OpenTracing.inject(env['rack.span'].context, OpenTracing::FORMAT_RACK, req)
Jaeger::Client::Tracer#inject sets an uber-trace-id request header包含了傳送到"Hello"應(yīng)用的所有內(nèi)容。
當(dāng)"Hello"應(yīng)用接收到這些請求后，rack-tracer提供的中間件負(fù)責(zé)抽取這些信息。
總結(jié)
短短幾步， 我們借助于OpenTracing將平臺無關(guān)的分布式追蹤應(yīng)用到了我們的ruby項(xiàng)目中來?？梢酝ㄟ^Jaeger查看追蹤。如果除了Jaeger你有其他喜歡的追蹤系統(tǒng)，也可以通過在Sinatra應(yīng)用的修改一行代碼來快速的替換。
