honeycomb-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4126edc89b123ee4b3e97d5a11f71f7870dc780
+  data.tar.gz: 73d1591815b66f612c8b8ef83623b0d4285d6ba1
+SHA512:
+  metadata.gz: 0a97d7fe16561fec60e4065aed9de06af9486581e662b3ab919cdd83748c7ff26a836c5fbcbfc66e7c6311b5eb118708811afc820570911af75638d11a4c69a8
+  data.tar.gz: f80b392f7e5561b075ce73824a7dbe729123af30224a5a4fc711282d5e3da8340e60142f0a81278213d9422e0af2eb1823875a6c34ceec7a73a9ff3315c5c29f

data/README.md

@@ -0,0 +1,39 @@
+# honeycomb-rails
+
+Easily instrument your Rails apps with [Honeycomb](https://honeycomb.io).
+
+## Getting started
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'honeycomb-rails'
+```
+
+Then create a file in your application repo called `config/initializers/honeycomb.rb` with the following contents:
+
+```ruby
+HoneycombRails.configure do |conf|
+  conf.writekey = 'your honeycomb writekey here'
+  conf.dataset = 'your app name'
+  conf.db_dataset = 'your app name-activerecord'
+end
+```
+
+Now check out our [guide](https://honeycomb.io/docs/guides/rails/) to see what kind of visibility you can get from your app.
+
+## Configuration
+
+See [docs](http://www.rubydoc.info/gems/honeycomb-rails/HoneycombRails/Config) for available config options.
+
+## Documentation
+
+See [rubydoc](http://www.rubydoc.info/gems/honeycomb-rails/) for gem documentation.
+
+## Contributions
+
+Features, bug fixes and other changes are gladly accepted. Please
+open issues or a pull request with your change. Remember to add your name to the
+CONTRIBUTORS file!
+
+All contributions will be released under the Apache License 2.0.

data/lib/honeycomb-rails.rb

@@ -0,0 +1,27 @@
+if !defined?(Rails)
+  raise LoadError, 'honeycomb-rails requires Rails (maybe you meant libhoney?)'
+end
+
+require 'honeycomb-rails/config'
+
+module HoneycombRails
+  class << self
+    # Run this at app initialization time to configure honeycomb-rails. e.g.
+    #
+    #     HoneycombRails.configure do |conf|
+    #       conf.writekey = 'abc123def'
+    #     end
+    #
+    # See {Config} for available options.
+    #
+    # @yield [Config] the singleton config.
+    def configure
+      raise "Please pass a block to #{name}#configure" unless block_given?
+
+      yield config
+      config
+    end
+  end
+end
+
+require 'honeycomb-rails/railtie'

data/lib/honeycomb-rails/config.rb

@@ -0,0 +1,53 @@
+module HoneycombRails
+  # Configuration for the Honeycomb Rails integration.
+  #
+  # Specify this at app initialization time via {configure}.
+  class Config
+    def initialize
+      @dataset = 'rails'
+      @db_dataset = 'active_record'
+      @record_flash = true
+      @record_user = :detect
+    end
+
+    # Whether to record flash messages (default: true).
+    attr_writer :record_flash
+    # Whether to record flash messages (default: true).
+    def record_flash?
+      !!@record_flash
+    end
+
+    # If set, determines how to record the current user during request processing (default: :detect). Set to nil or false to disable.
+    #
+    # Valid values:
+    #
+    # * :devise - if your app uses Devise for authentication
+    # * :detect - autodetect how to determine the current user
+    # * nil, false - disable recording current user
+    #
+    # You can also pass a Proc, which will be called with the current controller
+    # instance during each request, and which should return a hash of metadata
+    # about the current user.
+    attr_accessor :record_user
+
+    # The Honeycomb dataset to send request events to (default: 'rails').
+    attr_accessor :dataset
+    # The Honeycomb dataset to send ActiveRecord query events to (default: 'active_record').
+    attr_accessor :db_dataset
+    # The Honeycomb write key for your team (must be specified).
+    attr_accessor :writekey
+  end
+
+  class << self
+    # @api private
+    def config
+      @config ||= Config.new
+    end
+
+    # For test use only
+    # @api private
+    def reset_config_to_default!
+      @config = Config.new
+    end
+  end
+end

data/lib/honeycomb-rails/constants.rb

@@ -0,0 +1,6 @@
+module HoneycombRails
+  module Constants
+    # @api private
+    EVENT_METADATA_KEY = :honeycomb_metadata
+  end
+end

data/lib/honeycomb-rails/extensions.rb

@@ -0,0 +1 @@
+require 'honeycomb-rails/extensions/action_controller'

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

@@ -0,0 +1,30 @@
+module HoneycombRails
+  module Extensions
+    module ActionController
+      module InstanceMethods
+        def self.included(controller_class)
+          super
+
+          controller_class.before_action do
+            honeycomb_initialize
+          end
+        end
+
+        def honeycomb_initialize
+          @honeycomb_metadata = {}
+        end
+
+        # Hash of metadata to be added to the event we will send to Honeycomb
+        # for the current request.
+        #
+        # To annotate the event with custom information (e.g. from a particular
+        # controller action), just add data to this hash: e.g.
+        #
+        #     honeycomb_metadata[:num_posts] = @posts.size
+        #
+        # @return [Hash<String=>Any>]
+        attr_reader :honeycomb_metadata
+      end
+    end
+  end
+end

data/lib/honeycomb-rails/overrides.rb

@@ -0,0 +1 @@
+require 'honeycomb-rails/overrides/action_controller_instrumentation'

data/lib/honeycomb-rails/overrides/action_controller_instrumentation.rb

@@ -0,0 +1,69 @@
+require 'honeycomb-rails/config'
+require 'honeycomb-rails/constants'
+
+module HoneycombRails
+  module Overrides
+    module ActionControllerInstrumentation
+      def append_info_to_payload(payload)
+        super
+
+        metadata = honeycomb_metadata
+
+        metadata.merge!(honeycomb_user_metadata)
+
+        if HoneycombRails.config.record_flash?
+          flash.each do |k, v|
+            metadata[:"flash_#{k}"] = v
+          end
+        end
+
+        # Attach to ActiveSupport::Instrumentation payload for consumption by
+        # subscribers/process_action.rb
+        payload[Constants::EVENT_METADATA_KEY] = metadata
+      end
+
+      def honeycomb_user_metadata
+        if defined?(@honeycomb_user_proc)
+          return @honeycomb_user_proc.call(self)
+        end
+
+        case HoneycombRails.config.record_user
+        when :detect
+          honeycomb_detect_user_methods!
+          honeycomb_user_metadata
+        when :devise
+          honeycomb_user_metadata_devise
+        when Proc
+          @honeycomb_user_proc = HoneycombRails.config.record_user
+          honeycomb_user_metadata
+        when nil, false
+          {}
+        else
+          raise "Invalid value for HoneycombRails.config.record_user: #{HoneycombRails.config.record_user.inspect}"
+        end
+      end
+
+      def honeycomb_user_metadata_devise
+        if current_user
+          {
+            current_user_id: current_user.id,
+            current_user_email: current_user.email,
+            current_user_admin: !!current_user.try(:admin?),
+          }
+        else
+          {}
+        end
+      end
+
+      def honeycomb_detect_user_methods!
+        if respond_to?(:current_user)
+          # This could be more sophisticated, but it'll do for now
+          HoneycombRails.config.record_user = :devise
+        else
+          logger.error "HoneycombRails.config.record_user = :detect but couldn't detect user methods; disabling user recording."
+          HoneycombRails.config.record_user = false
+        end
+      end
+    end
+  end
+end

data/lib/honeycomb-rails/railtie.rb

@@ -0,0 +1,35 @@
+require 'honeycomb-rails/extensions'
+require 'honeycomb-rails/overrides'
+require 'honeycomb-rails/subscribers'
+
+require 'libhoney'
+
+module HoneycombRails
+  class Railtie < ::Rails::Railtie
+    initializer 'honeycomb.action_controller_extensions', after: :action_controller do
+      ::ActionController::Base.include(Extensions::ActionController::InstanceMethods)
+    end
+
+    initializer 'honeycomb.action_controller_overrides', after: :action_controller do
+      ::ActionController::Base.include(Overrides::ActionControllerInstrumentation)
+    end
+
+    # set up libhoney after application initialization so that any config in
+    # the app's config/initializers has taken effect.
+    config.after_initialize do
+      writekey = HoneycombRails.config.writekey
+      dataset = HoneycombRails.config.dataset
+      @libhoney = Libhoney::Client.new(writekey: writekey, dataset: dataset)
+    end
+
+    config.after_initialize do
+      db_builder = @libhoney.builder
+      db_builder.dataset = HoneycombRails.config.db_dataset
+
+      [
+        Subscribers::ProcessAction.new(@libhoney),
+        Subscribers::ActiveRecord.new(db_builder),
+      ].each(&:subscribe!)
+    end
+  end
+end

data/lib/honeycomb-rails/subscribers.rb

@@ -0,0 +1,2 @@
+require 'honeycomb-rails/subscribers/active_record'
+require 'honeycomb-rails/subscribers/process_action'

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

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/hash'
+require 'active_support/notifications'
+require 'rails'
+
+module HoneycombRails
+  module Subscribers
+    class ActiveRecord
+      def initialize(honeybuilder)
+        @honeybuilder = honeybuilder
+      end
+
+      def subscribe!
+        ::ActiveSupport::Notifications.subscribe(/sql.active_record/) do |*args|
+          call(*args)
+        end
+      end
+
+      def call(*args)
+        event = ActiveSupport::Notifications::Event.new(*args)
+        data = event.payload.slice(:name, :connection_id)
+        data[:sql] = event.payload[:sql].strip
+        event.payload[:binds].each do |b|
+          data["bind_#{ b.name }".to_sym] = b.value
+        end
+        data[:duration] = event.duration
+
+        # NOTE: Backtraces can be very verbose! Keep an eye on the data that gets sent
+        #       into Honeycomb and, if needed, experiment with BacktraceCleaner's
+        #       filters and silencers to trim down the noise.
+        data[:local_stack] = Rails.backtrace_cleaner.clean(caller)
+
+        @honeybuilder.send_now(data)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'honeycomb-rails/constants'
+
+require 'active_support/core_ext/hash'
+require 'active_support/notifications'
+
+module HoneycombRails
+  module Subscribers
+    class ProcessAction
+      def initialize(libhoney)
+        @libhoney = libhoney
+      end
+
+      def subscribe!
+        ::ActiveSupport::Notifications.subscribe(/process_action.action_controller/) do |*args|
+          call(*args)
+        end
+      end
+
+      def call(*args)
+        event = ::ActiveSupport::Notifications::Event.new(*args)
+
+        # These are the keys we're interested in! Skipping noisy keys (:headers, :params) for now.
+        data = event.payload.slice(:controller, :action, :method, :path, :format,
+                                  :status, :db_runtime, :view_runtime)
+
+        # Massage data to return "all" as the :format if not set
+        if !data[:format] || data[:format] == "format:*/*"
+          data[:format] = "all"
+        end
+
+        # Pull top-level attributes off of the ActiveSupport Event.
+        data[:duration_ms] = event.duration
+
+        # Add anything we added in our controller-level instrumentation (see
+        # overrides/action_controller_instrumentation.rb)
+        if event.payload.key?(Constants::EVENT_METADATA_KEY)
+          data.merge!(event.payload[Constants::EVENT_METADATA_KEY])
+        end
+
+        @libhoney.send_now(data)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: honeycomb-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Stokes
+- Christine Yen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libhoney
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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
+    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: libhoney
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: |2
+      Get fine-grained visibility into the behavior and performance of your
+      Rails web app. This gem instruments your app to send events to Honeycomb
+      (https://honeycomb.io) each time it processes an HTTP request or makes a
+    database query.
+email:
+- sam@honeycomb.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/honeycomb-rails.rb
+- lib/honeycomb-rails/config.rb
+- lib/honeycomb-rails/constants.rb
+- lib/honeycomb-rails/extensions.rb
+- lib/honeycomb-rails/extensions/action_controller.rb
+- lib/honeycomb-rails/overrides.rb
+- lib/honeycomb-rails/overrides/action_controller_instrumentation.rb
+- lib/honeycomb-rails/railtie.rb
+- lib/honeycomb-rails/subscribers.rb
+- lib/honeycomb-rails/subscribers/active_record.rb
+- lib/honeycomb-rails/subscribers/process_action.rb
+homepage: https://github.com/honeycombio/honeycomb-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Easily instrument your Rails apps with Honeycomb
+test_files: []