freddy 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f70c4bc02ac5f44642acf811ecc4aa895d76327
-  data.tar.gz: 56373103982583fc804f8a90783de797f8cc371b
+  metadata.gz: 55a9bea9337f7d20d2e713bd012ed8f216fef328
+  data.tar.gz: 2c49767c9226fdf1b882cf221cec8ff7726203f9
 SHA512:
-  metadata.gz: 1e7c1f7fd21ef20f040af3cfadfcf42c9e8e2e44b05d08617e1225d60eb75f9b223dc6cade579bffa0dd08708da89d71896ca4d463d0f44be15ffb81535a047d
-  data.tar.gz: c3f9e83af176f8c8731adf77449e6b32c6adddce91dbb1025db00156bf45c96caac47b68c93607e311624f06a8ed39c43bc878678b9bc4a9d4df001fd40547d4
+  metadata.gz: 7d3c30c1d5d54c72539821bc465f0887371ee30fdcbed3fa4711ee3b9f65137922025a4aa6956ca862b08b851d5bc8bff2d4aac7279a80250475c45a90e475ab
+  data.tar.gz: 13f606726903475c3619ee4f7dd1d18ebe257cbb48844cb0831cf81809b468eeb7143c4d4519b8cd1e6fa00e9d4703dcf9ce1282ebf70d4867419c85a89f42ae

data/README.md

@@ -135,6 +135,35 @@ The following operations are supported:
 responder_handler.shutdown
 ```
 
+## Request Tracing
+
+Freddy helps application developers to implement distributed tracing. Freddy provides trace ID, parent ID and span ID when receiving a request. These can be accessed through a thread-local variable `Freddy.trace`. Calling `deliver` or `deliver_with_response` will pass these IDs to the next service.
+
+```ruby
+freddy1 = Freddy.build
+freddy1.respond_do('service1') do |payload, msg_handler|
+  puts "Trace id: #{Freddy.trace.id}"
+  puts "Span id: #{Freddy.trace.span_id}"
+
+  freddy1.deliver('service2', {})
+end
+
+freddy2 = Freddy.build
+freddy2.tap_into('service2') do |payload|
+  puts "Has same trace_id as the request in service1: #{Freddy.trace.id}"
+  puts "Has service1 request span id as parent id: #{Freddy.trace.parent_id}"
+  puts "Has its own generated span id: #{Freddy.trace.span_id}"
+end
+```
+
+In case you already have trace IDs (e.g. provided by REST API) then you can set them yourself:
+```ruby
+  Freddy.trace = Freddy::Traces::Trace.new({
+    id: 'YourTraceId',
+    parent_id: 'YourParentId', # Use nil in case this is the root of the trace
+    span_id: 'YourSpanId'
+  })
+```
 
 ## Notes about concurrency
 

data/freddy.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   else
     spec.name          = "freddy"
   end
-  spec.version       = '1.0.1'
+  spec.version       = '1.1.0'
   spec.authors       = ["Salemove TechMovers"]
   spec.email         = ["techmovers@salemove.com"]
   spec.description   = %q{Messaging API}

data/lib/freddy/consumers/respond_to_consumer.rb

@@ -37,9 +37,11 @@ class Freddy
       def process_message(delivery, &block)
         @consume_thread_pool.process do
           begin
+            Freddy.trace = delivery.trace
             block.call(delivery)
           ensure
             @channel.acknowledge(delivery.tag, false)
+            Freddy.trace = nil
           end
         end
       end

data/lib/freddy/consumers/tap_into_consumer.rb

@@ -44,9 +44,11 @@ class Freddy
         @consume_thread_pool.process do
           begin
             Consumers.log_receive_event(@logger, queue.name, delivery)
+            Freddy.trace = delivery.trace
             block.call delivery.payload, delivery.routing_key
           ensure
             @channel.acknowledge(delivery.tag, false)
+            Freddy.trace = nil
           end
         end
       end

data/lib/freddy/consumers.rb

@@ -5,7 +5,8 @@ class Freddy
         message: 'Received message',
         queue: queue_name,
         payload: delivery.payload,
-        correlation_id: delivery.correlation_id
+        correlation_id: delivery.correlation_id,
+        trace: Freddy.trace.to_h
       )
     end
   end

data/lib/freddy/delivery.rb

@@ -1,12 +1,13 @@
 class Freddy
   class Delivery
-    attr_reader :routing_key, :payload, :tag
+    attr_reader :routing_key, :payload, :tag, :trace
 
     def initialize(payload, metadata, routing_key, tag)
       @payload = payload
       @metadata = metadata
       @routing_key = routing_key
       @tag = tag
+      @trace = build_trace(metadata.headers || {})
     end
 
     def correlation_id
@@ -20,5 +21,18 @@ class Freddy
     def reply_to
       @metadata.reply_to
     end
+
+    private
+
+    def build_trace(headers)
+      if headers['x-trace-id'] && headers['x-span-id']
+        Traces::Trace.build_from_existing_trace(
+          id: headers['x-trace-id'],
+          parent_id: headers['x-span-id']
+        )
+      else
+        Traces::Trace.build
+      end
+    end
   end
 end

data/lib/freddy/producers/reply_producer.rb

@@ -12,7 +12,12 @@ class Freddy
         Producers.log_send_event(@logger, payload, destination)
 
         properties = properties.merge(
-          routing_key: destination, content_type: CONTENT_TYPE
+          routing_key: destination,
+          content_type: CONTENT_TYPE,
+          headers: {
+            'x-trace-id' => Freddy.trace.id,
+            'x-span-id' => Freddy.trace.span_id
+          }
         )
 
         @exchange.publish Payload.dump(payload), properties

data/lib/freddy/producers/send_and_forget_producer.rb

@@ -12,7 +12,14 @@ class Freddy
       def produce(destination, payload, properties)
         Producers.log_send_event(@logger, payload, destination)
 
-        properties = properties.merge(routing_key: destination, content_type: CONTENT_TYPE)
+        properties = properties.merge(
+          routing_key: destination,
+          content_type: CONTENT_TYPE,
+          headers: {
+            'x-trace-id' => Freddy.trace.id,
+            'x-span-id' => Freddy.trace.span_id
+          }
+        )
         json_payload = Payload.dump(payload)
 
         # Connection adapters handle thread safety for #publish themselves. No

data/lib/freddy/producers/send_and_wait_response_producer.rb

@@ -41,7 +41,11 @@ class Freddy
         properties = properties.merge(
           routing_key: destination, content_type: CONTENT_TYPE,
           correlation_id: correlation_id, reply_to: @response_queue.name,
-          mandatory: true, type: 'request'
+          mandatory: true, type: 'request',
+          headers: {
+            'x-trace-id' => Freddy.trace.id,
+            'x-span-id' => Freddy.trace.span_id
+          }
         )
         json_payload = Payload.dump(payload)
 
@@ -50,7 +54,8 @@ class Freddy
           queue: destination,
           payload: payload,
           response_queue: @response_queue.name,
-          correlation_id: correlation_id
+          correlation_id: correlation_id,
+          trace: Freddy.trace.to_h
         )
 
         # Connection adapters handle thread safety for #publish themselves. No

data/lib/freddy/producers.rb

@@ -1,7 +1,7 @@
 class Freddy
   module Producers
     def self.log_send_event(logger, payload, destination)
-      logger.debug message: 'Sending message', queue: destination, payload: payload
+      logger.debug message: 'Sending message', queue: destination, payload: payload, trace: Freddy.trace.to_h
     end
   end
 end

data/lib/freddy/traces.rb

@@ -0,0 +1,40 @@
+class Freddy
+  module Traces
+    class Trace
+      def self.build
+        id = TraceId.generate
+        span_id = TraceId.generate
+        new(id: id, parent_id: nil, span_id: span_id)
+      end
+
+      def self.build_from_existing_trace(id:, parent_id:)
+        span_id = TraceId.generate
+        new(id: id, parent_id: parent_id, span_id: span_id)
+      end
+
+      attr_reader :id, :parent_id, :span_id
+
+      def initialize(id:, parent_id:, span_id:)
+        @id = id
+        @parent_id = parent_id
+        @span_id = span_id
+      end
+
+      def to_h
+        {id: @id, parent_id: @parent_id, span_id: @span_id}
+      end
+    end
+
+    module TraceId
+      TRACE_ID_UPPER_BOUND = 2 ** 64
+
+      # Generates 64-bit lower-hex encoded ID. This was chosen to be compatible
+      # with tracing frameworks like zipkin.
+      def self.generate
+        rand(TRACE_ID_UPPER_BOUND).to_s(16)
+      end
+    end
+
+    NO_TRACE = Trace.new(id: nil, parent_id: nil, span_id: nil)
+  end
+end

data/lib/freddy.rb

@@ -30,6 +30,14 @@ class Freddy
     new(connection, logger, max_concurrency)
   end
 
+  def self.trace
+    Thread.current[:freddy_trace] || Traces::NO_TRACE
+  end
+
+  def self.trace=(trace)
+    Thread.current[:freddy_trace] = trace
+  end
+
   def initialize(connection, logger, max_concurrency)
     @connection = connection
     @logger = logger

data/spec/freddy/traces/trace_id_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Freddy::Traces::TraceId do
+  describe '.generate' do
+    it 'generates a trace id' do
+      expect(described_class.generate).to_not be_nil
+    end
+  end
+end

data/spec/integration/logging_spec.rb

@@ -27,7 +27,8 @@ describe 'Logging' do
       message: 'Received message',
       queue: destination,
       payload: payload,
-      correlation_id: anything
+      correlation_id: anything,
+      trace: anything
     )
   end
 
@@ -38,7 +39,8 @@ describe 'Logging' do
       queue: destination,
       payload: payload,
       response_queue: anything,
-      correlation_id: anything
+      correlation_id: anything,
+      trace: anything
     )
   end
 end

data/spec/integration/tracing_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+
+describe 'Tracing' do
+  context 'when receiving an untraced request' do
+    let(:freddy) { Freddy.build(logger, config) }
+    let(:destination) { random_destination }
+
+    before do
+      freddy.respond_to(destination) do |payload, msg_handler|
+        msg_handler.success({
+          trace_id: Freddy.trace.id,
+          parent_id: Freddy.trace.parent_id,
+          span_id: Freddy.trace.span_id
+        })
+      end
+    end
+
+    after { freddy.close }
+
+    it 'has generated trace_id' do
+      response = freddy.deliver_with_response(destination, {})
+      expect(response.fetch(:trace_id)).to_not be_nil
+    end
+
+    it 'has no parent_id' do
+      response = freddy.deliver_with_response(destination, {})
+      expect(response.fetch(:parent_id)).to be_nil
+    end
+
+    it 'has generated span_id' do
+      response = freddy.deliver_with_response(destination, {})
+      expect(response.fetch(:span_id)).to_not be_nil
+    end
+  end
+
+  context 'when receiving a traced request' do
+    let(:freddy) { Freddy.build(logger, config) }
+    let(:freddy2) { Freddy.build(logger, config) }
+
+    let(:destination) { random_destination }
+    let(:destination2) { random_destination }
+
+    before do
+      freddy.respond_to(destination) do |payload, msg_handler|
+        msg_handler.success({
+          trace_initiator: {
+            trace_id: Freddy.trace.id,
+            parent_id: Freddy.trace.parent_id,
+            span_id: Freddy.trace.span_id
+          },
+          current_receiver: freddy.deliver_with_response(destination2, {})
+        })
+      end
+
+      freddy2.respond_to(destination2) do |payload, msg_handler|
+        msg_handler.success({
+          trace_id: Freddy.trace.id,
+          parent_id: Freddy.trace.parent_id,
+          span_id: Freddy.trace.span_id
+        })
+      end
+    end
+
+    after do
+      freddy.close
+      freddy2.close
+    end
+
+    it 'has trace_id from the trace initiator' do
+      response = freddy.deliver_with_response(destination, {})
+      trace_initiator = response.fetch(:trace_initiator)
+      current_receiver = response.fetch(:current_receiver)
+      expect(trace_initiator.fetch(:trace_id)).to eq(current_receiver.fetch(:trace_id))
+    end
+
+    it 'has request initiator span_id as parent_id' do
+      response = freddy.deliver_with_response(destination, {})
+      trace_initiator = response.fetch(:trace_initiator)
+      current_receiver = response.fetch(:current_receiver)
+      expect(trace_initiator.fetch(:span_id)).to eq(current_receiver.fetch(:parent_id))
+    end
+
+    it 'has generated span_id' do
+      response = freddy.deliver_with_response(destination, {})
+      trace_initiator = response.fetch(:trace_initiator)
+      current_receiver = response.fetch(:current_receiver)
+      expect(current_receiver.fetch(:span_id)).to_not be_nil
+      expect(current_receiver.fetch(:span_id)).to_not eq(trace_initiator.fetch(:span_id))
+    end
+  end
+
+  context 'when receiving a nested traced request' do
+    let(:freddy) { Freddy.build(logger, config) }
+    let(:freddy2) { Freddy.build(logger, config) }
+    let(:freddy3) { Freddy.build(logger, config) }
+
+    let(:destination) { random_destination }
+    let(:destination2) { random_destination }
+    let(:destination3) { random_destination }
+
+    before do
+      freddy.respond_to(destination) do |payload, msg_handler|
+        msg_handler.success({
+          trace_initiator: {
+            trace_id: Freddy.trace.id,
+            parent_id: Freddy.trace.parent_id,
+            span_id: Freddy.trace.span_id
+          }
+        }.merge(freddy.deliver_with_response(destination2, {})))
+      end
+
+      freddy2.respond_to(destination2) do |payload, msg_handler|
+        msg_handler.success({
+          previous_receiver: {
+            trace_id: Freddy.trace.id,
+            parent_id: Freddy.trace.parent_id,
+            span_id: Freddy.trace.span_id
+          },
+          current_receiver: freddy2.deliver_with_response(destination3, {})
+        })
+      end
+
+      freddy3.respond_to(destination3) do |payload, msg_handler|
+        msg_handler.success({
+          trace_id: Freddy.trace.id,
+          parent_id: Freddy.trace.parent_id,
+          span_id: Freddy.trace.span_id
+        })
+      end
+    end
+
+    after do
+      freddy.close
+      freddy2.close
+      freddy3.close
+    end
+
+    it 'has trace_id from the trace initiator' do
+      response = freddy.deliver_with_response(destination, {})
+      trace_initiator = response.fetch(:trace_initiator)
+      current_receiver = response.fetch(:current_receiver)
+      expect(trace_initiator.fetch(:trace_id)).to eq(current_receiver.fetch(:trace_id))
+    end
+
+    it 'has request initiator span_id as parent_id' do
+      response = freddy.deliver_with_response(destination, {})
+      previous_receiver = response.fetch(:previous_receiver)
+      current_receiver = response.fetch(:current_receiver)
+      expect(previous_receiver.fetch(:span_id)).to eq(current_receiver.fetch(:parent_id))
+    end
+
+    it 'has generated span_id' do
+      response = freddy.deliver_with_response(destination, {})
+      previous_receiver = response.fetch(:previous_receiver)
+      current_receiver = response.fetch(:current_receiver)
+      expect(current_receiver.fetch(:span_id)).to_not be_nil
+      expect(current_receiver.fetch(:span_id)).to_not eq(previous_receiver.fetch(:span_id))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freddy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Salemove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - lib/freddy/responder_handler.rb
 - lib/freddy/sync_response_container.rb
 - lib/freddy/timeout_error.rb
+- lib/freddy/traces.rb
 - spec/freddy/consumers/respond_to_consumer_spec.rb
 - spec/freddy/error_response_spec.rb
 - spec/freddy/freddy_spec.rb
@@ -127,10 +128,12 @@ files:
 - spec/freddy/payload_spec.rb
 - spec/freddy/responder_handler_spec.rb
 - spec/freddy/sync_response_container_spec.rb
+- spec/freddy/traces/trace_id_spec.rb
 - spec/integration/concurrency_spec.rb
 - spec/integration/logging_spec.rb
 - spec/integration/reply_spec.rb
 - spec/integration/tap_into_with_group_spec.rb
+- spec/integration/tracing_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses:
@@ -164,8 +167,10 @@ test_files:
 - spec/freddy/payload_spec.rb
 - spec/freddy/responder_handler_spec.rb
 - spec/freddy/sync_response_container_spec.rb
+- spec/freddy/traces/trace_id_spec.rb
 - spec/integration/concurrency_spec.rb
 - spec/integration/logging_spec.rb
 - spec/integration/reply_spec.rb
 - spec/integration/tap_into_with_group_spec.rb
+- spec/integration/tracing_spec.rb
 - spec/spec_helper.rb