zipkin-tracer 0.45.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d468909c2b28497b50dba2901e92f651ec45b555cca6fc1453258140e996f0d
-  data.tar.gz: 79508ca6c29d18906610ddf0950e33951e05f5db185e169af895a3982df3c40d
+  metadata.gz: facfab4311d80aff894d2c5dec5253ef122ee5206328d875e41d2174373d060e
+  data.tar.gz: eb036ff2009dc9b70933881c12a93cead129127679bbdf9c538e6df067dc04c7
 SHA512:
-  metadata.gz: e3f979dfa0f2be704ab85940dd4e6d6738fd9c587750b04929304eb72b55b122375a7e1c3e8ac2b8fac238aa8c154d24a8dae86e07bdf36f1d0e974a604cdbf5
-  data.tar.gz: 8bc0b4f4b2ee75570563d0a4aaba3823a8f6b6a8ccb1c99c0063e38726e9cedf749ab9722be3eb3837db0947e8f43b2ee44c47df6a8e6f378815adf7a6ceca58
+  metadata.gz: 6f99f5a59fdfd10c968fb99779aa0c7a97a559b45a36a787c886cac40845964e5cb98a5048313094ecab328d420ed3b01936cd66e1929389fef2e5eed1401b44
+  data.tar.gz: 5edb8af0059d1486a1105cf325ec21ce548f795f0a5078b67e8846d0cda23d05db2ab83075a27d1f6f46b173c10bd324af0683e26bc7ea5bd0695424e13880ba

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.46.0
+* Add Amazon SQS tracer.
+
 # 0.45.0
 * Add a `trace_context` option to the TraceWrapper utility class to retrieve trace data.
 

data/README.md

@@ -81,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.

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

@@ -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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipkinTracer
-  VERSION = '0.45.0'
+  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
@@ -40,7 +39,10 @@ module Trace
 
     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 }
+
+      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!
@@ -62,6 +64,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.45.0
+  version: 0.46.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-05-29 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