aws-xray 0.18.0.beta3 → 0.19.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab0c256c45eee8ab62e675a7e53f043e75914c00
-  data.tar.gz: f8fe4dffa221f8a72747f052617fb20620db4ccb
+  metadata.gz: 9f0218d89ab6e56b753057c38781e756412ca766
+  data.tar.gz: 232fb91a69d318c535249803a4c1f292158b4331
 SHA512:
-  metadata.gz: c98df8d0212f4e46af8e98c965020a008fe7fbbedd9ae7c3f15c1484fdfad633c1a95390d6513de48123198ef37dd79bb30fad095c87cce65068db358b4cc581
-  data.tar.gz: 35bf66eda77816c8871e37ab27ee0851fabdb102f3a68ab9789da601027276deb15d6305577c2b9ca1890fe59bdf043316c8c1c9737d05615da4c8fbed9d6df5
+  metadata.gz: da3574d466ec8181955f4d3919c95240da461339c2ef101c33c8d34dd652b995b75ee5d00319302ee7f5e7513e3d3484e4d9d43d2cc08fbc2f043ffee37d08df
+  data.tar.gz: 277dedd93475c26178400807dfb2aaa7b8cf0c27e9cc032c815a52271fcc0848db66ec4dce0903a6b902f83257fed4469061c0428a4b9da8a180db60e8ea687a

data/README.md

@@ -16,6 +16,7 @@ AWS X-Ray is a ditributed tracing system. See more detail about AWS X-Ray at [of
 - Tracing HTTP request/response.
 - Tracing errors.
 - Annotation and metadata support.
+- Sampling support.
 
 ## Installation
 
@@ -142,6 +143,17 @@ For that case, pass `AWS_XRAY_LOCATION` environment variable to container to spe
 docker run --link xray:xray --env AWS_XRAY_LOCATION=xray:2000 my-application
 ```
 
+### Sampling
+Sampling rate should be a float within 0 to 1. Both 0 and 1 are acceptable.
+e.g. 0 means never sampled, 1 means always sampled, 0.3 means 30% of requests (or traces in not Rack app) will be sampled.
+The default sampling rate is `0.001`, which means 0.1% of requests will be sampled.
+
+Set sampling rate with `AWS_XRAY_SAMPLING_RATE` env var or:
+
+```ruby
+Aws::Xray.config.sampling_rate = 0.1
+```
+
 ### Excluded paths
 To avoid tracing health checking requests, use "excluded paths" configuration.
 

data/lib/aws/xray/configuration.rb

@@ -90,6 +90,14 @@ module Aws
         Aws::Xray::Worker.reset(conf)
         conf
       end
+
+      # Default is 0.1%.
+      # @return [Float]
+      def sampling_rate
+        @sampling_rate ||= Float(ENV['AWS_XRAY_SAMPLING_RATE'] || 0.001)
+      end
+      # @param [Float] sampling_rate
+      attr_writer :sampling_rate
     end
   end
 end

data/lib/aws/xray/context.rb

@@ -88,7 +88,7 @@ module Aws
           raise e
         ensure
           base_segment.finish
-          @client.send_segment(base_segment)
+          @client.send_segment(base_segment) if @trace.sampled?
         end
       end
 
@@ -107,7 +107,7 @@ module Aws
           raise e
         ensure
           sub.finish
-          @client.send_segment(sub)
+          @client.send_segment(sub) if @trace.sampled?
         end
       end
 

data/lib/aws/xray/trace.rb

@@ -13,11 +13,27 @@ module Aws
         def build_from_header_value(header_value, now = Time.now)
           h = HeaderParser.parse(header_value)
           root = h['Root'] || generate_root(now)
-          new(root: root, sampled: h['Sampled'] != '0', parent: h['Parent'])
+          new(root: root, sampled: decide_sampling(h['Sampled']), parent: h['Parent'])
         end
 
         private
 
+        # Decide sample this request or not. At first, check parent's sampled
+        # and follow the value if it exists. Then decide sampled or not
+        # according to configured sampling_rate.
+        # @param [String,nil] value
+        # @return [Bloolean]
+        def decide_sampling(value)
+          case value
+          when '0'
+            false
+          when '1'
+            true
+          else
+            rand < Aws::Xray.config.sampling_rate
+          end
+        end
+
         def generate_root(now)
           "1-#{now.to_i.to_s(16)}-#{SecureRandom.hex(12)}"
         end

data/lib/aws/xray/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module Xray
-    VERSION = '0.18.0.beta3'
+    VERSION = '0.19.0.beta1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-xray
 version: !ruby/object:Gem::Version
-  version: 0.18.0.beta3
+  version: 0.19.0.beta1
 platform: ruby
 authors:
 - Taiki Ono
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-17 00:00:00.000000000 Z
+date: 2017-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday