zipkin-tracer 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f71b9baf08a3f387fc409c40a8997d29da5a8dd48e9d4fa9609b02c2b4f2ea03
-  data.tar.gz: a481c2dc583679f1bbbe4341ac896ad4594a7b7920562344b95ed23f6f266a1f
+  metadata.gz: 05de91c3ee2300d261bd19d481b4fe602e818f48ddce33294791543c04579f20
+  data.tar.gz: 883b5cc753bae954ab8fe432975a40899f617a0771b7352adfefffbc8cb1b0df
 SHA512:
-  metadata.gz: 9bf32473266105e4b8dc1d19d3042937c451962aa8f58deac3f606d04205bc7f0fa8ad856169bd02d216193f22e085d8e7b48a317f99182ec0adf7dedab96509
-  data.tar.gz: cc75da694fe165499b0f84c10d795d1e3e8f4c8fac6814531662c103e80330f668c298b7c76f16c8d94385f6550ff6afb489770cacfa6923d79dab826152c5b8
+  metadata.gz: e0c80c681f43960a95f03c28e34b506d7bf7161fd7b0c5d6ae185a8295ff31782ff99abcb6a43adf0a2053909200cd4f36808122c8e2bf3e20d13d946b4461f3
+  data.tar.gz: 743a4f9c0274c51beab9532cb6603d66499568ecc6c7fde0327fa72786be792653b45b333de970ec78285f2e367ee76d59489f27822d156d78e92d07f7eb20f5

data/.travis.yml

@@ -20,8 +20,8 @@ deploy:
 notifications:
   webhooks:
     urls:
-      - https://webhooks.gitter.im/e/637e968b45032d16ee26
+      - https://webhooks.gitter.im/e/ead3c37d57527214e9f2
+      - https://webhooks.gitter.im/e/e57478303f87ecd7bffc
     on_success: change
     on_failure: always
-    on_start: false
 script: "bundle exec rspec"

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.38.0
+* Add RabbitMQ sender
+
 # 0.37.0
 * Add an `async` option to the HTTP and SQS senders.
 * Allow the `logger` option to be provided.

data/README.md

@@ -30,6 +30,9 @@ use ZipkinTracer::RackHandler, config
 * `:zookeeper` - The address of the zookeeper server to use by the Kafka sender
 * `:sqs_queue_name` - The name of the Amazon SQS queue to use the SQS sender
 * `:sqs_region` - The AWS region for the Amazon SQS queue (optional)
+* `:rabbit_mq_connection` - The bunny connection to be used by the RabbitMQ sender
+* `:rabbit_mq_exchange` - The name of the exchange to be used by the RabbitMQ sender (optional)
+* `:rabbit_mq_routing_key` - The name of the routing key to be used by the RabbitMQ sender (optional)
 * `:log_tracing` - Set to true to log all traces. Only used if traces are not sent to the API or Kafka.
 
 #### Plugins
@@ -142,6 +145,12 @@ The following [Amazon SQS permissions](https://docs.aws.amazon.com/AWSSimpleQueu
 
 Optionally, you can set `:sqs_region` to specify the AWS region to connect to.
 
+### RabbitMQ
+Uses RabbitMQ as the transport
+
+If `:rabbit_mq_connection` is set in the config, then the gem will use RabbitMQ. You will need to pass a [Bunny](https://github.com/ruby-amqp/bunny) connection.
+You can optionally set the exchange name and routing key using `:rabbit_mq_exchange` and `:rabbit_mq_routing_key`
+
 ### Logger
 
 The simplest sender that does something. It will log all your spans.

data/lib/zipkin-tracer/config.rb

@@ -7,7 +7,8 @@ module ZipkinTracer
   class Config
     attr_reader :service_name, :sample_rate, :sampled_as_boolean, :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
+      :annotate_plugin, :filter_plugin, :whitelist_plugin, :rabbit_mq_connection, :rabbit_mq_exchange,
+      :rabbit_mq_routing_key
 
     def initialize(app, config_hash)
       config = config_hash || Application.config(app)
@@ -23,6 +24,10 @@ module ZipkinTracer
       # Amazon SQS queue information
       @sqs_queue_name    = config[:sqs_queue_name]
       @sqs_region        = config[:sqs_region]
+      # Rabbit MQ information
+      @rabbit_mq_connection   = config[:rabbit_mq_connection]
+      @rabbit_mq_exchange     = config[:rabbit_mq_exchange]
+      @rabbit_mq_routing_key  = config[:rabbit_mq_routing_key]
       # 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
@@ -66,6 +71,8 @@ module ZipkinTracer
         :kafka_producer
       elsif present?(@sqs_queue_name) && defined?(Aws::SQS)
         :sqs
+      elsif @rabbit_mq_connection
+        :rabbit_mq
       elsif !!@log_tracing
         :logger
       else

data/lib/zipkin-tracer/tracer_factory.rb

@@ -25,6 +25,16 @@ module ZipkinTracer
             region: config.sqs_region
           }
           Trace::ZipkinSqsSender.new(options)
+        when :rabbit_mq
+          require 'zipkin-tracer/zipkin_rabbit_mq_sender'
+          options = {
+            rabbit_mq_connection: config.rabbit_mq_connection,
+            rabbit_mq_exchange: config.rabbit_mq_exchange,
+            rabbit_mq_routing_key: config.rabbit_mq_routing_key,
+            async: config.async,
+            logger: config.logger
+          }
+          Trace::ZipkinRabbitMqSender.new(options)
         when :logger
           require 'zipkin-tracer/zipkin_logger_sender'
           Trace::ZipkinLoggerSender.new(logger: config.logger)

data/lib/zipkin-tracer/version.rb

@@ -1,3 +1,3 @@
 module ZipkinTracer
-  VERSION = '0.37.0'.freeze
+  VERSION = '0.38.0'.freeze
 end

data/lib/zipkin-tracer/zipkin_rabbit_mq_sender.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'sucker_punch'
+require 'zipkin-tracer/zipkin_sender_base'
+require 'zipkin-tracer/hostname_resolver'
+
+module Trace
+  class RabbitMqPublisher
+    include SuckerPunch::Job
+
+    def perform(exchange, routing_key, spans)
+      spans_with_ips = ::ZipkinTracer::HostnameResolver.new
+        .spans_with_ips(spans, ZipkinRabbitMqSender::IP_FORMAT)
+        .map(&:to_h)
+
+      message = JSON.generate(spans_with_ips)
+
+      exchange.publish(message, routing_key: routing_key)
+    rescue => e
+      SuckerPunch.logger.error(e)
+    end
+  end
+
+  # This class sends information to the Zipkin RabbitMQ Collector.
+  class ZipkinRabbitMqSender < ZipkinSenderBase
+    IP_FORMAT = :string
+    DEFAULT_EXCHANGE = ''
+    DEAFULT_ROUTING_KEY = 'zipkin'
+
+    def initialize(options)
+      connection = options[:rabbit_mq_connection]
+      channel = connection.create_channel
+      exchange_name = options[:rabbit_mq_exchange] || DEFAULT_EXCHANGE
+      @routing_key = options[:rabbit_mq_routing_key] || DEAFULT_ROUTING_KEY
+      @exchange = channel.exchange(exchange_name)
+      @async = options[:async] != false
+      SuckerPunch.logger = options[:logger]
+
+      super(options)
+    end
+
+    def flush!
+      if @async
+        RabbitMqPublisher.perform_async(@exchange, @routing_key, spans.dup)
+      else
+        RabbitMqPublisher.new.perform(@exchange, @routing_key, spans)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -229,6 +229,7 @@ files:
 - 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_rabbit_mq_sender.rb
 - lib/zipkin-tracer/zipkin_sender_base.rb
 - lib/zipkin-tracer/zipkin_sqs_sender.rb
 - zipkin-tracer.gemspec
@@ -253,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby tracing via Zipkin