zipkin-tracer 0.46.0 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: facfab4311d80aff894d2c5dec5253ef122ee5206328d875e41d2174373d060e
-  data.tar.gz: eb036ff2009dc9b70933881c12a93cead129127679bbdf9c538e6df067dc04c7
+  metadata.gz: 82721c4960c43ae115304bb20f3cd2bc449118ad9e4a7bab46f83a99faec0d97
+  data.tar.gz: 3ab36bb2a93a25222be0ca3e3a2515c8e25ac76f5cc5d90bde304b76be0d27df
 SHA512:
-  metadata.gz: 6f99f5a59fdfd10c968fb99779aa0c7a97a559b45a36a787c886cac40845964e5cb98a5048313094ecab328d420ed3b01936cd66e1929389fef2e5eed1401b44
-  data.tar.gz: 5edb8af0059d1486a1105cf325ec21ce548f795f0a5078b67e8846d0cda23d05db2ab83075a27d1f6f46b173c10bd324af0683e26bc7ea5bd0695424e13880ba
+  metadata.gz: 03240e5d579ed704b2019c73249a3aaa76b608328b00cbb6b24bbcf9b0e870069b2ef05b41e3bed6af4fdbb4460b0d3a0cce5e91c1fdd1c31a15b9a1f851e14c
+  data.tar.gz: 876c7dd29c0c7adfad87d2207b409acd2a4aa0970ebd15fbe9f0b4820124a6a04038d89c48305896ffb8fa146c6c3957011b44aff44be28467bab4aaaf0ce1e3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.47.0
+* Add a `check_routes` option to make the routable request check optional.
+
 # 0.46.0
 * Add Amazon SQS tracer.
 

data/README.md

@@ -21,6 +21,7 @@ use ZipkinTracer::RackHandler, config
 * `:service_name` **REQUIRED** - the name of the service being traced. There are two ways to configure this value. Either write the service name in the config file or set the "DOMAIN" environment variable (e.g. 'test-service.example.com' or 'test-service'). The environment variable takes precedence over the config file value.
 * `:sample_rate` (default: 0.1) - the ratio of requests to sample, from 0 to 1
 * `:sampled_as_boolean` - When set to true (default but deprecrated), it uses true/false for the `X-B3-Sampled` header. When set to false uses 1/0 which is preferred.
+* `:check_routes` - When set to `true`, only routable requests are sampled. Defaults to `false`.
 * `:trace_id_128bit` - When set to true, high 8-bytes will be prepended to trace_id. The upper 4-bytes are epoch seconds and the lower 4-bytes are random. This makes it convertible to Amazon X-Ray trace ID format v1. (See http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-request-tracing.html)
 * `:async` - By default senders will flush traces asynchronously. Set to `false` to make that process synchronous. Only supported by the HTTP, RabbitMQ, and SQS senders.
 * `:logger` - The default logger for Rails apps is `Rails.logger`, else it is `STDOUT`. Use this option to pass a custom logger.

data/lib/zipkin-tracer/config.rb

@@ -5,7 +5,7 @@ require 'zipkin-tracer/rack/zipkin-tracer'
 module ZipkinTracer
   # Configuration of this gem. It reads the configuration and provides default values
   class Config
-    attr_reader :service_name, :sample_rate, :sampled_as_boolean, :trace_id_128bit, :async, :logger,
+    attr_reader :service_name, :sample_rate, :sampled_as_boolean, :check_routes, :trace_id_128bit, :async, :logger,
       :json_api_host, :zookeeper, :kafka_producer, :kafka_topic, :sqs_queue_name, :sqs_region, :log_tracing,
       :annotate_plugin, :filter_plugin, :whitelist_plugin, :rabbit_mq_connection, :rabbit_mq_exchange,
       :rabbit_mq_routing_key, :write_b3_single_format
@@ -47,6 +47,8 @@ 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
+      # When set to true, only routable requests are sampled
+      @check_routes      = config[:check_routes].nil? ? DEFAULTS[:check_routes] : config[:check_routes]
 
       # When set to true, high 8-bytes will be prepended to trace_id.
       # The upper 4-bytes are epoch seconds and the lower 4-bytes are random.
@@ -95,6 +97,7 @@ module ZipkinTracer
     DEFAULTS = {
       sample_rate: 0.1,
       sampled_as_boolean: true,
+      check_routes: false,
       trace_id_128bit: false,
       write_b3_single_format: false
     }

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

@@ -71,7 +71,7 @@ module ZipkinTracer
       if parent_trace_sampled # A service upstream decided this goes in all the way
         parent_trace_sampled
       else
-        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered? && routable_request?)
+        new_sampled_header_value(force_sample? || current_trace_sampled? && !filtered? && traceable_request?)
       end
     end
 
@@ -83,9 +83,10 @@ module ZipkinTracer
       @config.filter_plugin && !@config.filter_plugin.call(@env)
     end
 
-    def routable_request?
+    def traceable_request?
+      return true unless @config.check_routes
+
       Application.routable_request?(@env)
     end
-
   end
 end

data/lib/zipkin-tracer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipkinTracer
-  VERSION = '0.46.0'
+  VERSION = '0.47.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipkin-tracer
 version: !ruby/object:Gem::Version
-  version: 0.46.0
+  version: 0.47.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday