rack-honeycomb 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef7c4729ce175288104850f4fe2202cf8cb51efa5b65b6e2cb4083df152c9368
-  data.tar.gz: 53be46494b255ff4bc3fed40ef1d6e7a2bd529238dcca359098d06671c16a759
+  metadata.gz: d71737f6f10436e9df8ccf2589fa626b720baf0eca15dd764496daa6028d3be1
+  data.tar.gz: 132781010ca1cf718553c968961bf10f3ec683b891b53fb800c5539148d357c7
 SHA512:
-  metadata.gz: f710981f56110b49ebec88e178255c63d330bdedb2a97a7133eacc5cebd6912259b9318828f277017d51254dee23362acbbde803b70b1645524ede3d3bad7c79
-  data.tar.gz: 7041b6dbec9a01c3a0e18c0885fd7d4c1b85238768af9c6c088d1be436d986b00af0b9716ed00a008450c47a35fbeff091e9c0cf712bcf9df25aa7dcfc55d09f
+  metadata.gz: e698f60be56541bd891ad9b2e00c897553fd2851127524e9726394ca28d1af80c6929cb01a6ba40286e8fc326d5df21009ace359f7ee718139e42368630738db
+  data.tar.gz: 7aa9fd274977bd1dc31985eb66f37f28ac433aa6d3632f192b8640f897203c3ea80b260a217f6bd562b85cb80eaa830fc54450cdfb36a895fae8b4debca147b9

data/.gitignore

@@ -42,7 +42,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
+Gemfile*.lock
 .ruby-version
 .ruby-gemset
 
@@ -50,3 +50,4 @@ Gemfile.lock
 .rvmrc
 
 *~
+log

data/.travis.yml

@@ -3,6 +3,11 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
+gemfile:
+  - Gemfile
+  - Gemfile.rails3.rb
+  - Gemfile.rails4.rb
 deploy:
   provider: rubygems
   gem: rack-honeycomb

data/Gemfile.rails3.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '< 4'
+gem 'test-unit', '~> 3.0'

data/Gemfile.rails4.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '< 5'

data/README.md

@@ -13,26 +13,28 @@ Attaching the middleware is simple. Inside handlers, you also have the choice of
 require 'sinatra'
 require 'rack/honeycomb'
 
-use Rack::Honeycomb::Middleware, writekey: "<YOUR WRITEKEY HERE>", dataset: "<YOUR DATASET NAME HERE>"
+use Rack::Honeycomb::Middleware, writekey: "<YOUR WRITEKEY HERE>", dataset: "<YOUR DATASET NAME HERE>", is_sinatra: true
 
 get('/hello') do
-  Rack::Honeycomb.add_field :greeting, 'hello'
+  Rack::Honeycomb.add_field env, :greeting, 'hello'
   "Hello, world!\n"
 end
 ```
 
 ## Adding instrumentation to a Rails application
 
-For more fully-featured Rails support, see [honeycomb-rails](https://github.com/honeycombio/honeycomb-rails).
+For more fully-featured Rails support, see [beeline-ruby](https://github.com/honeycombio/beeline-ruby).
 
-If honeycomb-rails doesn't work for you, this Rack middleware should work for Rails apps too:
+[beeline-ruby](https://github.com/honeycombio/beeline-ruby) includes this gem along with active record support.
+
+If beeline-ruby doesn't work for you, you can include this middleware standalone
 
 ```ruby
 # config/application.rb
 require 'rack/honeycomb'
 
 class Application < Rails::Application
-  config.middleware.use Rack::Honeycomb::Middleware, writekey: "<YOUR WRITEKEY HERE>", dataset: "<YOUR DATASET NAME HERE>"
+  config.middleware.use Rack::Honeycomb::Middleware, writekey: "<YOUR WRITEKEY HERE>", dataset: "<YOUR DATASET NAME HERE>", is_rails: true
 end
 ```
 

data/lib/rack-honeycomb/auto_install.rb

@@ -4,33 +4,46 @@ module Rack
     module AutoInstall
       class << self
         def available?(logger: nil)
-          gem 'rack'
-          logger.debug "#{self.name}: detected rack" if logger
-          gem 'sinatra'
-          logger.debug "#{self.name}: detected sinatra, okay to autoinitialise" if logger
-          true
-        rescue Gem::LoadError => e
-          if e.name == 'sinatra'
-            logger.debug "Couldn't detect web framework, not autoinitialising rack-honeycomb" if logger
+          @logger = logger
+
+          unless has_gem? 'rack'
+            debug 'not autoinitialising rack-honeycomb'
+            return false
           end
-          false
+
+          @has_sinatra = has_gem? 'sinatra'
+          @has_rails = has_gem? 'rails'
+
+          unless @has_sinatra || @has_rails
+            debug "Couldn't detect web framework, not autoinitialising rack-honeycomb"
+            return false
+          end
+
+          true
         end
 
         def auto_install!(honeycomb_client:, logger: nil)
-          require 'rack'
-          require 'sinatra/base'
+          @logger = logger
 
+          require 'rack'
           require 'rack-honeycomb'
 
+          auto_install_sinatra!(honeycomb_client, logger) if @has_sinatra
+          auto_install_rails!(honeycomb_client, logger) if @has_rails
+        end
+
+        def auto_install_sinatra!(honeycomb_client, logger)
+          require 'sinatra/base'
+
           class << ::Sinatra::Base
             alias build_without_honeycomb build
           end
 
           ::Sinatra::Base.define_singleton_method(:build) do |*args, &block|
             if !AutoInstall.already_added
-              logger.debug "Adding Rack::Honeycomb::Middleware to #{self}" if logger
+              AutoInstall.debug "Adding Rack::Honeycomb::Middleware to #{self}"
 
-              self.use Rack::Honeycomb::Middleware, client: honeycomb_client, logger: logger
+              self.use Rack::Honeycomb::Middleware, client: honeycomb_client, logger: logger, is_sinatra: true
               AutoInstall.already_added = true
             else
               # In the case of nested Sinatra apps - apps composed of other apps
@@ -40,7 +53,7 @@ module Rack
               # middleware reliably - so instead, we just want to warn the user
               # and avoid doing anything silly.
               unless AutoInstall.already_warned
-                logger.warn "Honeycomb auto-instrumentation of Sinatra will probably not work, try manual installation" if logger
+                AutoInstall.warn 'Honeycomb auto-instrumentation of Sinatra will probably not work, try manual installation'
                 AutoInstall.already_warned = true
               end
             end
@@ -54,8 +67,35 @@ module Rack
           end)
         end
 
+        def auto_install_rails!(honeycomb_client, logger)
+          require 'rack-honeycomb/railtie'
+          ::Rack::Honeycomb::Railtie.init(
+            honeycomb_client: honeycomb_client,
+            logger: logger,
+          )
+          debug 'Loaded Railtie'
+        end
+
         attr_accessor :already_added
         attr_accessor :already_warned
+
+        def debug(msg)
+          @logger.debug "#{self.name}: #{msg}" if @logger
+        end
+
+        def warn(msg)
+          @logger.warn "#{self.name}: #{msg}" if @logger
+        end
+
+        private
+        def has_gem?(gem_name)
+          gem gem_name
+          debug "detected #{gem_name}"
+          true
+        rescue Gem::LoadError => e
+          debug "#{gem_name} not detected (#{e.class}: #{e.message})"
+          false
+        end
       end
     end
   end

data/lib/rack-honeycomb/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails'
+
+module Rack
+  module Honeycomb
+    class Railtie < ::Rails::Railtie
+      class << self
+        attr_reader :honeycomb_client, :logger
+
+        def init(honeycomb_client:, logger: nil)
+          @honeycomb_client = honeycomb_client
+          @logger = logger
+
+          logger.debug "#{self}: initialized with #{honeycomb_client.class}" if logger
+        end
+      end
+
+      initializer 'honeycomb.add_rack_middleware' do |app|
+        app.middleware.use ::Rack::Honeycomb::Middleware,
+          client: Railtie.honeycomb_client,
+          logger: Railtie.logger,
+          is_rails: true
+        Railtie.logger.debug "#{Railtie}: Added rack-honeycomb middleware to #{app.class}" if Railtie.logger
+      end
+    end
+  end
+end

data/lib/rack/honeycomb/middleware.rb

@@ -20,18 +20,38 @@ module Rack
       USER_AGENT_SUFFIX = "rack-honeycomb/#{VERSION}"
       EVENT_TYPE = 'http_server'.freeze
 
+      RAILS_SPECIAL_PARAMS = %w(controller action).freeze
+
       ##
       # @param  [#call]                       app
       # @param  [Hash{Symbol => Object}]      options
       # @option options [String]  :writekey   (nil)
       # @option options [String]  :dataset    (nil)
       # @option options [String]  :api_host   (nil)
+      # @option options [Boolean] :is_sinatra (false)
+      # @option options [Boolean] :is_rails   (false)
       def initialize(app, options = {})
         @app, @options = app, options
 
         @logger = options.delete(:logger)
         @logger ||= ::Honeycomb.logger if defined?(::Honeycomb.logger)
 
+        @is_sinatra = options.delete(:is_sinatra)
+        debug 'Enabling Sinatra-specific fields' if @is_sinatra
+        @is_rails = options.delete(:is_rails)
+        debug 'Enabling Rails-specific fields' if @is_rails
+
+        # report meta.package = rack only if we have no better information
+        package = 'rack'
+        package_version = RACK_VERSION
+        if @is_rails
+          package = 'rails'
+          package_version = ::Rails::VERSION::STRING
+        elsif @is_sinatra
+          package = 'sinatra'
+          package_version = ::Sinatra::VERSION
+        end
+
         honeycomb = if client = options.delete(:client)
                        debug "initialized with #{client.class.name} via :client option"
                        client
@@ -44,13 +64,11 @@ module Rack
                      end
         @builder = honeycomb.builder.
           add(
-            'meta.package' => 'rack',
-            'meta.package_version' => RACK_VERSION,
+            'meta.package' => package,
+            'meta.package_version' => package_version,
             'type' => EVENT_TYPE,
             'meta.local_hostname' => Socket.gethostname,
           )
-
-        @service_name = options.delete(:service_name) || :rack
       end
 
       def call(env)
@@ -63,8 +81,6 @@ module Rack
           @app.call(env)
         end
 
-        add_app_fields(ev, env)
-
         add_response_fields(ev, status, headers, body)
 
         [status, headers, body]
@@ -79,6 +95,11 @@ module Rack
           finish = Time.now
           ev.add_field('duration_ms', (finish - start) * 1000)
 
+          add_sinatra_fields(ev, env) if @is_sinatra
+          add_rails_fields(ev, env) if @is_rails
+
+          add_app_fields(ev, env)
+
           ev.send
         end
       end
@@ -90,6 +111,8 @@ module Rack
 
       def add_request_fields(event, env)
         event.add_field('name', "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}")
+        # N.B. 'name' may be overwritten later by add_sinatra_fields or
+        # add_rails_fields
 
         event.add_field('request.method', env['REQUEST_METHOD'])
         event.add_field('request.path', env['PATH_INFO'])
@@ -105,6 +128,59 @@ module Rack
         event.add_field('request.header.user_agent', env['HTTP_USER_AGENT'])
       end
 
+      def add_sinatra_fields(event, env)
+        route = env['sinatra.route']
+        event.add_field('request.route', route)
+        # overwrite 'name' (previously set in add_request_fields)
+        event.add_field('name', route)
+      end
+
+      def add_rails_fields(event, env)
+        rails_params = env['action_dispatch.request.parameters']
+        unless rails_params.kind_of? Hash
+          debug "Got unexpected type #{rails_params.class} for env['action_dispatch.request.parameters']"
+          return
+        end
+
+        rails_params.each do |param, value|
+          if RAILS_SPECIAL_PARAMS.include?(param)
+            event.add_field("request.#{param}", value)
+          else
+            event.add_field("request.params.#{param}", value)
+          end
+        end
+
+        # overwrite 'name' (previously set in add_request_fields)
+        event.add_field('name', "#{rails_params[:controller]}##{rails_params[:action]}")
+
+        event.add_field('request.route', extract_rails_route(env))
+      end
+
+      def extract_rails_route(env)
+        # egregious and probably slow hack to get the formatted route
+        # TODO there must be a better way
+        routes = env['action_dispatch.routes']
+        request = ::ActionDispatch::Request.new(env)
+
+        formatted_route = nil
+
+        routes.router.recognize(request) do |route, _|
+          # make a hash where each param ("part") in the route is given its
+          # own name as a value, e.g. {:id => ":id"}
+          symbolic_params = {}
+          route.required_parts.each do |part|
+            symbolic_params[part] = ":#{part}"
+          end
+          # then ask the route to format itself using those param "values"
+          formatted_route = route.format(symbolic_params)
+        end
+
+        "#{env['REQUEST_METHOD']} #{formatted_route}"
+      rescue StandardError => e
+        debug "couldn't extract named route for request: #{e.class}: #{e}"
+        nil
+      end
+
       def add_app_fields(event, env)
         # Pull arbitrary metadata off `env` if the caller attached
         # anything inside the Rack handler.

data/lib/rack/honeycomb/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Honeycomb
-    VERSION="0.2.2"
+    VERSION="0.3.0"
   end
 end

data/rack-honeycomb.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency     'libhoney',  '>= 1.5.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rails'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'pry-byebug'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-honeycomb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -161,11 +175,14 @@ files:
 - ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
+- Gemfile.rails3.rb
+- Gemfile.rails4.rb
 - LICENSE
 - README.md
 - Rakefile
 - lib/rack-honeycomb.rb
 - lib/rack-honeycomb/auto_install.rb
+- lib/rack-honeycomb/railtie.rb
 - lib/rack/honeycomb.rb
 - lib/rack/honeycomb/middleware.rb
 - lib/rack/honeycomb/version.rb