zipkin 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64080ccd4340703577e687a66f11d77b20085dd3
-  data.tar.gz: 66696c25f4d6f9cfdd41efcb45ee31ea9dec4106
+  metadata.gz: edcdbbb5c2b3a3c8336007ad27cca00fa18e506c
+  data.tar.gz: e53e657b504bfed502e210cb4ece872f5d719391
 SHA512:
-  metadata.gz: ece2023e6ffcf15cf404243f5475975bef6d412f811d844c25ef1b8b913d571fa21563b7ce6e645471a0083a122b5cec0c0c4ee0742d9e4b4fa3b7b5c27e437b
-  data.tar.gz: 0fbc0d768045771542c7d4041385e1c9a379c6e784b7fd448e0cd8d6132844f25608cfe9646cdd9e90a854f27972515064660afe9e17a53787a946bebc557503
+  metadata.gz: 8815bc72662edeaed1773112b382134fa7b113290d6d8b1eeb62650ce18f54204048a3bfef69ae674fbbd6278af6bbc2f4603505691805eb0a260f45c9147475
+  data.tar.gz: c28399023b46377b0f3adc267e7b2b242a2e7998302f1ca3739acc8b2411b459af4d6eeef94061640051e4eadd38cb7181e76efe10bf11d2801dab1e93a4d2b7

data/README.md

@@ -31,6 +31,16 @@ end
 
 See [opentracing-ruby](https://github.com/opentracing/opentracing-ruby) for more examples.
 
+### Samplers
+
+#### Const sampler
+
+`Const` sampler always makes the same decision for new traces depending on the initialization value. Set `sampler` to: `Zipkin::Samplers::Const.new(true)` to mark all new traces as sampled.
+
+#### Probabilistic sampler
+
+`Probabilistic` sampler samples traces with probability equal to `rate` (must be between 0.0 and 1.0). Set `sampler` to `Zipkin::Samplers::Probabilistic.new(rate: 0.1)` to mark 10% of new traces as sampled.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/zipkin/samplers.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'samplers/const'
+require_relative 'samplers/probabilistic'

data/lib/zipkin/samplers/const.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zipkin
+  module Samplers
+    # Const sampler
+    #
+    # A sampler that always makes the same decision for new traces depending
+    # on the initialization value. Use `Zipkin::Samplers::Const.new(true)`
+    # to mark all new traces as sampled.
+    class Const
+      def initialize(decision)
+        @decision = decision
+      end
+
+      def sample?(*)
+        @decision
+      end
+    end
+  end
+end

data/lib/zipkin/samplers/probabilistic.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zipkin
+  module Samplers
+    # Probabilistic sampler
+    #
+    # Sample a portion of traces using trace_id as the random decision
+    class Probabilistic
+      def initialize(rate: 0.001)
+        if rate < 0.0 || rate > 1.0
+          raise "Sampling rate must be between 0.0 and 1.0, got #{rate.inspect}"
+        end
+        @boundary = TraceId::TRACE_ID_UPPER_BOUND * rate
+      end
+
+      def sample?(trace_id:, **)
+        @boundary >= trace_id.to_i(16)
+      end
+    end
+  end
+end

data/lib/zipkin/span_context.rb

@@ -3,9 +3,10 @@
 module Zipkin
   # SpanContext holds the data for a span that gets inherited to child spans
   class SpanContext
-    def self.create_parent_context
+    def self.create_parent_context(sampler = Samplers::Const.new(true))
       trace_id = TraceId.generate
-      new(trace_id: trace_id, span_id: trace_id, sampled: true)
+      sampled = sampler.sample?(trace_id: trace_id)
+      new(trace_id: trace_id, span_id: trace_id, sampled: sampled)
     end
 
     def self.create_from_parent_context(span_context)

data/lib/zipkin/tracer.rb

@@ -12,12 +12,17 @@ require_relative 'endpoint'
 require_relative 'collector'
 require_relative 'scope_manager'
 require_relative 'scope'
+require_relative 'samplers'
 
 module Zipkin
   class Tracer
     DEFAULT_FLUSH_INTERVAL = 10
 
-    def self.build(url:, service_name:, flush_interval: DEFAULT_FLUSH_INTERVAL, logger: Logger.new(STDOUT))
+    def self.build(url:,
+                   service_name:,
+                   flush_interval: DEFAULT_FLUSH_INTERVAL,
+                   logger: Logger.new(STDOUT),
+                   sampler: Samplers::Const.new(true))
       collector = Collector.new(Endpoint.local_endpoint(service_name))
       sender = JsonClient.new(
         url: url,
@@ -26,14 +31,15 @@ module Zipkin
         logger: logger
       )
       sender.start
-      new(collector, sender, logger: logger)
+      new(collector, sender, logger: logger, sampler: sampler)
     end
 
-    def initialize(collector, sender, logger: Logger.new(STDOUT))
+    def initialize(collector, sender, logger: Logger.new(STDOUT), sampler:)
       @collector = collector
       @sender = sender
       @logger = logger
       @scope_manager = ScopeManager.new
+      @sampler = sampler
     end
 
     def stop
@@ -220,7 +226,7 @@ module Zipkin
       if context
         SpanContext.create_from_parent_context(context)
       else
-        SpanContext.create_parent_context
+        SpanContext.create_parent_context(@sampler)
       end
     end
 

data/zipkin.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'zipkin'
-  spec.version       = '1.5.2'
+  spec.version       = '1.6.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipkin
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,9 @@ files:
 - lib/zipkin/collector/timestamp.rb
 - lib/zipkin/endpoint.rb
 - lib/zipkin/json_client.rb
+- lib/zipkin/samplers.rb
+- lib/zipkin/samplers/const.rb
+- lib/zipkin/samplers/probabilistic.rb
 - lib/zipkin/scope.rb
 - lib/zipkin/scope_manager.rb
 - lib/zipkin/scope_manager/scope_identifier.rb