使用OpenTracing对ruby应用进行分布式链路追踪

OpenTracing，一套平台无关的追踪API

OpenTracing，一个平台无关的分布式链路追踪开放标准。OpenTracing解决了不同的分布式系统API不兼容的问题：如果通过OpenTracing API追踪方法调用，就可以轻易的替换追踪平台。

准备工作

本文将用到以下组件：

Jaeger All-in-one Docker镜像：用于本地查看分布式追踪
两个Sinatra示例应用
Gem ：追踪发向Sinatra应用的请求，我使用的版本是0.3.0。
Gem ：Jaeger OpenTracing追踪器，用来将追踪信息发送到Jaeger收集器。我使用的版本是0.4.1。

安装Jaeger All-in-one

你可以通过以下命令安装并运行Jaeger All-in-one（前提是你的机器上已经安装了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

Sinatra App No. 1: "Hello"

# 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'

运行bundle安装gem成功之后启动应用：ruby hello.rb。

收集第一条链路信息

image.png

Sinatra App No. 2: "Hello World"

该应用会向前一个"Hello"应用发送请求。通过OpenTracing的魔力，我们可以看到请求从父应用（Hello World）到微服务应用（Hello）完整的生命周期。

以下是第二个应用的代码：

# 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启动应用。

收集第一条分布式链路信息

image.png

分布式链路追踪是如何工作的？

Tracer#inject：将SpanContext注入到我们从"Hello World"发出请求的请求头中。
Tracer#extract：在"Hello" 中抽取出请求头中的SpanContext。

在上面代码中可以看到，我们在请求发送到"Hello"应用之前手动将SpanContext注入到了请求头：

OpenTracing.inject(env['rack.span'].context, OpenTracing::FORMAT_RACK, req)

总结

短短几步，我们借助于OpenTracing将平台无关的分布式追踪应用到了我们的ruby项目中来。可以通过Jaeger查看追踪。如果除了Jaeger你有其他喜欢的追踪系统，也可以通过在Sinatra应用的修改一行代码来快速的替换。