zipkin-tracer 0.35.1 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09555ccde6ee7aa47e75a36c70445a2611bab1218b518c399bfad8d76d341063'
-  data.tar.gz: 8235afc71c8685567466a11d28ce2bda7596b5e4784f51e266db1c85f085914c
+  metadata.gz: 0b65eb925752852ca858a99985cd7d9c93927b75a2094e9accddbc50adecf759
+  data.tar.gz: a0f10e2b2798cb7d7c235ee9c6b5165da922e66f01a57c503b8583bbd34965ac
 SHA512:
-  metadata.gz: 897ad8d5b52dacfdd982f36440b07db9a478489c9396f6b92144a848d75a987af0e20f246e348348d3ef7fce9500aca6f1f698e144c7fc64ad80843d9ef1a36e
-  data.tar.gz: 97dd7106d21aff8dfa9147b02cfd2b9224bda862216c0909dce21708ada1464580d46bc024e5656634d9f63dffcba22703c3b073ebd7562349943d81fa8fce49
+  metadata.gz: fb7d829f81ae485aabf96c50f970d0637dd836be7379496d6d6879a7928054dbc0922c77b37702a274734a1b1007a78cb17767fab344b7fc65c382a5af338edc
+  data.tar.gz: 22d4fbc7486aa150fb63a87efa258f38c9a290d1f47ff0ada1949d75f37c90f9294fe69e55cfeb5a29c35522691d8a9051417969f6443b2c2cbcc541992ba603

data/lib/zipkin-tracer/config.rb

@@ -5,11 +5,10 @@ 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, :json_api_host,
-      :zookeeper, :sample_rate, :logger, :log_tracing,
+    attr_reader :service_name, :sample_rate,
+      :json_api_host, :zookeeper, :kafka_producer, :kafka_topic, :sqs_queue_name, :sqs_region, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin,
-      :sampled_as_boolean,
-      :kafka_producer, :kafka_topic, :trace_id_128bit
+      :logger, :sampled_as_boolean, :trace_id_128bit
 
     def initialize(app, config_hash)
       config = config_hash || Application.config(app)
@@ -22,6 +21,9 @@ module ZipkinTracer
       # Kafka producer information
       @kafka_producer    = config[:producer]
       @kafka_topic       = config[:topic] if present?(config[:topic])
+      # Amazon SQS queue information
+      @sqs_queue_name    = config[:sqs_queue_name]
+      @sqs_region        = config[:sqs_region]
       # Percentage of traces which by default this service traces (as float, 1.0 means 100%)
       @sample_rate       = config[:sample_rate]       || DEFAULTS[:sample_rate]
       # A block of code which can be called to do extra annotations of traces
@@ -61,6 +63,8 @@ module ZipkinTracer
         :kafka
       elsif @kafka_producer && @kafka_producer.respond_to?(:push)
         :kafka_producer
+      elsif present?(@sqs_queue_name) && defined?(Aws::SQS)
+        :sqs
       elsif !!@log_tracing
         :logger
       else

data/lib/zipkin-tracer/trace.rb

@@ -1,4 +1,4 @@
-require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/zipkin_sender_base'
 require 'zipkin-tracer/trace_container'
 # Most of this code is copied from Finagle
 # https://github.com/twitter/finagle/blob/finagle-6.39.0/finagle-thrift/src/main/ruby/lib/finagle-thrift/trace.rb

data/lib/zipkin-tracer/tracer_factory.rb

@@ -5,28 +5,31 @@ module ZipkinTracer
 
       tracer = case adapter
         when :json
-          require 'zipkin-tracer/zipkin_json_tracer'
+          require 'zipkin-tracer/zipkin_http_sender'
           options = { json_api_host: config.json_api_host, logger: config.logger }
-          Trace::ZipkinJsonTracer.new(options)
+          Trace::ZipkinHttpSender.new(options)
         when :kafka
-          require 'zipkin-tracer/zipkin_kafka_tracer'
-          Trace::ZipkinKafkaTracer.new(zookeepers: config.zookeeper)
+          require 'zipkin-tracer/zipkin_kafka_sender'
+          Trace::ZipkinKafkaSender.new(zookeepers: config.zookeeper)
         when :kafka_producer
-          require 'zipkin-tracer/zipkin_kafka_tracer'
+          require 'zipkin-tracer/zipkin_kafka_sender'
           options = { producer: config.kafka_producer }
           options[:topic] = config.kafka_topic unless config.kafka_topic.nil?
-          Trace::ZipkinKafkaTracer.new(options)
+          Trace::ZipkinKafkaSender.new(options)
+        when :sqs
+          require 'zipkin-tracer/zipkin_sqs_sender'
+          options = { logger: config.logger, queue_name: config.sqs_queue_name , region: config.sqs_region }
+          Trace::ZipkinSqsSender.new(options)
         when :logger
-          require 'zipkin-tracer/zipkin_logger_tracer'
-          Trace::ZipkinLoggerTracer.new(logger: config.logger)
+          require 'zipkin-tracer/zipkin_logger_sender'
+          Trace::ZipkinLoggerSender.new(logger: config.logger)
         else
-          require 'zipkin-tracer/zipkin_null_tracer'
-          Trace::NullTracer.new
+          require 'zipkin-tracer/zipkin_null_sender'
+          Trace::NullSender.new
       end
       Trace.tracer = tracer
 
       tracer
     end
-
   end
 end

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.35.1'.freeze
+  VERSION = '0.36.0'.freeze
 end

data/lib/zipkin-tracer/{zipkin_json_tracer.rb → zipkin_http_sender.rb}

@@ -1,15 +1,15 @@
 require 'json'
 require 'sucker_punch'
-require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/zipkin_sender_base'
 require 'zipkin-tracer/hostname_resolver'
 
-class AsyncJsonApiClient
+class AsyncHttpApiClient
   include SuckerPunch::Job
   SPANS_PATH = '/api/v2/spans'
 
   def perform(json_api_host, spans)
     spans_with_ips =
-      ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans, ZipkinJsonTracer::IP_FORMAT).map(&:to_h)
+      ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans, ZipkinHttpSender::IP_FORMAT).map(&:to_h)
     resp = Faraday.new(json_api_host).post do |req|
       req.url SPANS_PATH
       req.headers['Content-Type'] = 'application/json'
@@ -27,7 +27,7 @@ end
 module Trace
   # This class sends information to the Zipkin API.
   # The API accepts a JSON representation of a list of spans
-  class ZipkinJsonTracer < ZipkinTracerBase
+  class ZipkinHttpSender < ZipkinSenderBase
     IP_FORMAT = :string
 
     def initialize(options)
@@ -37,7 +37,7 @@ module Trace
     end
 
     def flush!
-      AsyncJsonApiClient.perform_async(@json_api_host, spans.dup)
+      AsyncHttpApiClient.perform_async(@json_api_host, spans.dup)
     end
   end
 end

data/lib/zipkin-tracer/{zipkin_kafka_tracer.rb → zipkin_kafka_sender.rb}

@@ -6,13 +6,13 @@ begin
 rescue LoadError => e
 end
 
-require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/zipkin_sender_base'
 require 'zipkin-tracer/hostname_resolver'
 
 module Trace
   # This class sends information to Zipkin through Kafka.
   # Spans are encoded using Thrift
-  class ZipkinKafkaTracer < ZipkinTracerBase
+  class ZipkinKafkaSender < ZipkinSenderBase
     DEFAULT_KAFKA_TOPIC = "zipkin".freeze
     IP_FORMAT = :i32
 

data/lib/zipkin-tracer/{zipkin_logger_tracer.rb → zipkin_logger_sender.rb}

@@ -1,9 +1,9 @@
-require 'zipkin-tracer/zipkin_tracer_base'
+require 'zipkin-tracer/zipkin_sender_base'
 require 'zipkin-tracer/hostname_resolver'
 require 'json'
 
 module Trace
-  class ZipkinLoggerTracer < ZipkinTracerBase
+  class ZipkinLoggerSender < ZipkinSenderBase
     TRACING_KEY = 'Tracing information'
     IP_FORMAT = :string
 

data/lib/zipkin-tracer/{zipkin_null_tracer.rb → zipkin_null_sender.rb}

@@ -1,8 +1,5 @@
 module Trace
-  # Monkey patching Nulltracer from thrift.
-  # All our tracers have a start_span method, adding it to
-  # the NullTracer also.
-  class NullTracer
+  class NullSender
     def with_new_span(trace_id, name)
       span = start_span(trace_id, name)
       result = yield span

data/lib/zipkin-tracer/{zipkin_tracer_base.rb → zipkin_sender_base.rb}

@@ -1,12 +1,12 @@
 require 'faraday'
 
 module Trace
-  # This class is a base for tracers sending information to Zipkin.
+  # This class is a base for senders sending information to Zipkin.
   # It knows about zipkin types of annotations and send traces when the server
   # is done with its request
-  # Traces dealing with zipkin should inherit from this class and implement the
+  # Senders dealing with zipkin should inherit from this class and implement the
   # flush! method which actually sends the information
-  class ZipkinTracerBase
+  class ZipkinSenderBase
 
     def initialize(options={})
       @options = options

data/lib/zipkin-tracer/zipkin_sqs_sender.rb

@@ -0,0 +1,39 @@
+require "aws-sdk-sqs"
+require "json"
+require 'sucker_punch'
+require "zipkin-tracer/zipkin_sender_base"
+require "zipkin-tracer/hostname_resolver"
+
+module Trace
+  class AsyncSqsClient
+    include SuckerPunch::Job
+
+    def perform(sqs_options, queue_name, spans)
+      spans_with_ips =
+        ::ZipkinTracer::HostnameResolver.new.spans_with_ips(spans, ZipkinSqsSender::IP_FORMAT).map(&:to_h)
+      sqs = Aws::SQS::Client.new(**sqs_options)
+      queue_url = sqs.get_queue_url(queue_name: queue_name).queue_url
+      sqs.send_message(queue_url: queue_url, message_body: JSON.generate(spans_with_ips))
+    rescue Aws::SQS::Errors::NonExistentQueue
+      error_message = "A queue named '#{@queue_name}' does not exist."
+      SuckerPunch.logger.error(error_message)
+    rescue => e
+      SuckerPunch.logger.error(e)
+    end
+  end
+
+  class ZipkinSqsSender < ZipkinSenderBase
+    IP_FORMAT = :string
+
+    def initialize(options)
+      @sqs_options = options[:region] ? { region: options[:region] } : {}
+      @queue_name = options[:queue_name]
+      SuckerPunch.logger = options[:logger]
+      super(options)
+    end
+
+    def flush!
+      AsyncSqsClient.perform_async(@sqs_options, @queue_name, spans.dup)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.36.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -57,6 +57,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -182,11 +196,12 @@ files:
 - lib/zipkin-tracer/trace_generator.rb
 - lib/zipkin-tracer/tracer_factory.rb
 - lib/zipkin-tracer/version.rb
-- lib/zipkin-tracer/zipkin_json_tracer.rb
-- lib/zipkin-tracer/zipkin_kafka_tracer.rb
-- lib/zipkin-tracer/zipkin_logger_tracer.rb
-- lib/zipkin-tracer/zipkin_null_tracer.rb
-- lib/zipkin-tracer/zipkin_tracer_base.rb
+- lib/zipkin-tracer/zipkin_http_sender.rb
+- lib/zipkin-tracer/zipkin_kafka_sender.rb
+- lib/zipkin-tracer/zipkin_logger_sender.rb
+- lib/zipkin-tracer/zipkin_null_sender.rb
+- lib/zipkin-tracer/zipkin_sender_base.rb
+- lib/zipkin-tracer/zipkin_sqs_sender.rb
 homepage: https://github.com/openzipkin/zipkin-tracer
 licenses:
 - Apache-2.0