rack-honeycomb 0.0.18 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8462b0a0923efce44eddd081ebe87f528cbd23cc1bd9086a5401183adbc9ee1
-  data.tar.gz: f35eeb477ade70d60e1e059429041fdbb33ff43b026d8f12b9f997159b096d97
+  metadata.gz: e14df43e7812c1c6c4943e872d9fc71f653336d46ba04d97e15dcad5c8ef1b55
+  data.tar.gz: 58e4a3cb98d1e9ecdcbf4f4175693d0783c175810e317b9dc80f10952abee9d0
 SHA512:
-  metadata.gz: 291f4e3801f073249d29d2076f3eeb45a4bfc73aadf8ccddd3dce290055f032228e6ed490a9b47caf82f25ad234c2ae5dbb986d7f63b2a2cee64eadae3e2e333
-  data.tar.gz: da0269e7f6577d88e86562c445161b0e88ad47b9d018ea4944e1b5c9b17334cbbb1c743d9c6d588945c9ed88bb7f599c0732ac021b875f853479881ebe21be6c
+  metadata.gz: 68d18614019d1d0d16a95c8bd09b0a0f137ae7c838ebd2a0377d9c2d4a455a9f330eba458521ebd4fba836b328c89fd5b1aca79c8fcc7fc988a660873fe08ec3
+  data.tar.gz: 8fd87ec1879faf03a28e85ece8a27a58de2a8d777f8d1df45ca9c7126c9b962a613cd3f42e8f1082d342a01f217e3df80c6c8a00b491cd499e8651f5ac299a7f

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bump/tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+YARD::Rake::YardocTask.new(:doc)
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rack/honeycomb/middleware.rb

@@ -1,19 +1,24 @@
 require "libhoney"
 
+require 'rack'
 require "rack/honeycomb/version"
 
 module Rack
   module Honeycomb
-    # Prefix for attaching arbitrary metadata to the `env`. Will be deleted from
+    # Prefix for attaching custom fields to the `env`. Will be deleted from
     # the `env` once it's pulled off of the `env` and onto a Honeycomb event.
     ENV_PREFIX = "honeycomb."
 
+    # Custom fields added via the `env` will be added to the Honeycomb
+    # event under this namespace prefix
+    APP_FIELD_NAMESPACE = 'app'.freeze
+
+    RACK_VERSION = ::Rack::VERSION.join('.').freeze
+
     class Middleware
       ENV_REGEX = /^#{ Regexp.escape ENV_PREFIX }/
       USER_AGENT_SUFFIX = "rack-honeycomb/#{VERSION}"
-
-      attr_reader :app
-      attr_reader :options
+      EVENT_TYPE = 'http_request'.freeze
 
       ##
       # @param  [#call]                       app
@@ -24,88 +29,88 @@ module Rack
       def initialize(app, options = {})
         @app, @options = app, options
 
-        @honeycomb = if client = options.delete(:client)
+        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
+        @builder = honeycomb.builder.
+          add(
+            'meta.package' => 'rack',
+            'meta.package_version' => RACK_VERSION,
+            'type' => EVENT_TYPE,
+            'local_hostname' => Socket.gethostname,
+          )
 
         @service_name = options.delete(:service_name) || :rack
       end
 
-      def add_field(ev, field, value)
-        ev.add_field(field, value) if value != nil && value != ''
-      end
+      def call(env)
+        ev = @builder.event
 
-      def add_env(ev, env, field)
-        add_field(ev, field, env[field])
-      end
+        add_request_fields(ev, env)
 
-      def call(env)
-        ev = @honeycomb.event
-        request_started_at = Time.now
-        status, headers, response = adding_span_metadata_if_available(ev, env) do
+        start = Time.now
+        status, headers, body = adding_span_metadata_if_available(ev, env) do
           @app.call(env)
         end
-        request_ended_at = Time.now
 
-        ev.add(headers)
-        if headers['Content-Length'] != nil
-          # Content-Length (if present) is a string.  let's change it to an int.
-          ev.add_field('Content-Length', headers['Content-Length'].to_i)
-        end
-        add_field(ev, 'HTTP_STATUS', status)
-        add_field(ev, 'durationMs', (request_ended_at - request_started_at) * 1000)
+        add_app_fields(ev, env)
 
-        # Pull arbitrary metadata off `env` if the caller attached anything
-        # inside the Rack handler.
-        env.each_pair do |k, v|
-          if k.is_a?(String) && k.match(ENV_REGEX)
-            add_field(ev, k.sub(ENV_REGEX, ''), v)
-            env.delete(k)
-          end
-        end
+        add_response_fields(ev, status, headers, body)
 
-        # we can't use `ev.add(env)` because json serialization fails.
-        # pull out some interesting and potentially useful fields.
-        add_env(ev, env, 'rack.version')
-        add_env(ev, env, 'rack.multithread')
-        add_env(ev, env, 'rack.multiprocess')
-        add_env(ev, env, 'rack.run_once')
-        add_env(ev, env, 'SCRIPT_NAME')
-        add_env(ev, env, 'QUERY_STRING')
-        add_env(ev, env, 'SERVER_PROTOCOL')
-        add_env(ev, env, 'SERVER_SOFTWARE')
-        add_env(ev, env, 'GATEWAY_INTERFACE')
-        add_env(ev, env, 'REQUEST_METHOD')
-        add_env(ev, env, 'REQUEST_PATH')
-        add_env(ev, env, 'REQUEST_URI')
-        add_env(ev, env, 'HTTP_VERSION')
-        add_env(ev, env, 'HTTP_HOST')
-        add_env(ev, env, 'HTTP_CONNECTION')
-        add_env(ev, env, 'HTTP_CACHE_CONTROL')
-        add_env(ev, env, 'HTTP_UPGRADE_INSECURE_REQUESTS')
-        add_env(ev, env, 'HTTP_USER_AGENT')
-        add_env(ev, env, 'HTTP_ACCEPT')
-        add_env(ev, env, 'HTTP_ACCEPT_LANGUAGE')
-        add_env(ev, env, 'REMOTE_ADDR')
-
-        [status, headers, response]
+        [status, headers, body]
       rescue Exception => e
         if ev
-          ev.add_field('exception_class', e.class.name)
-          ev.add_field('exception_message', e.message)
+          ev.add_field('request.error', e.class.name)
+          ev.add_field('request.error_detail', e.message)
         end
         raise
       ensure
-        if ev
+        if ev && start
+          finish = Time.now
+          ev.add_field('duration_ms', (finish - start) * 1000)
+
           ev.send
         end
       end
 
       private
+      def add_request_fields(event, env)
+        event.add_field('name', "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}")
+
+        event.add_field('request.method', env['REQUEST_METHOD'])
+        event.add_field('request.path', env['PATH_INFO'])
+        event.add_field('request.protocol', env['rack.url_scheme'])
+
+        if env['QUERY_STRING'] && !env['QUERY_STRING'].empty?
+          event.add_field('request.query_string', env['QUERY_STRING'])
+        end
+
+        event.add_field('request.http_version', env['HTTP_VERSION'])
+        event.add_field('request.host', env['HTTP_HOST'])
+        event.add_field('request.remote_addr', env['REMOTE_ADDR'])
+        event.add_field('request.header.user_agent', env['HTTP_USER_AGENT'])
+      end
+
+      def add_app_fields(event, env)
+        # Pull arbitrary metadata off `env` if the caller attached
+        # anything inside the Rack handler.
+        env.each_pair do |k, v|
+          if k.is_a?(String) && k.match(ENV_REGEX)
+            namespaced_k = "#{APP_FIELD_NAMESPACE}.#{k.sub(ENV_REGEX, '')}"
+            event.add_field(namespaced_k, v)
+            env.delete(k)
+          end
+        end
+      end
+
+      def add_response_fields(event, status, headers, body)
+        event.add_field('response.status_code', status)
+      end
+
       def adding_span_metadata_if_available(event, env)
         return yield unless defined?(::Honeycomb.with_trace_id)
 

data/lib/rack/honeycomb/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Honeycomb
-    VERSION="0.0.18"
+    VERSION="0.1.0"
   end
 end

data/rack-honeycomb.gemspec

@@ -31,11 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bump"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "webmock", "~> 2.1"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "yardstick", "~> 0.9"
   spec.add_development_dependency 'rack', '>= 1.0.0'
   spec.add_runtime_dependency     'libhoney',  '>= 1.5.0'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-honeycomb
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.1.0
 platform: ruby
 authors:
 - The Honeycomb.io Team
@@ -53,75 +53,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: yardstick
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: libhoney
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
+        version: 1.5.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: libhoney
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -157,11 +129,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - lib/rack-honeycomb.rb
 - lib/rack-honeycomb/auto_install.rb
 - lib/rack/honeycomb.rb