rack-honeycomb 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd607cec0d5aee31890fe76f0a053315e767f6f2be87ebe0dab906194372649e
-  data.tar.gz: 455582fb49afd1fd9d191a00689a29080a98d859ee138e3341997ff2b4554019
+  metadata.gz: 46fc6f3a8fbb4c2bb926c92bcd101313e3ec79795735664c851e230e55579bea
+  data.tar.gz: ed408d7ce0baf8aa98eeff6ae6461527692199a1c7685739acf794e36f42d122
 SHA512:
-  metadata.gz: 24a61539ccbd7908a35f6335b66893451044aa4a7b34f642d792cfc721b506a7489cd8c7fdc18435bacfca37ddc54bce09c9789bf9014be64d6788e0b3a6ea95
-  data.tar.gz: ed0535c26cc1734cc49464b24fa374ca10845f0c6b2acb696260d4b24d989a4db3cecc28fc14b421afa5c8c3351a38c2e145fd254ea574f9d149cded31e2e664
+  metadata.gz: aa105613b9fcd20e15bee4e52c17e1917bce0cd5220cc95c4966f3db51b1b86529296d6647209c4be5f9a8f92148c5f386e5003119b3f2507558cc771a3c4dbb
+  data.tar.gz: ed4bc78029b0e442ea125284791ed92e806deaa1018630481a341aa0fc359a64dd486824c1f8904261a03abca89ec64d75948e427a462efac899dac7cdb2d548

data/lib/rack-honeycomb.rb

@@ -0,0 +1,7 @@
+begin
+  gem 'rack'
+
+  require 'rack/honeycomb'
+rescue Gem::LoadError
+  warn 'Rack not detected, not enabling rack-honeycomb'
+end

data/lib/rack-honeycomb/auto_install.rb

@@ -0,0 +1,53 @@
+module Rack
+  module Honeycomb
+    # @api private
+    module AutoInstall
+      class << self
+        def available?(logger: nil)
+          gem 'rack'
+          gem 'sinatra'
+          true
+        rescue Gem::LoadError => e
+          if e.name == 'sinatra'
+            logger.debug "Couldn't detect web framework, not autoinitialising rack-honeycomb" if logger
+          end
+          false
+        end
+
+        def auto_install!(honeycomb_client:, logger: nil)
+          require 'rack'
+          require 'sinatra/base'
+
+          require 'rack-honeycomb'
+
+          class << ::Sinatra::Base
+            alias build_without_honeycomb build
+          end
+
+          ::Sinatra::Base.define_singleton_method(:build) do |*args, &block|
+            if !AutoInstall.already_added
+              self.use Rack::Honeycomb::Middleware, client: honeycomb_client
+              AutoInstall.already_added = true
+            else
+              # In the case of nested Sinatra apps - apps composed of other apps
+              # (in addition to just handlers and middleware) - our .build hook
+              # above will fire multiple times, for the parent app and also for
+              # each child app. In that case, it's hard to hook in our
+              # middleware reliably - so instead, we just want to warn the user
+              # and avoid doing anything silly.
+
+              unless AutoInstall.already_warned
+                warn "Honeycomb auto-instrumentation of Sinatra will probably not work, try manual installation"
+                AutoInstall.already_warned = true
+              end
+            end
+            build_without_honeycomb(*args, &block)
+          end
+        end
+
+        attr_accessor :already_added
+        attr_accessor :already_warned
+      end
+    end
+  end
+end

data/lib/rack/honeycomb/middleware.rb

@@ -1,4 +1,5 @@
 require "libhoney"
+
 require "rack/honeycomb/version"
 
 module Rack
@@ -23,7 +24,15 @@ module Rack
       def initialize(app, options = {})
         @app, @options = app, options
 
-        @honeycomb = Libhoney::Client.new(options.merge(user_agent_addition: USER_AGENT_SUFFIX))
+        @honeycomb = if client = options.delete(:client)
+                       client
+                     elsif defined?(::Honeycomb.client)
+                       ::Honeycomb.client
+                     else
+                       Libhoney::Client.new(options.merge(user_agent_addition: USER_AGENT_SUFFIX))
+                     end
+
+        @service_name = options.delete(:service_name) || :rack
       end
 
       def add_field(ev, field, value)
@@ -37,7 +46,9 @@ module Rack
       def call(env)
         ev = @honeycomb.event
         request_started_at = Time.now
-        status, headers, response = @app.call(env)
+        status, headers, response = adding_span_metadata_if_available(ev, env) do
+          @app.call(env)
+        end
         request_ended_at = Time.now
 
         ev.add(headers)
@@ -46,7 +57,7 @@ module Rack
           ev.add_field('Content-Length', headers['Content-Length'].to_i)
         end
         add_field(ev, 'HTTP_STATUS', status)
-        add_field(ev, 'REQUEST_TIME_MS', (request_ended_at - request_started_at) * 1000)
+        add_field(ev, 'durationMs', (request_ended_at - request_started_at) * 1000)
 
         # Pull arbitrary metadata off `env` if the caller attached anything
         # inside the Rack handler.
@@ -80,9 +91,34 @@ module Rack
         add_env(ev, env, 'HTTP_ACCEPT')
         add_env(ev, env, 'HTTP_ACCEPT_LANGUAGE')
         add_env(ev, env, 'REMOTE_ADDR')
-        ev.send
 
         [status, headers, response]
+      rescue Exception => e
+        if ev
+          ev.add_field('exception_class', e.class.name)
+          ev.add_field('exception_message', e.message)
+        end
+        raise
+      ensure
+        if ev
+          ev.send
+        end
+      end
+
+      private
+      def adding_span_metadata_if_available(event, env)
+        return yield unless defined?(::Honeycomb.with_trace_id)
+
+        ::Honeycomb.with_trace_id do |trace_id|
+          event.add_field :traceId, trace_id
+          event.add_field :serviceName, @service_name
+          event.add_field :name, "#{env['REQUEST_METHOD']} #{env['REQUEST_PATH']}"
+          span_id = trace_id # so this shows up as a root span
+          event.add_field :id, span_id
+          ::Honeycomb.with_span_id(span_id) do
+            yield
+          end
+        end
       end
     end
   end

data/lib/rack/honeycomb/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Honeycomb
-    VERSION="0.0.16"
+    VERSION="0.0.17"
   end
 end

data/rack-honeycomb.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 2.1"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "yardstick", "~> 0.9"
-  spec.add_runtime_dependency     'rack',      '>= 1.0.0'
+  spec.add_development_dependency 'rack', '>= 1.0.0'
   spec.add_runtime_dependency     'libhoney',  '>= 1.5.0'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'yard'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-honeycomb
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - The Honeycomb.io Team
@@ -101,7 +101,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -162,6 +162,8 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- lib/rack-honeycomb.rb
+- lib/rack-honeycomb/auto_install.rb
 - lib/rack/honeycomb.rb
 - lib/rack/honeycomb/middleware.rb
 - lib/rack/honeycomb/version.rb