zipkin-tracer 0.44.0 → 0.47.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46e54f012c081598681f2f5da8a961f29cb8656b8a21fa1877358724c2fa20b8
-  data.tar.gz: c22b07513bdca3173bdedbf1948d00f09907f669142f4d186c5f66808bb4d959
+  metadata.gz: 7f1cd6e0b5790c467741c87272cab1fe3b1462eca4fe8a86ecdaac2589c42e01
+  data.tar.gz: cc1a4565e51850f3da085782a949b672fe6ef98c3d908ecc3f0682996b695a16
 SHA512:
-  metadata.gz: f5b58005b5f1fe570f50cb36b66b7f72d6e27a620fee2453b3bc7b74e46202ddebb16b5b6d1e71d3a698f236ffebe7cd1ad60de128103f7a40929f12180eca82
-  data.tar.gz: dc910caca3ce2234aa5e12bc2c8363a98a711f717e84e05943a6246f0c462fd614486617cf9a9211721da92abb3d01bee18e1e6a0c66e7220c340395f56f79fd
+  metadata.gz: 276fb50c73250e91458e7a2ad92f013f56f8ededd1861bac85b5dbb72a6f75b5e7a03c522bdc2097d9fe162890889288c02df1500593733244d960ad69c23298
+  data.tar.gz: d0cc046aaa2267a2f6ad987dba4567c35e672688528532a29d7101749978522a7a14d1c79004eb8e50b1663493f2aa9bfc7768356edbe79e22d2eae81b8a32a0

data/.travis.yml

@@ -25,7 +25,7 @@ deploy:
   on:
     tags: true
     repo: openzipkin/zipkin-ruby
-    condition: "$TRAVIS_RUBY_VERSION == 2.7"
+    condition: $TRAVIS_RUBY_VERSION == 2.7 && $BUNDLE_GEMFILE == $TRAVIS_BUILD_DIR/gemfiles/faraday_1.x.gemfile
 
 notifications:
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.47.2
+* Fix to not flush local component span when a server span or a consumer span is in the stack.
+
+# 0.47.1
+* Fix to set `SERVER` span kind at the beginning to avoid being flushed before closing.
+
+# 0.47.0
+* Add a `check_routes` option to make the routable request check optional.
+
+# 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.
 

data/README.md

@@ -21,6 +21,7 @@ use ZipkinTracer::RackHandler, config
 * `:service_name` **REQUIRED** - the name of the service being traced. There are two ways to configure this value. Either write the service name in the config file or set the "DOMAIN" environment variable (e.g. 'test-service.example.com' or 'test-service'). The environment variable takes precedence over the config file value.
 * `:sample_rate` (default: 0.1) - the ratio of requests to sample, from 0 to 1
 * `:sampled_as_boolean` - When set to true (default but deprecrated), it uses true/false for the `X-B3-Sampled` header. When set to false uses 1/0 which is preferred.
+* `:check_routes` - When set to `true`, only routable requests are sampled. Defaults to `false`.
 * `:trace_id_128bit` - When set to true, high 8-bytes will be prepended to trace_id. The upper 4-bytes are epoch seconds and the lower 4-bytes are random. This makes it convertible to Amazon X-Ray trace ID format v1. (See http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-request-tracing.html)
 * `:async` - By default senders will flush traces asynchronously. Set to `false` to make that process synchronous. Only supported by the HTTP, RabbitMQ, and SQS senders.
 * `:logger` - The default logger for Rails apps is `Rails.logger`, else it is `STDOUT`. Use this option to pass a custom logger.
@@ -81,6 +82,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.
@@ -242,6 +275,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/lib/zipkin-tracer/config.rb

@@ -5,7 +5,7 @@ require 'zipkin-tracer/rack/zipkin-tracer'
 module ZipkinTracer
   # Configuration of this gem. It reads the configuration and provides default values
   class Config
-    attr_reader :service_name, :sample_rate, :sampled_as_boolean, :trace_id_128bit, :async, :logger,
+    attr_reader :service_name, :sample_rate, :sampled_as_boolean, :check_routes, :trace_id_128bit, :async, :logger,
       :json_api_host, :zookeeper, :kafka_producer, :kafka_topic, :sqs_queue_name, :sqs_region, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin, :rabbit_mq_connection, :rabbit_mq_exchange,
       :rabbit_mq_routing_key, :write_b3_single_format
@@ -47,6 +47,8 @@ module ZipkinTracer
       if @sampled_as_boolean
         @logger && @logger.warn("Using a boolean in the Sampled header is deprecated. Consider setting sampled_as_boolean to false")
       end
+      # When set to true, only routable requests are sampled
+      @check_routes      = config[:check_routes].nil? ? DEFAULTS[:check_routes] : config[:check_routes]
 
       # When set to true, high 8-bytes will be prepended to trace_id.
       # The upper 4-bytes are epoch seconds and the lower 4-bytes are random.
@@ -95,6 +97,7 @@ module ZipkinTracer
     DEFAULTS = {
       sample_rate: 0.1,
       sampled_as_boolean: true,
+      check_routes: false,
       trace_id_128bit: false,
       write_b3_single_format: false
     }

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/rack/zipkin-tracer.rb

@@ -25,6 +25,7 @@ module ZipkinTracer
           @app.call(env)
         else
           @tracer.with_new_span(trace_id, span_name(env)) do |span|
+            span.kind = Trace::Span::Kind::SERVER
             trace!(span, zipkin_env) { @app.call(env) }
           end
         end
@@ -55,7 +56,6 @@ module ZipkinTracer
     end
 
     def trace_server_information(span, zipkin_env, status)
-      span.kind = Trace::Span::Kind::SERVER
       span.record_status(status)
       SERVER_RECV_TAGS.each { |annotation_key, env_key| span.record_tag(annotation_key, zipkin_env.env[env_key]) }
     end

data/lib/zipkin-tracer/rack/zipkin_env.rb

@@ -71,7 +71,7 @@ module ZipkinTracer
       if parent_trace_sampled # A service upstream decided this goes in all the way
         parent_trace_sampled
       else
-        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered? && routable_request?)
+        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered? && traceable_request?)
       end
     end
 
@@ -83,9 +83,10 @@ module ZipkinTracer
       @config.filter_plugin && !@config.filter_plugin.call(@env)
     end
 
-    def routable_request?
+    def traceable_request?
+      return true unless @config.check_routes
+
       Application.routable_request?(@env)
     end
-
   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

@@ -115,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
 
@@ -277,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,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipkinTracer
-  VERSION = '0.44.0'
+  VERSION = '0.47.2'
 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
@@ -39,8 +38,9 @@ module Trace
     end
 
     def skip_flush?(span)
-      return true if span.kind == Trace::Span::Kind::CLIENT && span.has_parent_span?
-      return true if span.kind == Trace::Span::Kind::PRODUCER && spans.any? { |s| s.kind == Trace::Span::Kind::SERVER }
+      return false if span.kind == Trace::Span::Kind::SERVER || span.kind == Trace::Span::Kind::CONSUMER
+
+      spans.any? { |s| s.kind == Trace::Span::Kind::SERVER || s.kind == Trace::Span::Kind::CONSUMER }
     end
 
     def flush!
@@ -62,6 +62,5 @@ module Trace
     def reset
       Thread.current[THREAD_KEY] = []
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.47.2
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -241,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