jaeger-client 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 447a7b165ab77c10cd4d758f2e1ba0328251d9fd143966f406dd0a726d8c2ce0
-  data.tar.gz: 6fce14b5c113ef4ad60e917d5085ecead91f00ce2a6baaf05878026f2ff04bcb
+  metadata.gz: 46d05119eb9543907c6e1182a80346da57b634623425a4eeb74e06d637b73799
+  data.tar.gz: 171cdd21fd1872db8d1adef226e901dffd595ed7eab76f8c99f902363b638f9d
 SHA512:
-  metadata.gz: fc5eac14ee4471ac96daec09e5a5bd84a9e9ef86133480339d91e7490bc13b82fa127d3421036fc22c41c0dc49542cef5a6327c8fbab88f17b7bce3a117ee880
-  data.tar.gz: b4df5beac2b6ff98ee6153e802edebc352de7b872105c9be332ddf5ad34b4818fce489aa987800f88f211505750146cd083d58709058b6d9d8204c6902a94447
+  metadata.gz: 756a18ecf9e931670df3a9058613a5af99a2391eceabfc7c7fdeea5a1371c12757f818fd71e8616d96aa3a544dc0a0cb7728d22b9f4ae7dfb62863f7f37f1c4e
+  data.tar.gz: e89a5e9ff633cca38e030b31cd7a9df68bfa7bcbebfbd5f68ad61a663d04ade3c517465e2b8fcc707afe80696d2aad330ac51caf14a32551788b08322cd4ee4b

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "idl"]
+	path = idl
+	url = https://github.com/jaegertracing/jaeger-idl.git

data/.travis.yml

@@ -1,5 +1,14 @@
 sudo: false
+
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.14.4
+  - 2.5.0
+
+services:
+  - docker
+
+before_install: gem install bundler -v 1.17.2
+
+script:
+  - bundle exec rake
+  - make crossdock

data/Makefile

@@ -0,0 +1 @@
+-include crossdock/rules.mk

data/crossdock/Dockerfile

@@ -0,0 +1,29 @@
+FROM ruby:2.5-alpine
+
+ENV APP_HOME /app
+
+# git is required by bundler to run jaeger gem with local path
+RUN apk add --no-cache git
+
+# Add only files needed for installing gem dependencies. This allows us to
+# change other files without needing to install gems every time when building
+# the docker image.
+ADD Gemfile Gemfile.lock jaeger-client.gemspec $APP_HOME/
+ADD lib/jaeger/client/version.rb $APP_HOME/lib/jaeger/client/
+ADD crossdock/Gemfile crossdock/Gemfile.lock $APP_HOME/crossdock/
+
+RUN apk add --no-cache --virtual .app-builddeps build-base \
+  && cd $APP_HOME && bundle install \
+  && cd $APP_HOME/crossdock && bundle install \
+  && apk del .app-builddeps
+
+ADD . $APP_HOME
+
+RUN chown -R nobody:nogroup $APP_HOME
+USER nobody
+
+WORKDIR $APP_HOME/crossdock
+
+CMD ["bundle", "exec", "./server"]
+
+EXPOSE 8080-8082

data/crossdock/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'jaeger-client', path: '../'
+gem 'rack'
+gem 'sinatra'
+gem 'webrick', '~> 1.4.2'

data/crossdock/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: ..
+  specs:
+    jaeger-client (0.7.1)
+      opentracing (~> 0.3)
+      thrift
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mustermann (1.0.3)
+    opentracing (0.4.3)
+    rack (2.0.6)
+    rack-protection (2.0.4)
+      rack
+    sinatra (2.0.4)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.4)
+      tilt (~> 2.0)
+    thrift (0.11.0.0)
+    tilt (2.0.9)
+    webrick (1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jaeger-client!
+  rack
+  sinatra
+  webrick (~> 1.4.2)
+
+BUNDLED WITH
+   1.16.2

data/crossdock/docker-compose.yml

@@ -0,0 +1,68 @@
+version: '2'
+
+services:
+  crossdock:
+    image: crossdock/crossdock
+    links:
+      - test_driver
+      - go
+      - python
+      - java
+      - ruby
+    environment:
+      - WAIT_FOR=test_driver,go,python,java,ruby
+      - WAIT_FOR_TIMEOUT=60s
+
+      - CALL_TIMEOUT=60s
+
+      - AXIS_CLIENT=go
+
+      - AXIS_S1NAME=go,python,java,ruby
+      - AXIS_SAMPLED=true,false
+      - AXIS_S2NAME=go,python,java,ruby
+      - AXIS_S2TRANSPORT=http
+      - AXIS_S3NAME=go,python,java,ruby
+      - AXIS_S3TRANSPORT=http
+
+      - BEHAVIOR_TRACE=client,s1name,sampled,s2name,s2transport,s3name,s3transport
+
+      - AXIS_TESTDRIVER=test_driver
+      - AXIS_SERVICES=ruby
+
+      - BEHAVIOR_ENDTOEND=testdriver,services
+
+      - REPORT=compact
+  go:
+    image: jaegertracing/xdock-go
+    ports:
+      - "8080-8082"
+
+  java:
+    image: jaegertracing/xdock-java
+    depends_on:
+      - jaeger-agent
+    ports:
+      - "8080-8082"
+
+  python:
+    image: jaegertracing/xdock-py
+    depends_on:
+      - jaeger-agent
+    ports:
+      - "8080-8082"
+
+  ruby:
+    build:
+      context: ../.
+      dockerfile: crossdock/Dockerfile
+    ports:
+      - "8080-8082"
+
+  test_driver:
+    image: jaegertracing/test-driver
+    depends_on:
+      - jaeger-query
+      - jaeger-collector
+      - jaeger-agent
+    ports:
+      - "8080"

data/crossdock/jaeger-docker-compose.yml

@@ -0,0 +1,48 @@
+version: '2'
+
+services:
+    jaeger-collector:
+      image: jaegertracing/jaeger-collector
+      command: ["--cassandra.keyspace=jaeger_v1_dc1", "--cassandra.servers=cassandra", "--collector.zipkin.http-port=9411"]
+      ports:
+        - "14269"
+        - "14268:14268"
+        - "14267"
+        - "14250"
+        - "9411:9411"
+      restart: on-failure
+      depends_on:
+        - cassandra-schema
+
+    jaeger-query:
+      image: jaegertracing/jaeger-query
+      command: ["--cassandra.keyspace=jaeger_v1_dc1", "--cassandra.servers=cassandra"]
+      ports:
+        - "16686:16686"
+        - "16687"
+      restart: on-failure
+      depends_on:
+        - cassandra-schema
+
+    jaeger-agent:
+      image: jaegertracing/jaeger-agent
+      # FIXME temporarily switching back to tchannel
+      # https://github.com/jaegertracing/jaeger/issues/1229
+      command: ["--reporter.tchannel.host-port=jaeger-collector:14267"]
+      ports:
+        - "5775:5775/udp"
+        - "6831:6831/udp"
+        - "6832:6832/udp"
+        - "5778:5778"
+      restart: on-failure
+      depends_on:
+        - jaeger-collector
+
+    cassandra:
+      image: cassandra:3.9
+
+    cassandra-schema:
+      image: jaegertracing/jaeger-cassandra-schema
+      depends_on:
+        - cassandra
+

data/crossdock/rules.mk

@@ -0,0 +1,35 @@
+XDOCK_YAML=crossdock/docker-compose.yml
+TRACETEST_THRIFT=idl/thrift/crossdock/tracetest.thrift
+JAEGER_COMPOSE_URL=https://raw.githubusercontent.com/jaegertracing/jaeger/master/crossdock/jaeger-docker-compose.yml
+XDOCK_JAEGER_YAML=crossdock/jaeger-docker-compose.yml
+
+.PHONY: clean-compile
+clean-compile:
+	find . -name '*.pyc' -exec rm {} \;
+
+.PHONY: docker
+docker: clean-compile crossdock-download-jaeger
+	docker build -f crossdock/Dockerfile -t jaeger-client-ruby .
+
+.PHONY: crossdock
+crossdock: ${TRACETEST_THRIFT} crossdock-download-jaeger
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) kill ruby
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) rm -f ruby
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) build ruby
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) run crossdock
+
+.PHONY: crossdock-fresh
+crossdock-fresh: ${TRACETEST_THRIFT} crossdock-download-jaeger
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) kill
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) rm --force
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) pull
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) build
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) run crossdock
+
+.PHONY: crossdock-logs crossdock-download-jaeger
+crossdock-logs:
+	docker-compose -f $(XDOCK_YAML) -f $(XDOCK_JAEGER_YAML) logs
+
+.PHONY: crossdock-download-jaeger
+crossdock-download-jaeger:
+	curl -o $(XDOCK_JAEGER_YAML) $(JAEGER_COMPOSE_URL)

data/crossdock/server

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby
+
+$stdout.sync = true
+
+require 'sinatra/base'
+require 'webrick'
+require 'jaeger/client'
+require 'net/http'
+require 'uri'
+
+class HealthServer < Sinatra::Application
+  get '/' do
+    status 200
+  end
+end
+
+class HttpServer < Sinatra::Application
+  post '/start_trace' do
+    puts "Got request to start trace: #{trace_request}"
+
+    parent_context = tracer.extract(OpenTracing::FORMAT_RACK, request.env)
+    server_span = tracer.start_span('/start_trace', child_of: parent_context)
+
+    server_span.set_baggage_item('crossdock-baggage-key', trace_request['baggage'])
+    if trace_request.key?('sampled')
+      server_span.set_tag('sampling.priority', trace_request['sampled'] ? 1 : 0)
+    end
+
+    response = {
+      span: observe_span(server_span),
+      notImplementedError: ''
+    }
+
+    if trace_request['downstream']
+      downstream = trace_request['downstream']
+      transport = downstream['transport']
+
+      response[:downstream] =
+        if transport == 'HTTP'
+          call_downstream_http(downstream, server_span)
+        elsif transport == 'DUMMY'
+          { notImplementedError: 'Dummy has not been implemented' }
+        else
+          { notImplementedError: "Unrecognized transport received: #{transport}" }
+        end
+    end
+
+    puts "Response: #{response}"
+
+    server_span.finish
+    body JSON.dump(response)
+  end
+
+  post '/join_trace' do
+    puts 'Got request to join trace' \
+         "\n  Params: #{trace_request}" \
+         "\n  Headers: #{request_headers(request)}"
+
+    parent_context = tracer.extract(OpenTracing::FORMAT_RACK, request.env)
+    server_span = tracer.start_span('/join_trace', child_of: parent_context)
+
+    response = {
+      span: observe_span(server_span),
+      notImplementedError: ''
+    }
+
+    if trace_request['downstream']
+      downstream = trace_request['downstream']
+      transport = downstream['transport']
+
+      response[:downstream] =
+        if transport == 'HTTP'
+          call_downstream_http(downstream, server_span)
+        elsif transport == 'DUMMY'
+          { notImplementedError: 'Dummy has not been implemented' }
+        else
+          { notImplementedError: "Unrecognized transport received: #{transport}" }
+        end
+    end
+
+    puts "Response: #{response}"
+
+    server_span.finish
+    body JSON.dump(response)
+  end
+
+  post '/create_traces' do
+    puts "Got request to create traces: #{trace_request}"
+
+    trace_request['count'].times do
+      span = tracer.start_span(trace_request['operation'], tags: trace_request['tags'])
+      span.finish
+    end
+
+    status 200
+  end
+
+  private
+
+  def tracer
+    @tracer ||= Jaeger::Client.build(
+      service_name: 'crossdock-ruby',
+      host: 'jaeger-agent',
+      port: 6831,
+      flush_interval: 1,
+      sampler: Jaeger::Client::Samplers::Const.new(true)
+    )
+  end
+
+  def trace_request
+    @trace_request ||= begin
+      request.body.rewind
+      JSON.parse(request.body.read)
+    end
+  end
+
+  def observe_span(span)
+    if span
+      {
+        traceId: span.context.to_trace_id,
+        sampled: span.context.sampled?,
+        baggage: span.get_baggage_item('crossdock-baggage-key')
+      }
+    else
+      {
+        traceId: 'no span found',
+        sampled: false,
+        baggage: 'no span found'
+      }
+    end
+  end
+
+  def call_downstream_http(downstream, server_span)
+    downstream_url = "http://#{downstream['host']}:#{downstream['port']}/join_trace"
+
+    client_span = tracer.start_span('client-span', child_of: server_span)
+
+    headers = { 'Content-Type' => 'application/json' }
+    tracer.inject(client_span.context, OpenTracing::FORMAT_RACK, headers)
+
+    response = Net::HTTP.post(
+      URI(downstream_url),
+      JSON.dump(
+        serverRole: downstream['serverRole'],
+        downstream: downstream['downstream']
+      ),
+      headers
+    )
+
+    client_span.finish
+
+    if response.is_a?(Net::HTTPSuccess)
+      JSON.parse(response.body)
+    else
+      { error: response.body }
+    end
+  end
+
+  def request_headers(request)
+    request.env.select do |key, _value|
+      key.start_with?('HTTP_')
+    end
+  end
+end
+
+threads = []
+threads << Thread.new do
+  Rack::Handler::WEBrick.run(HealthServer, Port: 8080, Host: '0.0.0.0')
+end
+threads << Thread.new do
+  Rack::Handler::WEBrick.run(HttpServer, Port: 8081, Host: '0.0.0.0')
+end
+threads.each(&:join)

data/lib/jaeger/client/async_reporter.rb

@@ -8,21 +8,12 @@ module Jaeger
   module Client
     class AsyncReporter
       def self.create(sender:, flush_interval:)
-        reporter = new(sender)
-
-        # start flush thread
-        Thread.new do
-          loop do
-            reporter.flush
-            sleep(flush_interval)
-          end
-        end
-
-        reporter
+        new(sender, flush_interval)
       end
 
-      def initialize(sender)
+      def initialize(sender, flush_interval)
         @sender = sender
+        @flush_interval = flush_interval
         @buffer = Buffer.new
       end
 
@@ -34,8 +25,24 @@ module Jaeger
 
       def report(span)
         return if !span.context.sampled? && !span.context.debug?
+
+        init_reporter_thread
         @buffer << span
       end
+
+      private
+
+      def init_reporter_thread
+        return if @initializer_pid == Process.pid
+
+        @initializer_pid = Process.pid
+        Thread.new do
+          loop do
+            flush
+            sleep(@flush_interval)
+          end
+        end
+      end
     end
   end
 end

data/lib/jaeger/client/extractors.rb

@@ -24,13 +24,36 @@ module Jaeger
 
       class JaegerTextMapCodec
         def self.extract(carrier)
-          SerializedJaegerTrace.parse(carrier['uber-trace-id'])
+          context = SerializedJaegerTrace.parse(carrier['uber-trace-id'])
+          return nil unless context
+
+          carrier.each do |key, value|
+            baggage_match = key.match(/\Auberctx-([\w-]+)\Z/)
+            if baggage_match
+              context.set_baggage_item(baggage_match[1], value)
+            end
+          end
+
+          context
         end
       end
 
       class JaegerRackCodec
         def self.extract(carrier)
-          SerializedJaegerTrace.parse(carrier['HTTP_UBER_TRACE_ID'])
+          serialized_trace = carrier['HTTP_UBER_TRACE_ID']
+          serialized_trace = CGI.unescape(serialized_trace) if serialized_trace
+          context = SerializedJaegerTrace.parse(serialized_trace)
+          return nil unless context
+
+          carrier.each do |key, value|
+            baggage_match = key.match(/\AHTTP_UBERCTX_(\w+)\Z/)
+            if baggage_match
+              key = baggage_match[1].downcase.tr('_', '-')
+              context.set_baggage_item(key, value)
+            end
+          end
+
+          context
         end
       end
 

data/lib/jaeger/client/injectors.rb

@@ -3,14 +3,31 @@
 module Jaeger
   module Client
     module Injectors
+      def self.context_as_jaeger_string(span_context)
+        [
+          span_context.trace_id.to_s(16),
+          span_context.span_id.to_s(16),
+          span_context.parent_id.to_s(16),
+          span_context.flags.to_s(16)
+        ].join(':')
+      end
+
       class JaegerTextMapCodec
         def self.inject(span_context, carrier)
-          carrier['uber-trace-id'] = [
-            span_context.trace_id.to_s(16),
-            span_context.span_id.to_s(16),
-            span_context.parent_id.to_s(16),
-            span_context.flags.to_s(16)
-          ].join(':')
+          carrier['uber-trace-id'] = Injectors.context_as_jaeger_string(span_context)
+          span_context.baggage.each do |key, value|
+            carrier["uberctx-#{key}"] = value
+          end
+        end
+      end
+
+      class JaegerRackCodec
+        def self.inject(span_context, carrier)
+          carrier['uber-trace-id'] =
+            CGI.escape(Injectors.context_as_jaeger_string(span_context))
+          span_context.baggage.each do |key, value|
+            carrier["uberctx-#{key}"] = value
+          end
         end
       end
 
@@ -38,7 +55,7 @@ module Jaeger
       DEFAULT_INJECTORS = {
         OpenTracing::FORMAT_TEXT_MAP => JaegerTextMapCodec,
         OpenTracing::FORMAT_BINARY => JaegerBinaryCodec,
-        OpenTracing::FORMAT_RACK => JaegerTextMapCodec
+        OpenTracing::FORMAT_RACK => JaegerRackCodec
       }.freeze
 
       def self.prepare(extractors)

data/lib/jaeger/client/span.rb

@@ -23,8 +23,10 @@ module Jaeger
         @reporter = reporter
         @start_time = start_time
         @references = references
-        @tags = tags.map { |key, value| ThriftTagBuilder.build(key, value) }
+        @tags = []
         @logs = []
+
+        tags.each { |key, value| set_tag(key, value) }
       end
 
       # Set a tag value on this span
@@ -33,8 +35,21 @@ module Jaeger
       # @param value [String, Numeric, Boolean] the value of the tag. If it's not
       # a String, Numeric, or Boolean it will be encoded with to_s
       def set_tag(key, value)
+        if key == 'sampling.priority'
+          if value.to_i > 0
+            return self if @context.debug?
+
+            @context.flags = @context.flags | SpanContext::Flags::SAMPLED | SpanContext::Flags::DEBUG
+          else
+            @context.flags = @context.flags & ~SpanContext::Flags::SAMPLED
+          end
+          return self
+        end
+
         # Using Thrift::Tag to avoid unnecessary memory allocations
         @tags << ThriftTagBuilder.build(key, value)
+
+        self
       end
 
       # Set a baggage item on the span
@@ -42,6 +57,7 @@ module Jaeger
       # @param key [String] the key of the baggage item
       # @param value [String] the value of the baggage item
       def set_baggage_item(key, value)
+        @context.set_baggage_item(key, value)
         self
       end
 
@@ -51,7 +67,7 @@ module Jaeger
       #
       # @return Value of the baggage item
       def get_baggage_item(key)
-        nil
+        @context.get_baggage_item(key)
       end
 
       # Add a log entry to this span

data/lib/jaeger/client/span_context.rb

@@ -18,14 +18,17 @@ module Jaeger
       end
 
       def self.create_from_parent_context(span_context)
-        trace_id = span_context.trace_id
-        parent_id = span_context.span_id
-        flags = span_context.flags
-        span_id = TraceId.generate
-        new(span_id: span_id, parent_id: parent_id, trace_id: trace_id, flags: flags)
+        new(
+          trace_id: span_context.trace_id,
+          parent_id: span_context.span_id,
+          span_id: TraceId.generate,
+          flags: span_context.flags,
+          baggage: span_context.baggage.dup
+        )
       end
 
       attr_reader :span_id, :parent_id, :trace_id, :baggage, :flags
+      attr_writer :flags
 
       def initialize(span_id:, parent_id: 0, trace_id:, flags:, baggage: {})
         @span_id = span_id
@@ -47,13 +50,17 @@ module Jaeger
         @to_trace_id ||= @trace_id.to_s(16)
       end
 
-      def to_parent_id
-        @to_parent_id ||= @parent_id.zero? ? nil : @parent_id.to_s(16)
-      end
-
       def to_span_id
         @to_span_id ||= @span_id.to_s(16)
       end
+
+      def set_baggage_item(key, value)
+        @baggage[key.to_s] = value.to_s
+      end
+
+      def get_baggage_item(key)
+        @baggage[key.to_s]
+      end
     end
   end
 end

data/lib/jaeger/client/version.rb

@@ -2,6 +2,6 @@
 
 module Jaeger
   module Client
-    VERSION = '0.7.1'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jaeger-client
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-16 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,15 +116,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- crossdock/Dockerfile
+- crossdock/Gemfile
+- crossdock/Gemfile.lock
+- crossdock/docker-compose.yml
+- crossdock/jaeger-docker-compose.yml
+- crossdock/rules.mk
+- crossdock/server
 - jaeger-client.gemspec
 - lib/jaeger/client.rb
 - lib/jaeger/client/async_reporter.rb