freddy 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6809d8dfe197985c19b6532983f40188859b6bd6
-  data.tar.gz: c1d04587a9098019a7a7ccb832c520cabfa6031d
+  metadata.gz: 98d55ddef79dc7231d80d81a8c777a20ffa09685
+  data.tar.gz: c3f6ab7881cc7c22bcee599db7c60318522fe8a2
 SHA512:
-  metadata.gz: d3d3963b6684b4666459e31f5985da07243ef7296cd19c60d63a54f1abde9a1f6e960a60d49eabc3922b9a92a15a01b9a96fdfc759f5f96aa24098793723313e
-  data.tar.gz: 9b9e3e1dd2d0660163f7bbad86ecced0e710a1ec6c34ccc9c0c5af1f77f492f9cb7ae4975813e82a2f620d4cae1a376e27d21cadeb9d57f7483900e0d5468436
+  metadata.gz: fb2fb6945b67811ed7b211d360ffba3f0b63a2ba4a8dcc7bf5f94f3f8c46ca0fb9092a0ab982b69804bf4d054152df1ac4a8bf01df98058bb095890820f86482
+  data.tar.gz: c56d8aaffbe32d22c5e5e761f4a13d0c9075ca398ca5865c4808d9d9b38e3c550b64326bb747d8de4141eaeddeb582614ad8aafd9f0e772349a30948850b8f27

data/Gemfile

@@ -4,6 +4,6 @@ gem 'rspec'
 gem 'pry'
 gem 'codeclimate-test-reporter'
 gem 'hamster', '~> 3.0'
-gem 'logasm-tracer', '0.3.0'
+gem 'opentracing_test_tracer', '~> 0.1'
 
 gemspec

data/README.md

@@ -142,34 +142,9 @@ Freddy supports [OpenTracing API|https://github.com/opentracing/opentracing-ruby
 OpenTracing.global_tracing = MyTracerImplementation.new(...)
 ```
 
-For example you can use [Logasm::Tracer](https://github.com/salemove/logasm-tracer) which will log all incoming and outgoing requests with trace ID, parent ID and span ID.
+Current trace can be accessed through a thread-local variable `OpenTracing.active_span`. Calling `deliver` or `deliver_with_response` will pass trace context to down-stream services.
 
-Current trace can be accessed through a thread-local variable `Freddy.trace`. Calling `deliver` or `deliver_with_response` will pass trace context to down-stream services.
-
-Accessing trace information when using Logasm::Tracer implementation:
-
-```ruby
-freddy1 = Freddy.build
-freddy1.respond_do('service1') do |payload, msg_handler|
-  puts "Trace id: #{Freddy.trace.context.trace_id}"
-  puts "Span id: #{Freddy.trace.context.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.context.trace_id}"
-  puts "Has service1 request span id as parent id: #{Freddy.trace.context.parent_id}"
-  puts "Has its own generated span id: #{Freddy.trace.context.span_id}"
-end
-```
-
-In case you already have an ongoing OpenTracing span (e.g. provided by REST API) then you can pass the trace information to Freddy by doing:
-```ruby
-  Freddy.trace = trace_span
-```
-The `trace_span` must implement OpenTracing::Span interface.
+See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more information.
 
 ## Notes about concurrency
 

data/freddy.gemspec

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

data/lib/freddy/consumers/respond_to_consumer.rb

@@ -34,14 +34,14 @@ class Freddy
       def process_message(delivery, &block)
         @consume_thread_pool.process do
           begin
-            Freddy.trace = delivery.build_trace("freddy:respond:#{@destination}",
+            scope = delivery.build_trace("freddy:respond:#{@destination}",
               tags: {
                 'peer.address': "#{@destination}:#{delivery.payload[:type]}",
                 'component': 'freddy',
                 'span.kind': 'server' # RPC
               }
             )
-            Freddy.trace.log_kv(
+            scope.span.log_kv(
               event: 'Received message through respond_to',
               queue: @destination,
               payload: delivery.payload,
@@ -51,8 +51,7 @@ class Freddy
             block.call(delivery)
           ensure
             @channel.acknowledge(delivery.tag, false)
-            Freddy.trace.finish
-            Freddy.trace = nil
+            scope.close
           end
         end
       end

data/lib/freddy/consumers/tap_into_consumer.rb

@@ -42,7 +42,7 @@ class Freddy
       def process_message(queue, delivery, &block)
         @consume_thread_pool.process do
           begin
-            Freddy.trace = delivery.build_trace("freddy:observe:#{@pattern}",
+            scope = delivery.build_trace("freddy:observe:#{@pattern}",
               tags: {
                 'message_bus.destination': @pattern,
                 'component': 'freddy',
@@ -50,7 +50,7 @@ class Freddy
               },
               force_follows_from: true
             )
-            Freddy.trace.log_kv(
+            scope.span.log_kv(
               event: 'Received message through tap_into',
               payload: delivery.payload,
               correlation_id: delivery.correlation_id
@@ -59,8 +59,7 @@ class Freddy
             block.call delivery.payload, delivery.routing_key
           ensure
             @channel.acknowledge(delivery.tag, false)
-            Freddy.trace.finish
-            Freddy.trace = nil
+            scope.close
           end
         end
       end

data/lib/freddy/delivery.rb

@@ -23,23 +23,18 @@ class Freddy
 
     def build_trace(operation_name, tags: {}, force_follows_from: false)
       carrier = TraceCarrier.new(@metadata)
-      parent =
-        if expecting_response? && !force_follows_from
-          OpenTracing.global_tracer.extract(OpenTracing::FORMAT_TEXT_MAP, carrier)
+      parent = OpenTracing.global_tracer.extract(OpenTracing::FORMAT_TEXT_MAP, carrier)
+
+      references =
+        if !parent
+          []
+        elsif force_follows_from
+          [OpenTracing::Reference.follows_from(parent)]
         else
-          nil
+          [OpenTracing::Reference.child_of(parent)]
         end
 
-      # Creating a child span when the message sender is expecting a response.
-      # Otherwise creating a new trace because the OpenTracing client does not
-      # support FollowsFrom yet.
-      OpenTracing.start_span(operation_name, child_of: parent, tags: tags)
-    end
-
-    private
-
-    def expecting_response?
-      type == 'request'
+      OpenTracing.start_active_span(operation_name, references: references, tags: tags)
     end
   end
 end

data/lib/freddy/producers/reply_producer.rb

@@ -9,7 +9,11 @@ class Freddy
       end
 
       def produce(destination, payload, properties)
-        Freddy.trace.log_kv event: 'Sending response', queue: destination, payload: payload
+        OpenTracing.active_span.log_kv(
+          event: 'Sending response',
+          queue: destination,
+          payload: payload
+        )
 
         properties = properties.merge(
           routing_key: destination,

data/lib/freddy/producers/send_and_forget_producer.rb

@@ -11,7 +11,6 @@ class Freddy
 
       def produce(destination, payload, properties)
         span = OpenTracing.start_span("freddy:notify:#{destination}",
-          child_of: Freddy.trace,
           tags: {
             'message_bus.destination': destination,
             'component': 'freddy',

data/lib/freddy/producers/send_and_wait_response_producer.rb

@@ -24,11 +24,10 @@ class Freddy
 
       def produce(destination, payload, timeout_in_seconds:, delete_on_timeout:, **properties)
         span = OpenTracing.start_span("freddy:request:#{destination}",
-          child_of: Freddy.trace,
           tags: {
             'component': 'freddy',
             'span.kind': 'client', # RPC
-            'payload.type': payload[:type]
+            'payload.type': payload[:type] || 'unknown'
           }
         )
 

data/lib/freddy.rb

@@ -32,12 +32,16 @@ class Freddy
     new(connection, logger, max_concurrency)
   end
 
+  # @deprecated Use {OpenTracing.active_span} instead
   def self.trace
-    Thread.current[:freddy_trace]
+    OpenTracing.active_span
   end
 
+  # @deprecated Use OpenTracing ScopeManager instead
   def self.trace=(trace)
-    Thread.current[:freddy_trace] = trace
+    if OpenTracing.active_span != trace
+      OpenTracing.scope_manager.activate(trace)
+    end
   end
 
   def initialize(connection, logger, max_concurrency)

data/spec/integration/tracing_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
-require 'logasm/tracer'
+require 'opentracing_test_tracer'
 
 describe 'Tracing' do
-  let(:tracer) { Logasm::Tracer.new(logger) }
+  let(:tracer) { OpenTracingTestTracer.build(logger: logger) }
   let(:logger) { spy }
 
   before { OpenTracing.global_tracer = tracer }
@@ -19,9 +19,9 @@ describe 'Tracing' do
       freddy.respond_to(destination) do |payload, msg_handler|
         msg_handler.success({
           trace_initiator: {
-            trace_id: Freddy.trace.context.trace_id,
-            parent_id: Freddy.trace.context.parent_id,
-            span_id: Freddy.trace.context.span_id
+            trace_id: active_span.context.trace_id,
+            parent_id: active_span.context.parent_id,
+            span_id: active_span.context.span_id
           },
           current_receiver: freddy.deliver_with_response(destination2, {})
         })
@@ -29,9 +29,9 @@ describe 'Tracing' do
 
       freddy2.respond_to(destination2) do |payload, msg_handler|
         msg_handler.success({
-          trace_id: Freddy.trace.context.trace_id,
-          parent_id: Freddy.trace.context.parent_id,
-          span_id: Freddy.trace.context.span_id
+          trace_id: active_span.context.trace_id,
+          parent_id: active_span.context.parent_id,
+          span_id: active_span.context.span_id
         })
       end
     end
@@ -76,9 +76,9 @@ describe 'Tracing' do
       freddy.respond_to(destination) do |payload, msg_handler|
         msg_handler.success({
           trace_initiator: {
-            trace_id: Freddy.trace.context.trace_id,
-            parent_id: Freddy.trace.context.parent_id,
-            span_id: Freddy.trace.context.span_id
+            trace_id: active_span.context.trace_id,
+            parent_id: active_span.context.parent_id,
+            span_id: active_span.context.span_id
           }
         }.merge(freddy.deliver_with_response(destination2, {})))
       end
@@ -86,9 +86,9 @@ describe 'Tracing' do
       freddy2.respond_to(destination2) do |payload, msg_handler|
         msg_handler.success({
           previous_receiver: {
-            trace_id: Freddy.trace.context.trace_id,
-            parent_id: Freddy.trace.context.parent_id,
-            span_id: Freddy.trace.context.span_id
+            trace_id: active_span.context.trace_id,
+            parent_id: active_span.context.parent_id,
+            span_id: active_span.context.span_id
           },
           current_receiver: freddy2.deliver_with_response(destination3, {})
         })
@@ -96,9 +96,9 @@ describe 'Tracing' do
 
       freddy3.respond_to(destination3) do |payload, msg_handler|
         msg_handler.success({
-          trace_id: Freddy.trace.context.trace_id,
-          parent_id: Freddy.trace.context.parent_id,
-          span_id: Freddy.trace.context.span_id
+          trace_id: active_span.context.trace_id,
+          parent_id: active_span.context.parent_id,
+          span_id: active_span.context.span_id
         })
       end
     end
@@ -130,4 +130,8 @@ describe 'Tracing' do
       expect(current_receiver.fetch(:span_id)).to_not eq(previous_receiver.fetch(:span_id))
     end
   end
+
+  def active_span
+    OpenTracing.active_span
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freddy
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Salemove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,7 +144,6 @@ files:
 - spec/freddy/sync_response_container_spec.rb
 - spec/freddy/trace_carrier_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
@@ -183,7 +182,6 @@ test_files:
 - spec/freddy/sync_response_container_spec.rb
 - spec/freddy/trace_carrier_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

data/spec/integration/logging_spec.rb

@@ -1,101 +0,0 @@
-require 'spec_helper'
-require 'logasm/tracer'
-
-describe 'Logging with Logasm::Tracer' do
-  let(:logger) { ArrayLogger.new }
-  let(:tracer) { Logasm::Tracer.new(logger) }
-
-  before { OpenTracing.global_tracer = tracer }
-  after { OpenTracing.global_tracer = nil }
-
-  context 'when receiving an untraced request' do
-    let(:freddy) { Freddy.build(spy, config) }
-    let(:destination) { random_destination }
-
-    before do
-      freddy.respond_to(destination) do |payload, msg_handler|
-        sleep 0.1 # emulate some processing
-        msg_handler.success({})
-      end
-    end
-
-    after { freddy.close }
-
-    it 'generates a trace' do
-      freddy.deliver_with_response(destination, {})
-
-      expect(logger.calls.map(&:first)).to eq([
-        # Initiator
-        "Span [freddy:request:#{destination}] started",
-        "Span [freddy:request:#{destination}] Publishing request",
-
-        # Service
-        "Span [freddy:respond:#{destination}] started",
-        "Span [freddy:respond:#{destination}] Received message through respond_to",
-        "Span [freddy:respond:#{destination}] Sending response",
-        "Span [freddy:respond:#{destination}] finished",
-
-        # Initiator
-        "Span [freddy:request:#{destination}] finished"
-      ])
-    end
-  end
-
-  context 'when receiving a traced request' do
-    let(:freddy) { Freddy.build(spy, config) }
-    let(:freddy2) { Freddy.build(spy, config) }
-
-    let(:destination) { random_destination }
-    let(:destination2) { random_destination }
-
-    before do
-      freddy.respond_to(destination) do |payload, msg_handler|
-        sleep 0.1 # emulate some processing
-        msg_handler.success({
-          trace_initiator: {},
-          current_receiver: freddy.deliver_with_response(destination2, {})
-        })
-      end
-
-      freddy2.respond_to(destination2) do |payload, msg_handler|
-        sleep 0.1 # emulate some processing
-        msg_handler.success({})
-      end
-    end
-
-    after do
-      freddy.close
-      freddy2.close
-    end
-
-    it 'generates a trace' do
-      freddy.deliver_with_response(destination, {})
-
-      expect(logger.calls.map(&:first)).to eq([
-        # Initiator
-        "Span [freddy:request:#{destination}] started",
-        "Span [freddy:request:#{destination}] Publishing request",
-
-        # Service 1
-        "Span [freddy:respond:#{destination}] started",
-        "Span [freddy:respond:#{destination}] Received message through respond_to",
-        "Span [freddy:request:#{destination2}] started",
-        "Span [freddy:request:#{destination2}] Publishing request",
-
-        # Service 2
-        "Span [freddy:respond:#{destination2}] started",
-        "Span [freddy:respond:#{destination2}] Received message through respond_to",
-        "Span [freddy:respond:#{destination2}] Sending response",
-        "Span [freddy:respond:#{destination2}] finished",
-
-        # Service 1
-        "Span [freddy:request:#{destination2}] finished",
-        "Span [freddy:respond:#{destination}] Sending response",
-        "Span [freddy:respond:#{destination}] finished",
-
-        # Initiator
-        "Span [freddy:request:#{destination}] finished"
-      ])
-    end
-  end
-end