zipkin-tracer 0.42.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2d9d53fd72f39cda64ad32aa5d578c859bf2a7b711b276cda1b080470eb2c5
-  data.tar.gz: b02443c6d58d469d6201ea61e7506c5548616362b54d4c2418955e640e059a25
+  metadata.gz: facfab4311d80aff894d2c5dec5253ef122ee5206328d875e41d2174373d060e
+  data.tar.gz: eb036ff2009dc9b70933881c12a93cead129127679bbdf9c538e6df067dc04c7
 SHA512:
-  metadata.gz: '029f1d52918da350f097cef452dbb937dafd1fb12dcc42fd59c33985e2d15c9ef4a934a6f274d9b879ecd937638240773eceaec12b330cb3baacf1f72ec86f8b'
-  data.tar.gz: 4ef5c85dccf8d5c8ff7f4ba04cb88c33d98e11de67f5fcd56e535a2542c032abd73102ba878c0a2681dcecd7930eff5df44a33a4b61a50964153adb24ba1b15d
+  metadata.gz: 6f99f5a59fdfd10c968fb99779aa0c7a97a559b45a36a787c886cac40845964e5cb98a5048313094ecab328d420ed3b01936cd66e1929389fef2e5eed1401b44
+  data.tar.gz: 5edb8af0059d1486a1105cf325ec21ce548f795f0a5078b67e8846d0cda23d05db2ab83075a27d1f6f46b173c10bd324af0683e26bc7ea5bd0695424e13880ba

data/.gitignore

@@ -9,16 +9,20 @@
 /test/version_tmp/
 /tmp/
 
-## Documentation cache and generated files:
+# Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
 /doc/
 /rdoc/
 
-## Environment normalisation:
+# Environment normalisation:
 /.bundle/
 /lib/bundler/man/
 
+# Appraisal related files
+/gemfiles/.bundle/
+/gemfiles/*.gemfile.lock
+
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock

data/.travis.yml

@@ -1,14 +1,22 @@
 language: ruby
-dist: trusty
-jdk:
-  - oraclejdk8
+dist: bionic
+jdk: openjdk11
+
 rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - 2.3.8
-  - jruby-9.1.17.0
-  - jruby-9.2.8.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby-9.1
+  - jruby-9.2
+
+gemfile:
+  - gemfiles/faraday_0.x.gemfile
+  - gemfiles/faraday_1.x.gemfile
+
+script: bundle exec rspec
+
 deploy:
   provider: rubygems
   api_key:
@@ -17,7 +25,8 @@ deploy:
   on:
     tags: true
     repo: openzipkin/zipkin-ruby
-    condition: "$TRAVIS_RUBY_VERSION == 2.6.3"
+    condition: $TRAVIS_RUBY_VERSION == 2.7 && $BUNDLE_GEMFILE == $TRAVIS_BUILD_DIR/gemfiles/faraday_1.x.gemfile
+
 notifications:
   webhooks:
     urls:
@@ -25,4 +34,3 @@ notifications:
       - https://webhooks.gitter.im/e/e57478303f87ecd7bffc
     on_success: change
     on_failure: always
-script: "bundle exec rspec"

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'faraday_0.x' do
+  gem 'faraday', '~> 0.13'
+end
+
+appraise 'faraday_1.x' do
+  gem 'faraday', '~> 1.0'
+end

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.46.0
+* Add Amazon SQS tracer.
+
+# 0.45.0
+* Add a `trace_context` option to the TraceWrapper utility class to retrieve trace data.
+
+# 0.44.0
+* Allow Faraday 1.x.
+
+# 0.43.1
+* Fix to not flush `PRODUCER` span when a server span is in the stack.
+
+# 0.43.0
+* Add the `PRODUCER` and `CONSUMER` span kinds.
+
 # 0.42.0
 * Reuse existing tracer(sender) in the TraceWrapper utility class.
 

data/README.md

@@ -43,11 +43,6 @@ use ZipkinTracer::RackHandler, config
 
 ### Sending traces on outgoing requests with Faraday
 
-First, Faraday has to be part of your Gemfile:
-```
-gem 'faraday', '~> 0.8'
-```
-
 For the Faraday middleware to have the correct trace ID, the rack middleware should be used in your application as explained above.
 
 Then include `ZipkinTracer::FaradayHandler` as a Faraday middleware:
@@ -56,10 +51,8 @@ Then include `ZipkinTracer::FaradayHandler` as a Faraday middleware:
 require 'faraday'
 require 'zipkin-tracer'
 
-conn = Faraday.new(:url => 'http://localhost:9292/') do |faraday|
+conn = Faraday.new(url: 'http://localhost:9292/') do |faraday|
   faraday.use ZipkinTracer::FaradayHandler, 'service_name' # 'service_name' is optional (but recommended)
-  # default Faraday stack
-  faraday.request :url_encoded
   faraday.adapter Faraday.default_adapter
 end
 ```
@@ -88,6 +81,38 @@ end
 
 By default workers aren't traced. You can specify the workers that you want to trace with traceable_workers config option. If you want all your workers to be traced pass [:all] to traceable_workers option (traceable_workers: [:all]).
 
+### Tracing Amazon SQS messages
+
+Amazon SQS tracing can be turned on by requiring [zipkin-tracer/sqs/adapter](lib/zipkin-tracer/sqs/adapter.rb):
+```ruby
+require 'zipkin-tracer/sqs/adapter'
+```
+
+This SQS adapter overrides the `send_message` and `send_message_batch` methods to add trace data as message attributes and to generate a producer span when the methods are called. Since all SQS messages are affected, it is not recommended to use this feature with the [SQS sender](lib/zipkin-tracer/zipkin_sqs_sender.rb).
+
+When receiving messages, you need to pass the `message_attribute_names: ['All']` option to retrive message attributes:
+```ruby
+resp = sqs.receive_message(
+  queue_url: queue_url,
+  message_attribute_names: ['All']
+)
+```
+
+Then you can utilize the [TraceWrapper](#tracewrapper) class to generate a consumer span:
+```ruby
+msg = resp.messages.first
+trace_context = msg.message_attributes.each_with_object({}) { |(key, value), hsh| hsh[key.to_sym] = value.string_value }
+
+TraceWrapper.wrap_in_custom_span(config, 'receive_message',
+  span_kind: Trace::Span::Kind::CONSUMER,
+  trace_context: trace_context
+) do |span|
+  span.remote_endpoint = Trace::Endpoint.remote_endpoint(nil, 'amazon-sqs')
+  span.record_tag('queue.url', queue_url)
+  :
+end
+```
+
 ### Local tracing
 
 `ZipkinTracer::TraceClient` provides an API to record local traces in your application.
@@ -249,6 +274,18 @@ TraceWrapper.wrap_in_custom_span(config, "custom span") do |span|
 end
 ```
 
+The `trace_context:` keyword argument can be used to retrieve trace data:
+```ruby
+trace_context = {
+  trace_id: '234555b04cf7e099',
+  span_id: '234555b04cf7e099',
+  sampled: 'true'
+}
+
+TraceWrapper.wrap_in_custom_span(config, "custom span", trace_context: trace_context) do |span|
+  :
+end
+```
 
 ## Development
 

data/gemfiles/faraday_0.x.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.13"
+
+platforms :ruby do
+  gem "benchmark-ips"
+  gem "rbtrace"
+  gem "byebug"
+  gem "simplecov", require: false
+end
+
+platforms :jruby do
+  gem "hermann", "~> 0.27.0"
+end
+
+gemspec path: "../"

data/gemfiles/faraday_1.x.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 1.0"
+
+platforms :ruby do
+  gem "benchmark-ips"
+  gem "rbtrace"
+  gem "byebug"
+  gem "simplecov", require: false
+end
+
+platforms :jruby do
+  gem "hermann", "~> 0.27.0"
+end
+
+gemspec path: "../"

data/lib/zipkin-tracer/hostname_resolver.rb

@@ -11,15 +11,17 @@ module ZipkinTracer
 
       each_endpoint(spans) do |endpoint|
         hostname = endpoint.ipv4
-        unless resolved_ip_address?(hostname.to_s)
-          endpoint.ipv4 = resolved_hosts[hostname]
-        end
+        next unless hostname
+        next if resolved_ip_address?(hostname.to_s)
+
+        endpoint.ipv4 = resolved_hosts[hostname]
       end
     end
 
     private
+
     LOCALHOST = '127.0.0.1'.freeze
-    LOCALHOST_I32 = 0x7f000001.freeze
+    LOCALHOST_I32 = 0x7f000001
     MAX_I32 = ((2 ** 31) - 1)
     MASK = (2 ** 32) - 1
     IP_FIELD = 3
@@ -49,10 +51,9 @@ module ZipkinTracer
     end
 
     def resolve(hosts, ip_format)
-      hosts.inject({}) do |host_map, host|
+      hosts.each_with_object({}) do |host, host_map|
         hostname = host.ipv4  # This field has been temporarly used to store the hostname.
-        host_map[hostname]  = host_to_format(hostname, ip_format)
-        host_map
+        host_map[hostname] = host_to_format(hostname, ip_format) if hostname
       end
     end
 

data/lib/zipkin-tracer/sqs/adapter.rb

@@ -0,0 +1,4 @@
+require 'aws-sdk-sqs'
+require 'zipkin-tracer/sqs/zipkin-tracer'
+
+Aws::SQS::Client.prepend(ZipkinTracer::SqsHandler)

data/lib/zipkin-tracer/sqs/zipkin-tracer.rb

@@ -0,0 +1,57 @@
+module ZipkinTracer
+  # This module is designed to prepend to the SQS client to add trace data as message attributes.
+  # https://github.com/aws/aws-sdk-ruby/blob/master/gems/aws-sdk-sqs/lib/aws-sdk-sqs/client.rb
+  module SqsHandler
+    def send_message(params = {}, options = {})
+      zipkin_sqs_trace_wrapper(params, __method__) { |params_with_trace| super(params_with_trace, options) }
+    end
+
+    def send_message_batch(params = {}, options = {})
+      zipkin_sqs_trace_wrapper(params, __method__) { |params_with_trace| super(params_with_trace, options) }
+    end
+
+    private
+
+    ZIPKIN_KEYS = %i[trace_id parent_id span_id sampled].freeze
+    ZIPKIN_REMOTE_ENDPOINT_SQS = Trace::Endpoint.remote_endpoint(nil, 'amazon-sqs')
+
+    def zipkin_sqs_trace_wrapper(params, method_name)
+      trace_id = TraceGenerator.new.next_trace_id
+      zipkin_set_message_attributes(params, method_name, trace_id)
+
+      TraceContainer.with_trace_id(trace_id) do
+        if Trace.tracer && trace_id.sampled?
+          Trace.tracer.with_new_span(trace_id, method_name) do |span|
+            span.kind = Trace::Span::Kind::PRODUCER
+            span.remote_endpoint = ZIPKIN_REMOTE_ENDPOINT_SQS
+            span.record_tag('queue.url', params[:queue_url])
+            yield(params)
+          end
+        else
+          yield(params)
+        end
+      end
+    end
+
+    def zipkin_set_message_attributes(params, method_name, trace_id)
+      attributes = zipkin_message_attributes(trace_id)
+      case method_name
+      when :send_message
+        params[:message_attributes] = attributes.merge(params[:message_attributes] || {})
+      when :send_message_batch
+        params[:entries].each do |entry|
+          entry[:message_attributes] = attributes.merge(entry[:message_attributes] || {})
+        end
+      end
+    end
+
+    def zipkin_message_attributes(trace_id)
+      ZIPKIN_KEYS.each_with_object({}) do |zipkin_key, message_attributes|
+        zipkin_value = trace_id.send(zipkin_key)
+        next unless zipkin_value
+
+        message_attributes[zipkin_key] = { string_value: zipkin_value.to_s, data_type: 'String' }
+      end
+    end
+  end
+end

data/lib/zipkin-tracer/trace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zipkin-tracer/zipkin_sender_base'
 require 'zipkin-tracer/trace_container'
 # Most of this code is copied from Finagle
@@ -113,21 +115,21 @@ module Trace
     end
 
     def next_id
-      TraceId.new(@trace_id, @span_id, ZipkinTracer::TraceGenerator.new.generate_id, @sampled, @flags)
+      TraceId.new(trace_id, span_id, ZipkinTracer::TraceGenerator.new.generate_id, sampled, flags)
     end
 
     # the debug flag is used to ensure the trace passes ALL samplers
     def debug?
-      @flags & Flags::DEBUG == Flags::DEBUG
+      flags & Flags::DEBUG == Flags::DEBUG
     end
 
     def sampled?
-      debug? || ['1', 'true'].include?(@sampled)
+      debug? || %w[1 true].include?(sampled)
     end
 
     def to_s
-      "TraceId(trace_id = #{@trace_id.to_s}, parent_id = #{@parent_id.to_s}, span_id = #{@span_id.to_s}," \
-      " sampled = #{@sampled.to_s}, flags = #{@flags.to_s}, shared = #{@shared.to_s})"
+      "TraceId(trace_id = #{trace_id}, parent_id = #{parent_id}, span_id = #{span_id}," \
+      " sampled = #{sampled}, flags = #{flags}, shared = #{shared})"
     end
   end
 
@@ -165,16 +167,32 @@ module Trace
   # A span may contain many annotations
   class Span
     module Tag
-      METHOD = "http.method".freeze
-      PATH = "http.path".freeze
-      STATUS = "http.status_code".freeze
-      LOCAL_COMPONENT = "lc".freeze # TODO: Remove LOCAL_COMPONENT and related methods when no longer needed
-      ERROR = "error".freeze
+      METHOD = "http.method"
+      PATH = "http.path"
+      STATUS = "http.status_code"
+      LOCAL_COMPONENT = "lc" # TODO: Remove LOCAL_COMPONENT and related methods when no longer needed
+      ERROR = "error"
     end
 
     module Kind
-      CLIENT = "CLIENT".freeze
-      SERVER = "SERVER".freeze
+      CLIENT = "CLIENT"
+      SERVER = "SERVER"
+
+      # When present, "timestamp" is the moment a producer sent a message to a destination.
+      # "duration" represents delay sending the message, such as batching, while
+      # "remote_endpoint" indicates the destination, such as a broker.
+      #
+      # Unlike CLIENT, messaging spans never share a span ID. For example, the
+      # CONSUMER of the same message has "parent_id" set to this span's id.
+      PRODUCER = "PRODUCER"
+
+      # When present, "timestamp" is the moment a consumer received a message from an origin.
+      # "duration" represents delay consuming the message, such as from backlog,
+      # while "remote_endpoint" indicates the origin, such as a broker.
+      #
+      # Unlike SERVER, messaging spans never share a span ID. For example, the
+      # PRODUCER of this message is the "parent_id" of this span.
+      CONSUMER = "CONSUMER"
     end
 
     attr_accessor :name, :kind, :local_endpoint, :remote_endpoint, :annotations, :tags, :debug
@@ -211,7 +229,7 @@ module Trace
       h[:remoteEndpoint] = @remote_endpoint.to_h unless @remote_endpoint.nil?
       h[:annotations] = @annotations.map(&:to_h) unless @annotations.empty?
       h[:tags] = @tags unless @tags.empty?
-      h[:shared] = true if @span_id.shared
+      h[:shared] = true if @span_id.shared && @kind == Kind::SERVER
       h
     end
 
@@ -259,8 +277,8 @@ module Trace
     end
 
     def self.remote_endpoint(url, remote_service_name)
-      service_name = remote_service_name || url.host.split('.').first || UNKNOWN_URL # default to url-derived service name
-      Endpoint.new(url.host, url.port, service_name)
+      service_name = remote_service_name || url&.host&.split('.')&.first || UNKNOWN_URL # default to url-derived service name
+      Endpoint.new(url&.host, url&.port, service_name)
     end
 
     def to_h

data/lib/zipkin-tracer/trace_wrapper.rb

@@ -1,10 +1,13 @@
 module ZipkinTracer
   class TraceWrapper
-    def self.wrap_in_custom_span(config, span_name, span_kind: Trace::Span::Kind::SERVER, app: nil)
+    REQUIRED_KEYS = %i[trace_id span_id].freeze
+    KEYS = %i[trace_id parent_id span_id sampled].freeze
+
+    def self.wrap_in_custom_span(config, span_name, span_kind: Trace::Span::Kind::SERVER, app: nil, trace_context: nil)
       raise ArgumentError, "you must provide a block" unless block_given?
 
       initialize_tracer(app, config)
-      trace_id = ZipkinTracer::TraceGenerator.new.next_trace_id
+      trace_id = next_trace_id(trace_context)
 
       ZipkinTracer::TraceContainer.with_trace_id(trace_id) do
         if trace_id.sampled?
@@ -24,5 +27,13 @@ module ZipkinTracer
       zipkin_config = ZipkinTracer::Config.new(app, config).freeze
       ZipkinTracer::TracerFactory.new.tracer(zipkin_config)
     end
+
+    def self.next_trace_id(trace_context)
+      if trace_context.is_a?(Hash) && REQUIRED_KEYS.all? { |key| trace_context.key?(key) }
+        Trace::TraceId.new(*trace_context.values_at(*KEYS), Trace::Flags::EMPTY).next_id
+      else
+        ZipkinTracer::TraceGenerator.new.next_trace_id
+      end
+    end
   end
 end

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ZipkinTracer
-  VERSION = '0.42.0'.freeze
+  VERSION = '0.46.0'
 end

data/lib/zipkin-tracer/zipkin_sender_base.rb

@@ -7,8 +7,7 @@ module Trace
   # Senders dealing with zipkin should inherit from this class and implement the
   # flush! method which actually sends the information
   class ZipkinSenderBase
-
-    def initialize(options={})
+    def initialize(options = {})
       @options = options
       reset
     end
@@ -25,10 +24,10 @@ module Trace
       # If in a thread not handling incoming http requests, it will not have Kind::SERVER, so the span
       # will never be flushed and will cause memory leak.
       # If no parent span, then current span needs to flush when it ends.
-      if !span.has_parent_span? || span.kind == Trace::Span::Kind::SERVER
-        flush!
-        reset
-      end
+      return if skip_flush?(span)
+
+      flush!
+      reset
     end
 
     def start_span(trace_id, name, timestamp = Time.now)
@@ -38,6 +37,14 @@ module Trace
       span
     end
 
+    def skip_flush?(span)
+      return true if span.kind == Trace::Span::Kind::CLIENT && span.has_parent_span?
+
+      if span.kind == Trace::Span::Kind::PRODUCER
+        return true if spans.any? { |s| s.kind == Trace::Span::Kind::SERVER || s.kind == Trace::Span::Kind::CONSUMER }
+      end
+    end
+
     def flush!
       raise "not implemented"
     end
@@ -57,6 +64,5 @@ module Trace
     def reset
       Thread.current[THREAD_KEY] = []
     end
-
   end
 end

data/zipkin-tracer.gemspec

@@ -24,16 +24,17 @@ Gem::Specification.new do |s|
   end
   s.require_paths = ['lib']
 
-  s.add_dependency 'faraday', '~> 0.13'
+  s.add_dependency 'faraday', '>= 0.13', '< 2.0'
   s.add_dependency 'rack', '>= 1.0'
   s.add_dependency 'sucker_punch', '~> 2.0'
 
+  s.add_development_dependency 'appraisal'
   s.add_development_dependency 'aws-sdk-sqs', '~> 1.0'
   s.add_development_dependency 'excon', '~> 0.53'
   s.add_development_dependency 'rspec', '~> 3.8'
   s.add_development_dependency 'rspec-json_expectations', '~> 2.2'
   s.add_development_dependency 'rack-test', '~> 1.1'
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'timecop', '~> 0.8'
   s.add_development_dependency 'webmock', '~> 3.0'
   s.add_development_dependency 'simplecov', '~> 0.16'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.46.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,22 +14,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +154,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +220,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -209,6 +230,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/faraday_0.x.gemfile
+- gemfiles/faraday_1.x.gemfile
 - lib/zipkin-tracer.rb
 - lib/zipkin-tracer/application.rb
 - lib/zipkin-tracer/config.rb
@@ -218,6 +241,8 @@ files:
 - lib/zipkin-tracer/rack/zipkin-tracer.rb
 - lib/zipkin-tracer/rack/zipkin_env.rb
 - lib/zipkin-tracer/sidekiq/middleware.rb
+- lib/zipkin-tracer/sqs/adapter.rb
+- lib/zipkin-tracer/sqs/zipkin-tracer.rb
 - lib/zipkin-tracer/trace.rb
 - lib/zipkin-tracer/trace_client.rb
 - lib/zipkin-tracer/trace_container.rb