hubstep 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc17b38d966a4da5374adfab2125bc135ef15225
-  data.tar.gz: 662ab0a4133f25505b3d36c0cde44f477d5a295a
+  metadata.gz: f9f16b63e7a1bcb313327bc0ce955c9acd971b05
+  data.tar.gz: 392c2321669a3a307cd93018ca66c1690d55961d
 SHA512:
-  metadata.gz: 1ca97eae3e8cd18851412eff541da7de95105eea3de4965428a6a07062fcac5b3d72ca09a1bb9d738b22b6da5273b3dfdd824509a114f887ce79a51224f1de6a
-  data.tar.gz: 0f6ed9ff5fb3e1e738eef2875481d5b0e646d4fa531ae59daf1290664345e8a816089e46f4015591a15a56a2c2fb17363d9053ce6738559f5b8a2397596a143e
+  metadata.gz: fafcdc535bc8ff9b6ae00b462938585231ef12ba73cbe4c51ccc735d057635eda1f8ac8dd909965242e8f4bc624d5cd3562f16c22cd145764772176e9fd2abdd
+  data.tar.gz: 76fc1fbe37fae6b971cd86b6324b68ddc07f2d139a9a56097d0ae640e3ce54fad17a69656e081b7b63318d473d3895811abc88843a59407fad52059d566630f2

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_upstream.yml
+
 AllCops:
   DisplayCopNames: true
   Exclude:
@@ -13,7 +15,7 @@ Metrics/ClassLength:
     - "test/**/*"
 
 Metrics/LineLength:
-  Max: 100
+  Max: 115
 
 Metrics/MethodLength:
   Max: 15

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-05-15 19:07:22 -0400 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https

data/.rubocop_upstream.yml

@@ -0,0 +1,30 @@
+# Exclude violations in upstream code
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 16
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+Style/CaseEquality:
+  Exclude:
+    - 'lib/hubstep/transport/http_json.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/hubstep/transport/http_json.rb'

data/hubstep.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "failbot", "~> 2.0.0"
   spec.add_development_dependency "webmock", "~> 2.3.1"
   spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "mocha", "~> 1.2.1"
 end

data/lib/hubstep/faraday/middleware.rb

@@ -13,9 +13,17 @@ module HubStep
     #   b.adapter(:typhoeus)
     # end
     class Middleware < ::Faraday::Middleware
-      def initialize(app, tracer)
+      # Create a Middleware
+      #
+      # tracer    - a HubStep::Tracer instance
+      # include_urls - Boolean specifying whether the `http.url` tag should be
+      #                added to the spans this middleware creates. URLs can
+      #                contain sensitive information, so they are omitted by
+      #                default.
+      def initialize(app, tracer, include_urls: false)
         super(app)
         @tracer = tracer
+        @include_urls = include_urls
       end
 
       def call(request_env)
@@ -43,8 +51,13 @@ module HubStep
         method = request_env[:method].to_s.upcase
         span.operation_name = "Faraday #{method}"
         span.set_tag("component", "faraday")
-        span.set_tag("http.url", request_env[:url])
         span.set_tag("http.method", method)
+
+        url = request_env[:url]
+        span.set_tag("http.url", url) if @include_urls
+
+        uri = URI.parse(url.to_s)
+        span.set_tag("http.domain", uri.host)
       end
 
       def record_response(span, response_env)

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

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

data/lib/hubstep/tracer.rb

@@ -3,6 +3,7 @@
 require "English"
 require "lightstep"
 require "singleton"
+require "hubstep/transport/http_json"
 
 module HubStep
   # Tracer wraps LightStep::Tracer. It provides a block-based API for creating
@@ -11,10 +12,13 @@ module HubStep
   class Tracer
     # Create a Tracer.
     #
-    # tags      - Hash of tags to assign to the tracer. These will be
-    #             associated with every span the tracer creates.
-    # transport - instance of a LightStep::Transport::Base subclass
-    def initialize(transport: default_transport, tags: {})
+    # tags         - Hash of tags to assign to the tracer. These will be
+    #                associated with every span the tracer creates.
+    # transport    - instance of a LightStep::Transport::Base subclass
+    # verbose      - Whether or not to emit verbose spans, default true
+    def initialize(transport: default_transport, tags: {}, verbose: true)
+      @verbose = verbose
+
       name = HubStep.server_metadata.values_at("app", "role").join("-")
 
       default_tags = {
@@ -24,6 +28,7 @@ module HubStep
       @tracer = LightStep::Tracer.new(component_name: name,
                                       transport: transport,
                                       tags: default_tags.merge(tags))
+
       @spans = []
       self.enabled = false
     end
@@ -57,6 +62,10 @@ module HubStep
       span || InertSpan.instance
     end
 
+    def should_emit?(verbose)
+      @verbose || !verbose
+    end
+
     # Record a span representing the execution of the given block
     #
     # operation_name - short human-readable String identifying the work done by the span
@@ -65,11 +74,14 @@ module HubStep
     # finish         - Boolean indicating whether to "finish" (i.e., record the
     #                  span's end time and submit it to the collector).
     #                  Defaults to true.
+    # verbose        - Boolean indicating this is a ancilary span, only
+    #                  emitted when the tracer has verbose enabled, default
+    #                  false
     #
     # Yields a LightStep::Span or InertSpan to the block. Returns the block's
     # return value.
-    def span(operation_name, start_time: nil, tags: nil, finish: true)
-      unless enabled?
+    def span(operation_name, start_time: nil, tags: nil, finish: true, verbose: false)
+      unless enabled? && should_emit?(verbose)
         return yield InertSpan.instance
       end
 
@@ -124,11 +136,11 @@ module HubStep
       access_token = ENV["LIGHTSTEP_ACCESS_TOKEN"]
 
       if host && port && encryption && access_token
-        LightStep::Transport::HTTPJSON.new(host: host,
-                                           port: port.to_i,
-                                           encryption: encryption,
-                                           verbose: verbosity,
-                                           access_token: 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
       end

data/lib/hubstep/transport/http_json.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "English"
+require "net/http"
+
+unless LightStep::VERSION == '0.10.9'
+  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.
+  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.
+    #
+    # 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
+        end
+
+        nil
+      rescue => e
+        HubStep.instrumenter.instrument('lightstep.transport.error', error: e)
+      end
+    end
+  end
+end

data/lib/hubstep/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module HubStep
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/lib/hubstep.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "hubstep/tracer"
+require "hubstep/internal/instrumenter/noop"
 require "hubstep/version"
 
 require "socket"
@@ -26,4 +27,23 @@ 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.2
+  version: 2.0.3
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lightstep
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: Makes it easy to trace Sinatra and Ruby apps that use GitHub conventions.
 email:
 - engineering@github.com
@@ -173,6 +187,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".rubocop_upstream.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -186,8 +202,11 @@ 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
 - lib/hubstep/version.rb
 - script/bootstrap
 - script/console