hubstep 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 800bdbd0987e5e9cadf9ece37153d38fc4d01b2e
-  data.tar.gz: 306d8888b256a21c05f3ef4afedbbd83f06f1946
+  metadata.gz: 6daeef652b6059de7c8414e25607406ac11cc1d9
+  data.tar.gz: 90cbcab84a1aa56013c5830a9bb2759b8983af9c
 SHA512:
-  metadata.gz: 5476d3dc052e07fe3b77744faea0acdbc7abc3f55172a7f64ffdff0ba069f08bcc88ce1536258f05cd69955c7d5935a7efe5414a587f16098e323fbb6f346a32
-  data.tar.gz: c855f62403d5521ebe2321bb28788ae73603cf76cb316158e19f09fa4f39c5fafa328b5515f535deb8d5fa9e21244b000e121b2442b543e446948f17c197462b
+  metadata.gz: b4e9b64109349da07a79569580694a032746e4bc5ecc9a5f3d33f45b14409932e5b9b33385345e2131571d77d875df948561a8190abba22a7b8df3d5a6872233
+  data.tar.gz: cbc706f4afa3a8b2dfded9b02723bc0a769e5fc5f8aeb91467baadb52965b96202f45c2a27a6ab09ab30006ef5cb2f53ba12c63526df3041a6721df9903fafcc

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
   Exclude:
     - "bin/**/*"
     - "vendor/**/*"
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "test/**/*"
 
 Metrics/BlockLength:
   Exclude:
@@ -19,9 +22,13 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   Max: 15
+  Exclude:
+    - "test/**/*"
 
 Metrics/AbcSize:
   Max: 17
+  Exclude:
+    - "test/**/*"
 
 Style/DoubleNegation:
   Enabled: false

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in hubstep.gemspec

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/hubstep.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
 # frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "hubstep/version"
@@ -28,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rubocop", "~> 0.46.0"
+  spec.add_development_dependency "rubocop", "~> 0.49.0"
   spec.add_development_dependency "rack-test", "~> 0.6"
   spec.add_development_dependency "activesupport", "~> 4.0"
   spec.add_development_dependency "faraday", "~> 0.10"

data/lib/hubstep/faraday/middleware.rb

@@ -78,8 +78,7 @@ module HubStep
         begin
           uri = self.class.uri_parser.parse(url.to_s)
           domain = uri.host
-        rescue => e
-          HubStep.instrumenter.instrument("hubstep.faraday.middleware.error", error: e)
+        rescue
           domain = nil
         end
 

data/lib/hubstep/tracer.rb

@@ -132,14 +132,12 @@ module HubStep
       host = ENV["LIGHTSTEP_COLLECTOR_HOST"]
       port = ENV["LIGHTSTEP_COLLECTOR_PORT"]
       encryption = ENV["LIGHTSTEP_COLLECTOR_ENCRYPTION"]
-      verbosity = Integer(ENV.fetch("LIGHTSTEP_TRANSPORT_VERBOSITY", 0))
       access_token = ENV["LIGHTSTEP_ACCESS_TOKEN"]
 
       if host && port && encryption && access_token
         HubStep::Transport::HTTPJSON.new(host: host,
                                          port: port.to_i,
                                          encryption: encryption,
-                                         verbose: verbosity,
                                          access_token: access_token)
       else
         LightStep::Transport::Nil.new

data/lib/hubstep/transport/http_json.rb

@@ -5,47 +5,83 @@ require "net/http"
 
 unless LightStep::VERSION == '0.11.2'
   raise <<-MSG
-    This monkey patch needs to be reviewed for LightStep versions other than 0.10.9.
-    To review, diff the changes between the `LightStep::Transport::HTTPJSON#report`
-    method and the `HubStep::Transport::HTTPJSON#report` method below and port any
-    changes that seem necessary.
+    This custom transport needs to be reviewed for new LightStep versions.
+    To review, compare this implementation with `LightStep::Transport::HTTPJSON#report`
+    method and port any changes that seem necessary.
   MSG
 end
 
 module HubStep
   module Transport
-    # HTTPJSON is a transport that sends reports via HTTP in JSON format.
-    # It is thread-safe, however it is *not* fork-safe. When forking, all items
-    # in the queue will be copied and sent in duplicate.
+    # HTTPJSON is our customized transport which add some additional
+    # instrumentation and performance improvements.
     #
-    # When forking, you should first `disable` the tracer, then `enable` it from
-    # within the fork (and in the parent post-fork). See
-    # `examples/fork_children/main.rb` for an example.
-    class HTTPJSON < LightStep::Transport::HTTPJSON
-      # Queue a report for sending
-      def report(report) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        p report if @verbose >= 3
-
-        HubStep.instrumenter.instrument('lightstep.transport.report', {}) do |payload|
-          https = Net::HTTP.new(@host, @port)
-          https.use_ssl = @encryption == ENCRYPTION_TLS
-          req = Net::HTTP::Post.new('/api/v0/reports')
-          req['LightStep-Access-Token'] = @access_token
-          req['Content-Type'] = 'application/json'
-          req['Connection'] = 'keep-alive'
-          req.body = report.to_json
-          res = https.request(req)
-
-          payload[:request_body] = req.body
-
-          puts res.to_s, res.body if @verbose >= 3
-
-          payload[:response] = res
+    # Callback Notes: To provide some observability into this transport's
+    # operation, we allow a callback `on_report_callback` to be provided. This
+    # callback will be called with the signature (report, result, duration_ms)
+    # where result can be either the http response or an exception. This
+    # callback will be delivered while maintaining this transports mutex which
+    # should provide some measure of thread-safety for the caller.
+    class HTTPJSON < LightStep::Transport::Base
+      ENCRYPTION_TLS = 'tls'
+      ENCRYPTION_NONE = 'none'
+
+      # Initialize the transport
+      # @param host [String] host of the domain to the endpoind to push data
+      # @param port [Numeric] port on which to connect
+      # @param encryption [ENCRYPTION_TLS, ENCRYPTION_NONE] kind of encryption to use
+      # @param access_token [String] access token for LightStep server
+      # @param on_report_callback [method] Called after reporting has completed
+      # @return [HTTPJSON]
+      def initialize(host:, port:, encryption: ENCRYPTION_TLS, access_token:, on_report_callback: nil)
+        @on_report_callback = on_report_callback
+
+        raise Tracer::ConfigurationError, "host must be specified" if host.nil? || host.empty?
+        raise Tracer::ConfigurationError, "port must be specified" if port.nil?
+        raise Tracer::ConfigurationError, "access_token must be a string" unless String === access_token
+        raise Tracer::ConfigurationError, "access_token cannot be blank"  if access_token.empty?
+
+        @access_token = access_token
+
+        # This mutex protects the use of our Net::HTTP instance which we
+        # maintain as a long lived connection. While a Lightstep::Transport is
+        # typically called only from within the reporting thread, there are
+        # some situations where this can be bypassed (directly calling `flush`
+        # for example)
+        @mutex = Mutex.new
+
+        @https = Net::HTTP.new(host, port)
+        @https.use_ssl = encryption == ENCRYPTION_TLS
+      end
+
+      def report(report)
+        start = Time.now
+
+        req = request report
+
+        @mutex.synchronize do
+          begin
+            res = @https.request(req)
+          rescue => e
+            res = e
+          ensure
+            @on_report_callback&.call(report, res, start)
+          end
         end
 
         nil
-      rescue => e
-        HubStep.instrumenter.instrument('lightstep.transport.error', error: e)
+      end
+
+      private
+
+      def request(report)
+        req = Net::HTTP::Post.new('/api/v0/reports')
+        req['LightStep-Access-Token'] = @access_token
+        req['Content-Type'] = 'application/json'
+        req['Connection'] = 'keep-alive'
+
+        req.body = report.to_json
+        req
       end
     end
   end

data/lib/hubstep/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module HubStep
-  VERSION = "2.0.5"
+  VERSION = "2.1.0"
 end

data/lib/hubstep.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "hubstep/tracer"
-require "hubstep/internal/instrumenter/noop"
 require "hubstep/version"
 
 require "socket"
@@ -27,23 +26,4 @@ module HubStep
         {}.freeze
       end
   end
-
-  # setter for instrumenter that defaults to the Noop instrumenter
-  #
-  # instrumenter - an object that responds to the ActiveSupport::Notifications
-  #                interface, when omitted the Noop instrumenter will be used
-  #
-  def self.instrumenter=(instrumenter)
-    @instrumenter = instrumenter
-  end
-
-  # getter for the instrumenter ivar. When the ivar isn't set it will
-  # default to the Noop instrumenter
-  #
-  # instrumenter - an object that responds to the ActiveSupport::Notifications
-  #                interface, when omitted the Noop instrumenter will be used
-  #
-  def self.instrumenter(instrumenter: nil)
-    @instrumenter ||= (instrumenter || HubStep::Internal::Instrumenter::Noop.new)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubstep
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lightstep
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.49.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -202,8 +202,6 @@ files:
 - lib/hubstep/failbot.rb
 - lib/hubstep/faraday/middleware.rb
 - lib/hubstep/instrumenter.rb
-- lib/hubstep/internal/instrumenter/memory.rb
-- lib/hubstep/internal/instrumenter/noop.rb
 - lib/hubstep/rack/middleware.rb
 - lib/hubstep/tracer.rb
 - lib/hubstep/transport/http_json.rb

data/lib/hubstep/internal/instrumenter/memory.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module HubStep
-  module Internal
-    module Instrumenter
-      # A memory instrumenter to be used in to test instrumentation. This class records
-      # each instrument call in a HubStep::Internal::Instrumenter::Memory::Event instance
-      # and stores the instance in an events array.
-      class Memory
-        class Event # rubocop:disable Style/Documentation
-          attr_reader :name, :payload, :result
-
-          def initialize(name, payload, result)
-            @name = name
-            @payload = payload
-            @result = result
-          end
-        end
-
-        def initialize
-          @events = []
-        end
-
-        attr_reader :events
-
-        def instrument(name, payload = {})
-          payload = payload.dup
-          result = (yield payload if block_given?)
-          @events << Event.new(name, payload, result)
-          result
-        end
-      end
-    end
-  end
-end

data/lib/hubstep/internal/instrumenter/noop.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module HubStep
-  module Internal
-    module Instrumenter
-      # A noop instrumenter that fulfills the interface for ActiveSupport::Notifications
-      # but does nothing. This is the default instrumenter when the client does not pass
-      # one in
-      class Noop
-        def instrument(_name, payload = {})
-          yield payload if block_given?
-        end
-      end
-    end
-  end
-end