honeycomb-rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5269a0de1a6d47dd7c0ff92bdd5e2a954369ad0f49b09ca5c23a7c3e1d4d0214
-  data.tar.gz: 79a58361d5f1a334f9d58f48be31f13779d243130a7ea74951547baf4147f0c5
+  metadata.gz: a7cb5db4cd8ae4478d1cda742c05abc52cf47123c1990c5e41e398bd2db74a15
+  data.tar.gz: bc5beac5c64c75d6755a839717b9ac3a9e33a5b42c6fac948f4d4d15afd6910c
 SHA512:
-  metadata.gz: 396f9cc14e318d1795a4883b54f1906a08692d98d6040219cf1726adb418fc4793c504859da5113e2a81f9fd18a12c89e2b8b87e2ef598d90714fbac61dddeee
-  data.tar.gz: d472468f60e3d33fffa15b31b259edb1fdcbc0d08462a0eaf5853c61ec2cfae05b742134ab16e96ff061c0519c25c8cc1f6adfec304fdd68ce3d85fd84c434c2
+  metadata.gz: afc18e55a4563f1d8740f1cc7b328767ac6162ec7f95ce94eb745025f7c5e44856fef1bf1a75f448b88906d71c00dcc41a5376176113e2d719fd1cf2928744a4
+  data.tar.gz: d24b041b9aa4123cb0f4ab7fceb60594467aec3b576f332466986d0773cd6c2594b4912dd06506c48d3df31e2ca195fc0376dfe569f2061c7b119accff4a94f2

data/lib/honeycomb-rails/config.rb

@@ -38,6 +38,11 @@ module HoneycombRails
     # about the current user.
     attr_accessor :record_user
 
+    # Override the default Libhoney::Client used to send events to Honeycomb.
+    # If this is specified, {#writekey} will be ignored.
+    # @api private
+    attr_accessor :client
+
     # Send request events to the Honeycomb dataset with this name (default:
     # 'rails'). Set to nil or an empty string to disable.
     attr_accessor :dataset
@@ -49,19 +54,48 @@ module HoneycombRails
     # The Honeycomb write key for your team (must be specified).
     attr_accessor :writekey
 
+    # @!attribute sample_rate
     # If set, determines how to record the sample rate for a given Honeycomb
     # event. (default: 1, do not sample)
     #
     # Valid values:
-    # * Integer - sample Honeycomb events at a constant rate
-    # * 1 or lower - disable sampling on this dataset; capture all events
-    # * TODO: :rails - default Rails dynamic sampling?
+    # * Integer > 1 - sample Honeycomb events at a constant rate
+    # * 1 - disable sampling on this dataset; capture all events
+    #
+    # You can also pass a block, which will be called with the
+    # event type and the ActiveSupport::Notifications payload that was used to
+    # populate the Honeycomb event, and which should return a sample rate for
+    # the request or database query in question. For example, to sample
+    # successful (200) requests and read (SELECT) queries at 100:1 and all other
+    # requests at 1:1:
     #
-    # You can also pass a Proc, which will be called with the
-    # ActiveSupport::Notifications payload that was used to populate the
-    # Honeycomb event, and which should return a sample rate for the request
-    # in question.
-    attr_accessor :sample_rate
+    # @example Dynamic sampling with a block
+    #   config.sample_rate do |event_type, payload|
+    #     case event_type
+    #     when 'sql.active_record'
+    #       if payload[:sql] =~ /^SELECT/
+    #         100
+    #       else
+    #         1
+    #       end
+    #     when 'process_action.action_controller'
+    #       if payload[:status] == 200
+    #         100
+    #       else
+    #         1
+    #       end
+    #     end
+    #   end
+
+    attr_writer :sample_rate
+
+    def sample_rate(&block)
+      if block
+        self.sample_rate = block
+      else
+        @sample_rate
+      end
+    end
 
     # If set to true, captures exception class name / message along with Rails
     # request events. (default: true)

data/lib/honeycomb-rails/extensions/action_controller.rb

@@ -5,11 +5,20 @@ module HoneycombRails
         def self.included(controller_class)
           super
 
-          controller_class.before_action do
+          install_before_filter!(controller_class) do
             honeycomb_initialize
           end
         end
 
+        def self.install_before_filter!(controller_class, &block)
+          raise ArgumentError unless block_given?
+          if ::Rails::VERSION::MAJOR < 4
+            controller_class.before_filter(&block)
+          else
+            controller_class.before_action(&block)
+          end
+        end
+
         def honeycomb_initialize
           @honeycomb_metadata = {}
         end

data/lib/honeycomb-rails/railtie.rb

@@ -19,15 +19,17 @@ module HoneycombRails
     config.after_initialize do
       HoneycombRails.config.logger ||= ::Rails.logger
 
-      writekey = HoneycombRails.config.writekey
-      if writekey.blank?
-        HoneycombRails.config.logger.warn("No write key defined! (Check your config's `writekey` value in config/initializers/honeycomb.rb) No events will be sent to Honeycomb.")
+      @libhoney = HoneycombRails.config.client || begin
+        writekey = HoneycombRails.config.writekey
+        if writekey.blank?
+          HoneycombRails.config.logger.warn("No write key defined! (Check your config's `writekey` value in config/initializers/honeycomb.rb) No events will be sent to Honeycomb.")
+        end
+
+        Libhoney::Client.new(
+          writekey: writekey,
+          user_agent_addition: HoneycombRails::USER_AGENT_SUFFIX,
+        )
       end
-
-      @libhoney = Libhoney::Client.new(
-        writekey: writekey,
-        user_agent_addition: HoneycombRails::USER_AGENT_SUFFIX,
-      )
     end
 
     config.after_initialize do

data/lib/honeycomb-rails/subscribers/active_record.rb

@@ -1,3 +1,5 @@
+require 'honeycomb-rails/subscribers/sampling'
+
 require 'active_support/core_ext/hash'
 require 'active_support/notifications'
 require 'rails'
@@ -5,6 +7,8 @@ require 'rails'
 module HoneycombRails
   module Subscribers
     class ActiveRecord
+      include Sampling
+
       def initialize(honeybuilder)
         @honeybuilder = honeybuilder
       end
@@ -34,7 +38,12 @@ module HoneycombRails
         #       filters and silencers to trim down the noise.
         data[:local_stack] = Rails.backtrace_cleaner.clean(caller)
 
-        @honeybuilder.send_now(data)
+        honeycomb_event = @honeybuilder.event
+        honeycomb_event.add(data)
+
+        sample_event_if_required(honeycomb_event, event)
+
+        honeycomb_event.send
       end
     end
   end

data/lib/honeycomb-rails/subscribers/process_action.rb

@@ -1,4 +1,5 @@
 require 'honeycomb-rails/constants'
+require 'honeycomb-rails/subscribers/sampling'
 
 require 'active_support/core_ext/hash'
 require 'active_support/notifications'
@@ -6,6 +7,8 @@ require 'active_support/notifications'
 module HoneycombRails
   module Subscribers
     class ProcessAction
+      include Sampling
+
       def initialize(libhoney)
         @libhoney = libhoney
       end
@@ -24,6 +27,10 @@ module HoneycombRails
                                   :status, :db_runtime, :view_runtime,
                                   :exception, :exception_object)
 
+        if request_id = event.payload[:headers][:'action_dispatch.request_id']
+          data[:request_id] = request_id
+        end
+
         # Massage data to return "all" as the :format if not set
         if !data[:format] || data[:format] == "format:*/*"
           data[:format] = "all"
@@ -69,14 +76,7 @@ module HoneycombRails
         honeycomb_event = @libhoney.event
         honeycomb_event.add(data)
 
-        case HoneycombRails.config.sample_rate
-        when Proc
-          honeycomb_event.sample_rate = HoneycombRails.config.sample_rate.call(event.payload)
-        when Integer
-          if HoneycombRails.config.sample_rate > 1
-            honeycomb_event.sample_rate = HoneycombRails.config.sample_rate
-          end
-        end
+        sample_event_if_required(honeycomb_event, event)
 
         honeycomb_event.send
       end

data/lib/honeycomb-rails/subscribers/sampling.rb

@@ -0,0 +1,19 @@
+module HoneycombRails
+  module Subscribers
+    module Sampling
+      def sample_event_if_required(honeycomb_event, notification_event)
+        case HoneycombRails.config.sample_rate
+        when Proc
+          honeycomb_event.sample_rate = HoneycombRails.config.sample_rate.call(
+            notification_event.name,
+            notification_event.payload,
+          )
+        when Integer
+          if HoneycombRails.config.sample_rate > 1
+            honeycomb_event.sample_rate = HoneycombRails.config.sample_rate
+          end
+        end
+      end
+    end
+  end
+end

data/lib/honeycomb-rails/version.rb

@@ -1,7 +1,7 @@
 module HoneycombRails
   GEM_NAME = 'honeycomb-rails'
 
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 
   USER_AGENT_SUFFIX = "#{GEM_NAME}/#{VERSION}".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeycomb-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sam Stokes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libhoney
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ files:
 - lib/honeycomb-rails/subscribers.rb
 - lib/honeycomb-rails/subscribers/active_record.rb
 - lib/honeycomb-rails/subscribers/process_action.rb
+- lib/honeycomb-rails/subscribers/sampling.rb
 - lib/honeycomb-rails/version.rb
 homepage: https://github.com/honeycombio/honeycomb-rails
 licenses:
@@ -139,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Easily instrument your Rails apps with Honeycomb