honeycomb-beeline 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd03586fceabfcdb1d51f914e4a61cae2c87bbe295341036969a9fca40b3484
-  data.tar.gz: cc72f4183017b81d07ee227a4a5aa48c7e933b24f551b61328575fe5d3cb880b
+  metadata.gz: d2f8be462c8910f16abb2dadf83da771cbfcb11dd2cf6525455bdd23af17dfd0
+  data.tar.gz: 84bfc86f929938d8d079c7d615357ef1ca08e8dfe9be2d266c4cb57b2a9b1fec
 SHA512:
-  metadata.gz: 93c1a6e138fb39c9a83591c3c10b7427ff28b4f397c2844f631e22d241976e4d3d4f26bb63bdf2380fb35bfe2ae016ff3e659611808608ffeba36c7e10dd6f6c
-  data.tar.gz: ba29c324e453cb42180134008cd8586dba0c1b34ad71a3efc2b4a9165ad380a116d2fd533a9c06cdd7ea2e2fc033a9cf09b9d98f8e68a6ebd242631dba1c4c61
+  metadata.gz: 0aadcfaec026873e03f75012e0303c927a102dd4de060e04f4132c329a6e2e86312614e8e18486e9f4bafbb4c6acc1790b495f1c9bbd557361b02905df4ea48f
+  data.tar.gz: 6dcefe527d6b7d529c312a19d3e2c6f387e5cdd42342ddc3b49747de4dc96c95f575651750151c1ab60abb2463b8c7b5fecb5c816a8bae72ecf12e91288cd60f

data/.circleci/config.yml

@@ -53,10 +53,14 @@ gemfiles:
     steps:
       - ruby:
           gemfile: gemfiles/aws_3.gemfile
-  faraday: &faraday
+  faraday-zero: &faraday-zero
     steps:
       - ruby:
-          gemfile: gemfiles/faraday.gemfile
+          gemfile: gemfiles/faraday_0.gemfile
+  faraday-one: &faraday-one
+    steps:
+      - ruby:
+          gemfile: gemfiles/faraday_1.gemfile
   sequel-four: &sequel-four
     steps:
       - ruby:
@@ -145,17 +149,29 @@ jobs:
   aws-three-ruby-two-six:
     <<: *aws-three
     executor: ruby-two-six
-  faraday-ruby-two-three:
-    <<: *faraday
+  faraday-zero-ruby-two-three:
+    <<: *faraday-zero
     executor: ruby-two-three
-  faraday-ruby-two-four:
-    <<: *faraday
+  faraday-zero-ruby-two-four:
+    <<: *faraday-zero
     executor: ruby-two-four
-  faraday-ruby-two-five:
-    <<: *faraday
+  faraday-zero-ruby-two-five:
+    <<: *faraday-zero
     executor: ruby-two-five
-  faraday-ruby-two-six:
-    <<: *faraday
+  faraday-zero-ruby-two-six:
+    <<: *faraday-zero
+    executor: ruby-two-six
+  faraday-one-ruby-two-three:
+    <<: *faraday-one
+    executor: ruby-two-three
+  faraday-one-ruby-two-four:
+    <<: *faraday-one
+    executor: ruby-two-four
+  faraday-one-ruby-two-five:
+    <<: *faraday-one
+    executor: ruby-two-five
+  faraday-one-ruby-two-six:
+    <<: *faraday-one
     executor: ruby-two-six
   sequel-four-ruby-two-three:
     <<: *sequel-four
@@ -339,19 +355,35 @@ workflows:
           <<: *tag_filters
           requires:
             - lint
-      - faraday-ruby-two-three:
+      - faraday-zero-ruby-two-three:
+          <<: *tag_filters
+          requires:
+            - lint
+      - faraday-zero-ruby-two-four:
+          <<: *tag_filters
+          requires:
+            - lint
+      - faraday-zero-ruby-two-five:
+          <<: *tag_filters
+          requires:
+            - lint
+      - faraday-zero-ruby-two-six:
+          <<: *tag_filters
+          requires:
+            - lint
+      - faraday-one-ruby-two-three:
           <<: *tag_filters
           requires:
             - lint
-      - faraday-ruby-two-four:
+      - faraday-one-ruby-two-four:
           <<: *tag_filters
           requires:
             - lint
-      - faraday-ruby-two-five:
+      - faraday-one-ruby-two-five:
           <<: *tag_filters
           requires:
             - lint
-      - faraday-ruby-two-six:
+      - faraday-one-ruby-two-six:
           <<: *tag_filters
           requires:
             - lint
@@ -543,10 +575,14 @@ workflows:
             - aws-three-ruby-two-four
             - aws-three-ruby-two-five
             - aws-three-ruby-two-six
-            - faraday-ruby-two-three
-            - faraday-ruby-two-four
-            - faraday-ruby-two-five
-            - faraday-ruby-two-six
+            - faraday-zero-ruby-two-three
+            - faraday-zero-ruby-two-four
+            - faraday-zero-ruby-two-five
+            - faraday-zero-ruby-two-six
+            - faraday-one-ruby-two-three
+            - faraday-one-ruby-two-four
+            - faraday-one-ruby-two-five
+            - faraday-one-ruby-two-six
             - sequel-four-ruby-two-three
             - sequel-four-ruby-two-four
             - sequel-four-ruby-two-five

data/.rubocop.yml

@@ -22,6 +22,8 @@ Metrics/ClassLength:
 
 Metrics/MethodLength:
   Max: 25
+  Exclude:
+    - lib/generators/honeycomb/honeycomb_generator.rb
 
 Metrics/LineLength:
   Exclude:

data/Appraisals

@@ -8,8 +8,12 @@ appraise "aws-3" do
   gem "aws-sdk", "~> 3"
 end
 
-appraise "faraday" do
-  gem "faraday"
+appraise "faraday-0" do
+  gem "faraday", "~> 0"
+end
+
+appraise "faraday-1" do
+  gem "faraday", "~> 1"
 end
 
 appraise "sequel4" do
@@ -35,30 +39,35 @@ end
 appraise "rails-41" do
   gem "rack-test"
   gem "rails", "~> 4.1.0"
+  gem "sprockets", "~> 3"
   gem "warden"
 end
 
 appraise "rails-42" do
   gem "rack-test"
   gem "rails", "~> 4.2.0"
+  gem "sprockets", "~> 3"
   gem "warden"
 end
 
 appraise "rails-5" do
   gem "rack-test"
   gem "rails", "~> 5.0.0"
+  gem "sprockets", "~> 3"
   gem "warden"
 end
 
 appraise "rails-51" do
   gem "rack-test"
   gem "rails", "~> 5.1.0"
+  gem "sprockets", "~> 3"
   gem "warden"
 end
 
 appraise "rails-52" do
   gem "rack-test"
   gem "rails", "~> 5.2.0"
+  gem "sprockets", "~> 3"
   gem "warden"
 end
 

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (1.3.0)
-      libhoney (~> 1.8)
+    honeycomb-beeline (2.0.0)
+      libhoney (~> 1.14, >= 1.14.2)
 
 GEM
   remote: https://rubygems.org/
@@ -31,20 +31,20 @@ GEM
       ffi (>= 1.0.0)
       rake
     hashdiff (0.4.0)
-    http (4.2.0)
+    http (4.3.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
+      http-form_data (~> 2.2)
       http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.1.1)
+    http-form_data (2.3.0)
     http-parser (1.2.1)
       ffi-compiler (>= 1.0, < 2.0)
     iniparse (1.4.4)
     jaro_winkler (1.5.3)
     json (2.2.0)
-    libhoney (1.14.1)
+    libhoney (1.14.4)
       addressable (~> 2.0)
       http (>= 2.0, < 5.0)
     method_source (0.9.2)
@@ -62,7 +62,7 @@ GEM
       pry (~> 0.10)
     public_suffix (3.1.1)
     rainbow (3.0.0)
-    rake (12.3.2)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -127,4 +127,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/honeycomb-beeline.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "libhoney", "~> 1.8"
+  spec.add_dependency "libhoney", ">= 1.14.2", "~> 1.14"
 
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bump"

data/lib/generators/honeycomb/honeycomb_generator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rails/generators"
+require "active_support/core_ext/string/strip"
 
 ##
 # Generates an intializer for configuring the Honeycomb beeline
@@ -22,6 +23,19 @@ class HoneycombGenerator < Rails::Generators::Base
         Honeycomb.configure do |config|
           config.write_key = #{write_key.inspect}
           config.dataset = #{options['dataset'].inspect}
+          config.presend_hook do |fields|
+            if fields["name"] == "redis" && fields.has_key?("redis.command")
+              # remove potential PII from the redis command
+              if fields["redis.command"].respond_to? :split
+                fields["redis.command"] = fields["redis.command"].split.first
+              end
+            end
+            if fields["name"] == "sql.active_record"
+              # remove potential PII from the active record events
+              fields.delete("sql.active_record.binds")
+              fields.delete("sql.active_record.type_casted_binds")
+            end
+          end
           config.notification_events = %w[
             sql.active_record
             render_template.action_view

data/lib/honeycomb-beeline.rb

@@ -25,7 +25,8 @@ module Honeycomb
     extend Forwardable
     attr_reader :client
 
-    def_delegators :@client, :start_span, :add_field, :add_field_to_trace
+    def_delegators :@client, :libhoney, :start_span, :add_field,
+                   :add_field_to_trace, :current_span, :current_trace
 
     def configure
       Configuration.new.tap do |config|

data/lib/honeycomb/beeline/version.rb

@@ -3,7 +3,7 @@
 module Honeycomb
   module Beeline
     NAME = "honeycomb-beeline".freeze
-    VERSION = "1.3.0".freeze
+    VERSION = "2.0.0".freeze
     USER_AGENT_SUFFIX = "#{NAME}/#{VERSION}".freeze
   end
 end

data/lib/honeycomb/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "forwardable"
 require "honeycomb/beeline/version"
 require "honeycomb/configuration"
 require "honeycomb/context"
@@ -7,18 +8,28 @@ require "honeycomb/context"
 module Honeycomb
   # The Honeycomb Beeline client
   class Client
+    extend Forwardable
+
+    attr_reader :libhoney
+
+    def_delegators :@context, :current_span, :current_trace
+
     def initialize(configuration:)
-      @client = configuration.client
+      @libhoney = configuration.client
       # attempt to set the user_agent_addition, this will only work if the
       # client has not sent an event prior to being passed in here. This should
       # be most cases
-      @client.instance_variable_set(:@user_agent_addition,
-                                    Honeycomb::Beeline::USER_AGENT_SUFFIX)
-      @client.add_field "meta.beeline_version", Honeycomb::Beeline::VERSION
-      @client.add_field "meta.local_hostname", configuration.host_name
+      @libhoney.instance_variable_set(:@user_agent_addition,
+                                      Honeycomb::Beeline::USER_AGENT_SUFFIX)
+      @libhoney.add_field "meta.beeline_version", Honeycomb::Beeline::VERSION
+      @libhoney.add_field "meta.local_hostname", configuration.host_name
+
+      integrations = Honeycomb.integrations_to_load
+      @libhoney.add_field "meta.instrumentations_count", integrations.count
+      @libhoney.add_field "meta.instrumentations", integrations.map(&:to_s).to_s
 
       # maybe make `service_name` a required parameter
-      @client.add_field "service_name", configuration.service_name
+      @libhoney.add_field "service_name", configuration.service_name
       @context = Context.new
 
       @additional_trace_options = {
@@ -29,14 +40,14 @@ module Honeycomb
       configuration.after_initialize(self)
 
       at_exit do
-        client.close
+        libhoney.close
       end
     end
 
     def start_span(name:, serialized_trace: nil, **fields)
       if context.current_trace.nil?
         Trace.new(serialized_trace: serialized_trace,
-                  builder: client.builder,
+                  builder: libhoney.builder,
                   context: context,
                   **@additional_trace_options)
       else
@@ -53,8 +64,8 @@ module Honeycomb
         begin
           yield context.current_span
         rescue StandardError => e
-          context.current_span.add_field("request.error", e.class.name)
-          context.current_span.add_field("request.error_detail", e.message)
+          context.current_span.add_field("error", e.class.name)
+          context.current_span.add_field("error_detail", e.message)
           raise e
         ensure
           context.current_span.send
@@ -78,6 +89,6 @@ module Honeycomb
 
     private
 
-    attr_reader :client, :context
+    attr_reader :context
   end
 end

data/lib/honeycomb/integrations/active_support.rb

@@ -34,7 +34,9 @@ module Honeycomb
           on_notification_event.call(name, span, payload)
         else
           payload.each do |key, value|
-            span.add_field("#{name}.#{key}", value.to_s)
+            # Make ActionController::Parameters parseable by libhoney.
+            value = value.to_unsafe_hash if value.respond_to?(:to_unsafe_hash)
+            span.add_field("#{name}.#{key}", value)
           end
         end
       end

data/lib/honeycomb/integrations/aws.rb

@@ -106,8 +106,12 @@ module Honeycomb
           "aws.region" => context.config.region,
           "aws.service" => context.client.class.identifier,
           "aws.operation" => context.operation_name,
-          "aws.params" => context.params,
         }
+
+        context.params && context.params.each do |key, value|
+          context[:honeycomb_aws_sdk_data]["aws.params.#{key}"] = value
+        end
+
         span.add context[:honeycomb_aws_sdk_data]
       end
 

data/lib/honeycomb/integrations/faraday.rb

@@ -15,7 +15,7 @@ module Honeycomb
 
       @client.start_span(name: "http_client") do |span|
         span.add_field "request.method", env.method.upcase
-        span.add_field "request.protocol", env.url.scheme
+        span.add_field "request.scheme", env.url.scheme
         span.add_field "request.host", env.url.host
         span.add_field "request.path", env.url.path
         span.add_field "meta.type", "http_client"

data/lib/honeycomb/integrations/rack.rb

@@ -13,8 +13,10 @@ module Honeycomb
       ["HTTP_VERSION", "request.http_version"],
       ["HTTP_HOST", "request.host"],
       ["REMOTE_ADDR", "request.remote_addr"],
+      ["HTTP_ACCEPT", "request.header.accept"],
+      ["CONTENT_TYPE", "request.header.content_type"],
       ["HTTP_USER_AGENT", "request.header.user_agent"],
-      ["rack.url_scheme", "request.protocol"],
+      ["rack.url_scheme", "request.scheme"],
     ].freeze
 
     attr_reader :app, :client
@@ -25,6 +27,7 @@ module Honeycomb
     end
 
     def call(env)
+      req = ::Rack::Request.new(env)
       hny = env["HTTP_X_HONEYCOMB_TRACE"]
       client.start_span(name: "http_request", serialized_trace: hny) do |span|
         add_field = lambda do |key, value|
@@ -35,6 +38,9 @@ module Honeycomb
 
         extract_fields(env, RACK_FIELDS, &add_field)
 
+        span.add_field("request.secure", req.ssl?)
+        span.add_field("request.xhr", req.xhr?)
+
         status, headers, body = app.call(env)
 
         add_package_information(env, &add_field)
@@ -42,6 +48,7 @@ module Honeycomb
         extract_user_information(env, &add_field)
 
         span.add_field("response.status_code", status)
+        span.add_field("response.content_type", headers["Content-Type"])
 
         [status, headers, body]
       end

data/lib/honeycomb/integrations/rails.rb

@@ -11,29 +11,79 @@ module Honeycomb
       yield "meta.package", "rails"
       yield "meta.package_version", ::Rails::VERSION::STRING
 
-      ::ActionDispatch::Request.new(env).tap do |request|
-        # calling request.params will blow up if raw_post is nil
-        # the only known cause of this is when using the
-        # [twirp](https://github.com/twitchtv/twirp-ruby) rack app mounted in
-        # the rails app
-        if request.raw_post
-          yield "request.controller", request.params[:controller]
-          yield "request.action", request.params[:action]
-        end
-
-        break unless request.respond_to? :routes
-        break unless request.routes.respond_to? :router
-
-        found_route = false
-        request.routes.router.recognize(request) do |route, _|
-          break if found_route
-
-          found_route = true
-          yield "request.route", "#{env['REQUEST_METHOD']} #{route.path.spec}"
-        end
+      request = ::ActionDispatch::Request.new(env)
+
+      yield "request.controller", request.path_parameters[:controller]
+      yield "request.action", request.path_parameters[:action]
+      yield "request.route", route_for(request)
+    end
+
+    private
+
+    def route_for(request)
+      router = router_for(request)
+      routing = routing_for(request)
+
+      return unless router && routing
+
+      router.recognize(routing) do |route, _|
+        return "#{request.method} #{route.path.spec}"
       end
     end
 
+    # Broadly compatible way of getting the ActionDispatch::Routing::RouteSet.
+    #
+    # While we'd like to just use ActionDispatch::Request#routes, that method
+    # was only added circa Rails 5. To support Rails 4, we have to use direct
+    # Rack env access.
+    #
+    # @see https://github.com/rails/rails/commit/87a75910640b83a677099198ccb3317d9850c204
+    def router_for(request)
+      routes = request.env["action_dispatch.routes"]
+      routes.router if routes.respond_to?(:router)
+    end
+
+    # Constructs a simplified ActionDispatch::Request with the original route.
+    #
+    # This is based on ActionDispatch::Routing::RouteSet#recognize_path, which
+    # reconstructs an ActionDispatch::Request using a given HTTP method + path
+    # by making a mock Rack environment. Here, instead of taking the method +
+    # path from input parameters, we use the original values from the actual
+    # incoming request (prior to any mangling that may have been done by
+    # middleware).
+    #
+    # The resulting ActionDispatch::Request instance is suitable for passing to
+    # ActionDispatch::Journey::Router#recognize to get the original Rails
+    # routing information corresponding to the incoming request.
+    #
+    # @param request [ActionDispatch::Request]
+    #   the actual incoming Rails request
+    #
+    # @return [ActionDispatch::Request]
+    #   a simplified version of the incoming request that retains the original
+    #   routing information, but nothing else (e.g., no HTTP parameters)
+    #
+    # @return [nil]
+    #   if the original request's path is invalid
+    #
+    # @see https://api.rubyonrails.org/classes/ActionDispatch/Request.html#method-i-method
+    # @see https://api.rubyonrails.org/classes/ActionDispatch/Request.html#method-i-original_fullpath
+    # @see https://github.com/rails/rails/blob/2a44ff12c858d296797963f7aa97abfa0c840a15/actionpack/lib/action_dispatch/journey/router/utils.rb#L7-L27
+    # @see https://github.com/rails/rails/blob/2a44ff12c858d296797963f7aa97abfa0c840a15/actionpack/lib/action_dispatch/routing/route_set.rb#L846-L859
+    def routing_for(request)
+      verb = request.method
+      path = request.original_fullpath
+      path = normalize(path) unless path =~ %r{://}
+      env = ::Rack::MockRequest.env_for(path, method: verb)
+      ::ActionDispatch::Request.new(env)
+    rescue URI::InvalidURIError
+      nil
+    end
+
+    def normalize(path)
+      ::ActionDispatch::Journey::Router::Utils.normalize_path(path)
+    end
+
     # Rails middleware
     class Middleware
       include Rack

data/lib/honeycomb/integrations/railtie.rb

@@ -9,9 +9,8 @@ module Honeycomb
     initializer("honeycomb.install_middleware",
                 after: :load_config_initializers) do |app|
       if Honeycomb.client
-        # what location should we insert the middleware at?
-        app.config.middleware.insert_before(
-          ::Rails::Rack::Logger,
+        app.config.middleware.insert_after(
+          ActionDispatch::ShowExceptions,
           Honeycomb::Rails::Middleware,
           client: Honeycomb.client,
         )

data/lib/honeycomb/integrations/redis.rb

@@ -23,7 +23,9 @@ module Honeycomb
       attr_writer :honeycomb_client
 
       def honeycomb_client
-        @honeycomb_client || Honeycomb.client
+        return @honeycomb_client if defined?(@honeycomb_client)
+
+        Honeycomb.client
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-beeline
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Martin Holman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement