honeycomb-beeline 1.3.0 → 2.2.0

data/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Code owners file.
+# This file controls who is tagged for review for any given pull request.
+
+# For anything not explicitly taken by someone else:
+* @honeycombio/integrations-team @martin308

data/.rubocop.yml

@@ -22,11 +22,16 @@ Metrics/ClassLength:
 
 Metrics/MethodLength:
   Max: 25
+  Exclude:
+    - lib/generators/honeycomb/honeycomb_generator.rb
 
 Metrics/LineLength:
   Exclude:
     - spec/support/event_data_shared_examples.rb
 
+Metrics/ParameterLists:
+  Max: 6
+
 Style/FrozenStringLiteralComment:
   EnforcedStyle: always
   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,24 +1,27 @@
 PATH
   remote: .
   specs:
-    honeycomb-beeline (1.3.0)
-      libhoney (~> 1.8)
+    honeycomb-beeline (2.2.0)
+      libhoney (~> 1.14, >= 1.14.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.0)
-    bump (0.8.0)
-    byebug (11.0.1)
+    bump (0.9.0)
+    byebug (10.0.2)
     childprocess (0.9.0)
       ffi (~> 1.0, >= 1.0.11)
+    codecov (0.2.8)
+      json
+      simplecov
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -26,56 +29,56 @@ GEM
     docile (1.3.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.11.1)
+    ffi (1.12.2)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    hashdiff (0.4.0)
-    http (4.2.0)
+    hashdiff (1.0.1)
+    http (4.4.1)
       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)
+    iniparse (1.5.0)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    libhoney (1.14.5)
       addressable (~> 2.0)
       http (>= 2.0, < 5.0)
     method_source (0.9.2)
     overcommit (0.46.0)
       childprocess (~> 0.6, >= 0.6.3)
       iniparse (~> 1.4)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
-      byebug (~> 11.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
       pry (~> 0.10)
-    public_suffix (3.1.1)
+    public_suffix (4.0.4)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     rubocop (0.68.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -87,23 +90,22 @@ GEM
       rubocop (>= 0.68.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    simplecov (0.16.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.5.0)
+      simplecov-html (~> 0.11)
+    simplecov-console (0.7.2)
       ansi
       simplecov
       terminal-table
-    simplecov-html (0.10.2)
+    simplecov-html (0.12.2)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (0.20.3)
+    thor (1.0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
     unicode-display_width (1.5.0)
-    webmock (3.6.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -115,9 +117,11 @@ DEPENDENCIES
   appraisal
   bump
   bundler
+  codecov
   honeycomb-beeline!
   overcommit (~> 0.46.0)
-  pry-byebug
+  pry (< 0.13.0)
+  pry-byebug (~> 3.6.0)
   rake
   rspec (~> 3.0)
   rubocop (< 0.69)
@@ -127,4 +131,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://circleci.com/gh/honeycombio/beeline-ruby.svg?style=svg)](https://circleci.com/gh/honeycombio/beeline-ruby)
 [![Gem Version](https://badge.fury.io/rb/honeycomb-beeline.svg)](https://badge.fury.io/rb/honeycomb-beeline)
+[![codecov](https://codecov.io/gh/honeycombio/beeline-ruby/branch/main/graph/badge.svg)](https://codecov.io/gh/honeycombio/beeline-ruby)
 
 This package makes it easy to instrument your Ruby web app to send useful events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
 - [Usage and Examples](https://docs.honeycomb.io/getting-data-in/beelines/ruby-beeline/)

data/honeycomb-beeline.gemspec

@@ -37,13 +37,15 @@ 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"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "codecov"
   spec.add_development_dependency "overcommit", "~> 0.46.0"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry", "< 0.13.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.6.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "< 0.69"

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.2.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,38 +40,38 @@ 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
         context.current_span.create_child
       end
 
+      current_span = context.current_span
+
       fields.each do |key, value|
-        context.current_span.add_field(key, value)
+        current_span.add_field(key, value)
       end
 
-      context.current_span.add_field("name", name)
-
-      if block_given?
-        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)
-          raise e
-        ensure
-          context.current_span.send
-        end
-      else
-        context.current_span
+      current_span.add_field("name", name)
+
+      return current_span unless block_given?
+
+      begin
+        yield current_span
+      rescue StandardError => e
+        current_span.add_field("error", e.class.name)
+        current_span.add_field("error_detail", e.message)
+        raise e
+      ensure
+        current_span.send
       end
     end
 
@@ -78,6 +89,6 @@ module Honeycomb
 
     private
 
-    attr_reader :client, :context
+    attr_reader :context
   end
 end

data/lib/honeycomb/configuration.rb

@@ -33,7 +33,7 @@ module Honeycomb
 
       @client ||
         (debug && Libhoney::LogClient.new) ||
-        Libhoney::Client.new(options)
+        Libhoney::Client.new(**options)
     end
 
     def after_initialize(client)

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
@@ -63,7 +65,7 @@ module Honeycomb
       def finish(name, id, payload)
         return unless (span = spans[id].pop)
 
-        handlers[name].call(name, span, payload)
+        handler_for(name).call(name, span, payload)
 
         span.send
       end
@@ -75,6 +77,16 @@ module Honeycomb
       def spans
         Thread.current[key] ||= Hash.new { |h, id| h[id] = [] }
       end
+
+      def handler_for(name)
+        handlers.fetch(name) do
+          handlers[
+            handlers.keys.detect do |key|
+              key.is_a?(Regexp) && key =~ name
+            end
+          ]
+        end
+      end
     end
   end
 end