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

http://blog.scoutapp.com/articles/2018/01/17/tutorial-distributed-tracing-in-ruby-with-opentracing

当最终响应是来源于一系列微服务时，将请求的生命周期串联起来就是一件比较困难的事情。
然而，分布式链路追踪通过将微服务之间的链路串联可以让这件事变得简单。本文我将展示如何通过OpenTracing(提供平台无关的API)和Jaeger(开源分布式追踪系统)将分布式链路追踪应用到你的Sinatra项目中。

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

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

现在有很多服务可以处理OpenTracing生成的交易追踪记录，在本章中我们将从两个Sinatra项目收集信息，并通过Jaeger展示信息。

准备工作

本文将用到以下组件：

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

安装Jaeger All-in-one

Jaeger All-in-one Docker镜像专门用于本地的快速测试验证。它包含了Jaeger UI，收集器，query和agent，以及一个基于内存的存储组件。安装在Sinatra项目中的jaeger-client发送追踪信息给运行容器中的Jaeger收集器。之后追踪的信息就可以通过访问http://localhost:16686
以web UI的形式展示。

你可以通过以下命令安装并运行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

访问Web UI http://localhost:16686来验证安装是否成功。现在Jaeger已经在运行了，让我们来启动第一个Sinatra应用吧。

Sinatra App No. 1: "Hello"

该示例应用在访问http://localhost:4567时简单的返回"Hello"，OpenTracing相关的部分已经加在了下面代码中：

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

收集第一条链路信息

向http://localhost:4567发送web请求。然后回到Jaeger web UI http://localhost:16686，选择"hello"服务，点击"查找链路"按钮。应该可以看到第一条链路追踪信息！

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

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

向http://localhost:4570发送请求后，刷新http://localhost:16686。可以看到最新的更丰富的追踪信息：

image.png

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

“Hello World”应用返回了"Hello"应用中的信息。OpenTracing是怎么抓取到这个请求的整个生命过程的呢？
OpenTracing为tracing across process boundaries定义了一项标准，该标准包含两部分：

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

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

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

Jaeger::Client::Tracer#inject sets an uber-trace-id request header包含了传送到"Hello"应用的所有内容。
当"Hello"应用接收到这些请求后，rack-tracer提供的中间件负责抽取这些信息。

总结

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

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