vault-tools 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adc8f6e6c5ee7e9b6541bf1c2b648da32c3f3a41
-  data.tar.gz: f7693d48d7884ef6a6c19e4c55363f5ace6a96be
+  metadata.gz: 003733a1fd2fb3c6924f3e69236f295bc838f5b2
+  data.tar.gz: 818aaedd087e4b62fab37ff04565b79ed2bb6731
 SHA512:
-  metadata.gz: 49408781a862dc065024224e91dcbae3525cc523f411bfd544425665549f4879b68f78fb29fd06912e490c83e5cfc61f2cc7ea177e7160a16135d87589894530
-  data.tar.gz: 5a999f0230917d765be377582ccd72005e8675c7da04b2b269894a385ca4d52aaf5c364ce235f6a30bb3539ce2ca3da40cf0a70c30a2c207db26a2498cf21900
+  metadata.gz: 424c9254b97085ec0c34f91d360e664ac7c0df66a77a7428db89acaf8277700db0a33c267ffb98f8e12d87b53766b8b2117b93e08dfda2a7aab040df4054c970
+  data.tar.gz: d21141eed390e9785e789e9dccf1c29bf77c2b52302240c04b61980af5dbc8d7631fe93387276396b8192087f07394676ddfe749aff9d469a2ae1574d2748ef0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vault-tools (0.6.2)
+    vault-tools (0.6.3)
       aws-sdk (~> 1.0)
       coderay
       excon
@@ -26,6 +26,7 @@ GEM
       nokogiri (~> 1)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
     dotenv (2.0.0)
     excon (0.60.0)
     faraday (0.14.0)
@@ -61,12 +62,18 @@ GEM
       rack (>= 1.0)
     rake (10.4.2)
     rdoc (6.0.1)
+    redis (4.0.1)
     rollbar (2.7.1)
       multi_json
     rr (1.1.2)
     scrolls (0.9.0)
     shotgun (0.9.1)
       rack (>= 1.0)
+    sidekiq (5.1.1)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
     sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
@@ -108,6 +115,7 @@ DEPENDENCIES
   rake
   rdoc
   shotgun
+  sidekiq
   vault-test-tools
   vault-tools!
   yard

data/lib/vault-tools.rb

@@ -101,4 +101,6 @@ require 'vault-tools/time'
 require 'vault-tools/s3'
 require 'vault-tools/statement_store'
 require 'vault-tools/rollbar_helper'
+require 'vault-tools/tracing/sidekiq_client'
+require 'vault-tools/tracing/sidekiq_server'
 require 'vault-tools/tracing'

data/lib/vault-tools/tracing.rb

@@ -1,8 +1,11 @@
+require 'zipkin-tracer'
+
 module Vault
   module Tracing
     ZIPKIN_API_HOST_STAGING = 'https://zipkin-staging.heroku.tools'.freeze
 
-    # Injects the zipkin middleware into the Web class.
+    # Injects the zipkin middleware into the Web class, add Zipkin middleware to
+    # Excon, and adds Zipkin middleware to Sidekiq.
     #
     # @example
     #   Vault::Tracing.configure
@@ -13,6 +16,31 @@ module Vault
 
       Vault::Web.instance_eval { require 'zipkin-tracer' }
       Vault::Web.use ZipkinTracer::RackHandler, config
+      setup_excon
+      setup_sidekiq
+    end
+
+    # Traces a local component. Useful to track down long running implementation
+    # methods within an app, instead of only tracing external calls.
+    #
+    # @param name [String] the name of the span to record in Zipkin.
+    # @param tracer [Constant] the const that should respond to :local_component_span
+    # @param options [Hash] the options to create a message with.
+    #
+    # @example
+    #   Vault::Tracing.trace_local 'cashier_middleware_x', internal: true do
+    #     # some expensive task
+    #   end
+    #
+    # @yield [the_block_passed_in]
+    def self.trace_local(name, tracer = ZipkinTracer::TraceClient, **options)
+      return yield unless Vault::Tracing.enabled?
+
+      tracer.local_component_span(name) do |span|
+        span.name = name
+        span.record_tag('options', options.to_s) unless options.empty?
+        yield
+      end
     end
 
     # Configuration options for the Zipkin RackHandler.
@@ -20,7 +48,7 @@ module Vault
     # @return [Hash] config options for Zipkin tracer
     def self.config
       {
-        service_name: Config.app_name,
+        service_name: "#{Config.app_name}.herokuapp.com",
         service_port: 443,
         json_api_host: Config[:zipkin_api_host],
         sample_rate: (Config[:zipkin_sample_rate] || 0.1).to_f,
@@ -36,5 +64,54 @@ module Vault
         Config[:zipkin_enabled] == 'true' &&
         Config[:zipkin_api_host]
     end
+
+    # Adds ZipkinTracer::ExconHandler to Excon's default middlewares if Excon is
+    # defined
+    #
+    # @private
+    #
+    # @return nil
+    def self.setup_excon
+      if add_to_excon_middlewares?
+        Excon.defaults[:middlewares].push(ZipkinTracer::ExconHandler)
+      end
+    end
+    private_class_method :setup_excon
+
+    # Adds our SidekiqClient and SidekiqServer middlware to Sidekiq
+    #
+    # @private
+    #
+    # @return nil
+    def self.setup_sidekiq(sidekiq = Sidekiq)
+      return unless defined?(sidekiq)
+      sidekiq.configure_client do |config|
+        config.client_middleware do |chain|
+          chain.add Vault::Tracing::SidekiqClient
+        end
+      end
+
+      sidekiq.configure_server do |config|
+        config.client_middleware do |chain|
+          chain.add Vault::Tracing::SidekiqClient
+        end
+        config.server_middleware do |chain|
+          chain.add Vault::Tracing::SidekiqServer, Vault::Tracing.config
+        end
+      end
+    end
+    private_class_method :setup_excon
+
+    # Checks to see if Excon is defined and if the Zipkin middleware has already
+    # been inserted.
+    #
+    # @private
+    #
+    # @return [true] if Excon is defined and the middleware is not already
+    # inserted
+    def self.add_to_excon_middlewares?
+      defined?(Excon) && !Excon.defaults[:middlewares].include?(ZipkinTracer::ExconHandler)
+    end
+    private_class_method :add_to_excon_middlewares?
   end
 end

data/lib/vault-tools/tracing/sidekiq_client.rb

@@ -0,0 +1,37 @@
+module Vault
+  module Tracing
+    # Tracing info for sidekiq, adding them as params
+    # This was lifted straight out of heroku/coal_car
+    class SidekiqClient
+      def trace_information(trace_id)
+        {
+          "trace_id"  => trace_id.trace_id,
+          "parent_id" => trace_id.parent_id,
+          "span_id"   => trace_id.span_id,
+          "sampled"   => trace_id.sampled,
+          "flags"     => trace_id.flags
+        }
+      end
+
+      def call(worker_class, job, _queue)
+        trace_id = ::ZipkinTracer::TraceGenerator.new.next_trace_id
+        ::ZipkinTracer::TraceContainer.with_trace_id(trace_id) do
+          job["zipkin_trace_information"] = trace_information(trace_id)
+          if trace_id.sampled?
+            ::Trace.tracer.with_new_span(trace_id, "sidekiq") do |span|
+              local_endpoint = Trace.default_endpoint
+              klass = job["wrapped".freeze] || worker_class
+              span.record_tag("job_class",
+                              klass,
+                              ::Trace::BinaryAnnotation::Type::STRING,
+                              local_endpoint)
+              yield
+            end
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vault-tools/tracing/sidekiq_server.rb

@@ -0,0 +1,54 @@
+module Vault
+  module Tracing
+    # Tracing info for sidekiq
+    # This was lifted straight out of heroku/coal_car
+    class SidekiqServer
+      def initialize(config = nil)
+        @config = ZipkinTracer::Config.new(nil, config).freeze
+        @tracer = ZipkinTracer::TracerFactory.new.tracer(@config)
+      end
+
+      def call(worker, job, _queue)
+        result = nil
+        id = trace_id(job)
+        klass = job["wrapped".freeze] || worker.class.to_s
+        ::ZipkinTracer::TraceContainer.with_trace_id(id) do
+          if id.sampled?
+            @tracer.with_new_span(id, klass) do |span|
+              span.record("sidekiq.start")
+              result = yield
+              span.record("sidekiq.end")
+            end
+          else
+            yield
+          end
+        end
+        ::Trace.tracer.flush! if ::Trace.tracer.respond_to?(:flush!)
+        result
+      end
+
+      private
+
+      def trace_id(job)
+        info = job["zipkin_trace_information"]
+        if info
+          trace_id = info["trace_id"]
+          span_id  = info["span_id"]
+          parent_span_id = info["parent_id"]
+          sampled = info["sampled"]
+          flags = info["flags"].to_i
+        else
+          trace_id = span_id = ::Trace.generate_id
+          parent_span_id = nil
+          sampled = sample?
+          flags = ::Trace::Flags::EMPTY
+        end
+        ::Trace::TraceId.new(trace_id, parent_span_id, span_id, sampled, flags)
+      end
+
+      def sample?
+        rand < @config.sample_rate
+      end
+    end
+  end
+end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.6.2'
+    VERSION = '0.6.3'
   end
 end

data/test/tracing_test.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'sidekiq'
 
 class TracingTest < Vault::TestCase
   # Anonymous Web Frontend
@@ -37,6 +38,10 @@ class TracingTest < Vault::TestCase
     set_env('ZIPKIN_ENABLED', nil)
   end
 
+  def test_service_name_gets_herokuapp
+    assert_equal 'test_app.herokuapp.com', Vault::Tracing.config[:service_name]
+  end
+
   def test_configure_enabled
     Vault::Tracing.configure
     middleware_constants = app.middleware.map(&:first)
@@ -50,6 +55,23 @@ class TracingTest < Vault::TestCase
       'Vault::Tracing.configure should return nil when not enabled'
   end
 
+  def test_excon
+    enable
+    Vault::Tracing.configure
+    assert Excon.defaults[:middlewares].include?(ZipkinTracer::ExconHandler),
+      "Vault::Tracing.setup_excon should add ZipkinTracer::ExconHandler to excon's middleware"
+  end
+
+  def test_sidekiq
+    enable
+    sidekiq_mock = Minitest::Mock.new
+    sidekiq_mock.expect :configure_server, true
+    sidekiq_mock.expect :configure_client, true
+    Vault::Tracing.setup_sidekiq(sidekiq_mock)
+    assert sidekiq_mock.verify,
+      'Vault::Tracing.setup_sidekiq should call ::configure_server, and ::configure_client on Sidekiq'
+  end
+
   def test_enabled_true
     assert Vault::Tracing.enabled?,
       'Vault::Tracing.enabled? should return true when enabled'
@@ -60,4 +82,17 @@ class TracingTest < Vault::TestCase
     refute Vault::Tracing.enabled?,
       'Vault::Tracing.enabled? should return false when not enabled'
   end
+
+  def test_trace_local_yield
+    result = Vault::Tracing.trace_local('testing', opt: 'foo') { 1 + 1 }
+    assert_equal 2, result, 'trace_local should yield the result of the block given'
+  end
+
+  def test_trace_local_calls_tracer
+    tracer_mock = Minitest::Mock.new
+    tracer_mock.expect :local_component_span, true, ['testing']
+    Vault::Tracing.trace_local('testing', tracer_mock, opt: 'foo') { 1 + 1 }
+    assert tracer_mock.verify,
+      'trace_local should call :local_component_span on the tracer'
+  end
 end

data/vault-tools.gemspec

@@ -33,5 +33,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'dotenv'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'sidekiq'
   gem.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Chris Continanza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -221,6 +221,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -273,6 +287,8 @@ files:
 - lib/vault-tools/text_processor.rb
 - lib/vault-tools/time.rb
 - lib/vault-tools/tracing.rb
+- lib/vault-tools/tracing/sidekiq_client.rb
+- lib/vault-tools/tracing/sidekiq_server.rb
 - lib/vault-tools/usage_db_tasks.rb
 - lib/vault-tools/user.rb
 - lib/vault-tools/vault_db_tasks.rb
@@ -313,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Test classes, base web classes, and helpers - oh my!