zipkin-tracer 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4657331271ed370854d23b33e9980047aeded135
-  data.tar.gz: 57ffc30cb2d965e4d4a257de2dbcf3d944e447e4
+  metadata.gz: 2115e2652361d00e2c3d148675b02f876dc40fab
+  data.tar.gz: a5994a1577f75b9540f0bf304cb11a8f7767d687
 SHA512:
-  metadata.gz: 42b879ff2bc2dff5106025e0639bfc6b3f87e63e8de628cd88e2d8e2ca9e22f6396aadfae57e469816b4f0e44c39d6ae30b26d6a6217d3894fd2bcc2067985ae
-  data.tar.gz: a8b99ee0c3edbbade8f4812c3b02353b99c24acaaaa6e29f2bf4d63eee0b205a5bab079adc124f417544ec81bce5463b3c5707ba4383871063513eb2eb5ad826
+  metadata.gz: 68e707aee3cc6caf499c0421ffbae6fcd24a53342d764cddbfa7e588dab91c6e637d0000ab5c4272b2969e5d511fcc042fcadaa409032e08f04a3084b5d0734b
+  data.tar.gz: 7c6fcbd64fc30ea50a1381e19925c16f9e4da588086ef2950240a132e5e66824dbbc06c4fe43161d4dad06e599e8daa22da3d18ebcfbf2d09bf189f6205c0b41

data/lib/zipkin-tracer.rb

@@ -2,6 +2,8 @@ require 'base64' #Bug in finagle. They should be requiring this: finagle-thrift-
 require 'zipkin-tracer/trace'
 require 'zipkin-tracer/rack/zipkin-tracer'
 require 'zipkin-tracer/trace_client'
+require 'zipkin-tracer/trace_container'
+require 'zipkin-tracer/trace_generator'
 
 begin
   require 'faraday'

data/lib/zipkin-tracer/config.rb

@@ -39,6 +39,7 @@ module ZipkinTracer
       if @sampled_as_boolean
         @logger && @logger.warn("Using a boolean in the Sampled header is deprecated. Consider setting sampled_as_boolean to false")
       end
+      Trace.sample_rate = @sample_rate
     end
 
     def adapter

data/lib/zipkin-tracer/faraday/zipkin-tracer.rb

@@ -12,8 +12,8 @@ module ZipkinTracer
     end
 
     def call(env)
-      trace_id = Trace.id.next_id
-      Trace.with_trace_id(trace_id) do
+      trace_id = TraceGenerator.new.next_trace_id
+      TraceContainer.with_trace_id(trace_id) do
         b3_headers.each do |method, header|
           env[:request_headers][header] = trace_id.send(method).to_s
         end

data/lib/zipkin-tracer/rack/zipkin-tracer.rb

@@ -1,16 +1,3 @@
-# Copyright 2012 Twitter Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 require 'finagle-thrift/trace'
 require 'finagle-thrift/tracer'
 require 'zipkin-tracer/config'
@@ -30,7 +17,7 @@ module ZipkinTracer
     def call(env)
       zipkin_env = ZipkinEnv.new(env, @config)
       trace_id = zipkin_env.trace_id
-      Trace.with_trace_id(trace_id) do
+      TraceContainer.with_trace_id(trace_id) do
         if !trace_id.sampled? || !routable_request?(env)
           @app.call(env)
         else

data/lib/zipkin-tracer/trace.rb

@@ -1,6 +1,7 @@
 require 'finagle-thrift/trace'
 require 'zipkin-tracer/zipkin_tracer_base'
-
+# Module with a mix of functions and overwrites from the finagle implementation:
+# https://github.com/twitter/finagle/blob/finagle-6.39.0/finagle-thrift/src/main/ruby/lib/finagle-thrift/trace.rb
 module Trace
 
   # We need this to access the tracer from the Faraday middleware.
@@ -8,11 +9,8 @@ module Trace
     @tracer
   end
 
-  def self.with_trace_id(trace_id, &block)
-    self.push(trace_id)
-    yield
-  ensure
-    self.pop
+  def sample_rate
+    @sample_rate
   end
 
   # A TraceId contains all the information of a given trace id

data/lib/zipkin-tracer/trace_client.rb

@@ -4,19 +4,19 @@ module ZipkinTracer
     end
   end
 
+  # The trace client provides the user of this library an API to interact
+  # with tracing information.
   class TraceClient
     def self.local_component_span(local_component_value, &block)
-      client = self.new
-      client.trace(local_component_value, &block)
+      new.trace(local_component_value, &block)
     end
 
     def trace(local_component_value, &block)
       raise ArgumentError, "no block given" unless block
-
-      @trace_id = Trace.id.next_id
+      @trace_id = TraceGenerator.new.next_trace_id
       result = nil
       if @trace_id.sampled?
-        Trace.with_trace_id(@trace_id) do
+        TraceContainer.with_trace_id(@trace_id) do
           Trace.tracer.with_new_span(@trace_id, local_component_value) do |span|
             result = block.call(span)
             span.record_local_component local_component_value

data/lib/zipkin-tracer/trace_container.rb

@@ -0,0 +1,34 @@
+module ZipkinTracer
+  # This class manages a thread-unique container with the stack of traceIds
+  # This stack may grow if for instance the current process creates local components inside local components
+  class TraceContainer
+    class << self
+      def with_trace_id(trace_id, &_block)
+        container.push(trace_id)
+        yield
+      ensure
+        container.pop
+      end
+
+      def current
+        container.last
+      end
+
+      def tracing_information_set?
+        !container.empty?
+      end
+
+      # DO NOT USE unless you ABSOLUTELY know what you are doing.
+      def cleanup!
+        Thread.current[TRACE_STACK] = []
+      end
+
+      private
+
+      def container
+        Thread.current[TRACE_STACK] ||= []
+      end
+      TRACE_STACK = :trace_stack
+    end
+  end
+end

data/lib/zipkin-tracer/trace_generator.rb

@@ -0,0 +1,31 @@
+module ZipkinTracer
+  # This class generates trace ids.
+  class TraceGenerator
+    # Next id, based on the current information in the container
+    def next_trace_id
+      if TraceContainer.tracing_information_set?
+        TraceContainer.current.next_id
+      else
+        generate_trace_id
+      end
+    end
+
+    def generate_trace_id
+      span_id = generate_id
+      Trace::TraceId.new(span_id, nil, span_id, should_sample?.to_s, Trace::Flags::EMPTY)
+    end
+
+    def should_sample?
+      rand < (Trace.sample_rate || DEFAULT_SAMPLE_RATE)
+    end
+
+    private
+
+    def generate_id
+      rand(TRACE_ID_UPPER_BOUND)
+    end
+
+    TRACE_ID_UPPER_BOUND = 2**64
+    DEFAULT_SAMPLE_RATE = 0.001
+  end
+end

data/lib/zipkin-tracer/version.rb

@@ -1,16 +1,3 @@
-# Copyright 2012 Twitter Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 module ZipkinTracer
-  VERSION = '0.19.1'.freeze
+  VERSION = '0.20.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -162,6 +162,8 @@ files:
 - lib/zipkin-tracer/rack/zipkin_env.rb
 - lib/zipkin-tracer/trace.rb
 - lib/zipkin-tracer/trace_client.rb
+- lib/zipkin-tracer/trace_container.rb
+- lib/zipkin-tracer/trace_generator.rb
 - lib/zipkin-tracer/tracer_factory.rb
 - lib/zipkin-tracer/version.rb
 - lib/zipkin-tracer/zipkin_json_tracer.rb
@@ -170,7 +172,8 @@ files:
 - lib/zipkin-tracer/zipkin_null_tracer.rb
 - lib/zipkin-tracer/zipkin_tracer_base.rb
 homepage: https://github.com/openzipkin/zipkin-tracer
-licenses: []
+licenses:
+- Apache
 metadata: {}
 post_install_message: 
 rdoc_options: []