loggerator 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 147fb6d7ba2b85f8916e9b8e5e96ac088baa8fa2
-  data.tar.gz: 699170130066ddbc05ba5ba8f33e1bfccfc2ddda
+  metadata.gz: 9e9a65b92ed9e08a20614a02d8b8abf5ea970ef1
+  data.tar.gz: 783ea749f4dfe30ffa92af44b8f9f95e09d79e70
 SHA512:
-  metadata.gz: e85021a1d1bc361b85a764e8ec65c9ec097eeee232f77ff05cc7ad1f3850afef012dee300b16b2cbae99e9a1aca90edeb03c810b424dd0e27ddea785cd298daf
-  data.tar.gz: 61852b4aada68c3c5c931876d310a777092ee3809fcc424ae7f555667345e8149065548d2fe1f358e0daf0f3d8170af7320c56f346a8e5d2340ab7da05776bc6
+  metadata.gz: 4b5565c2404a379837a6c9a429c167cc66f42179272b2af74f555a75e1c989e2c575a15227cc3b8b2e34b305557e79b87eacef59495112c780550834c4585f70
+  data.tar.gz: 897661dec2f7d5ba388aee5002585ddf17481ce0cf230934bcbb726d793b9cf78cb5e35de117a63e3945728e912abab1f9ab75092994f17cbbb525587206daad

data/lib/generators/templates/log.rb.erb

@@ -1,4 +1,34 @@
-Loggerator::Log.default_context = { app: "<%= app_name %>" }
+Loggerator.config do |config|
+  # Set loggerator's default context. These are the key/value pairs
+  # defining your application, which are prepended to every log line.
+  config.default_context = { app: "<%= app_name %>" }
 <% if defined?(Loggerator::Metrics) -%>
-Loggerator::Metrics.name   = "<%= app_name %>"
+
+  # Set loggerator's metrics name. This is the name to be included as
+  # part of the metric key when emitting metrics.
+  config.metrics_app_name = "<%= app_name %>"
 <% end -%>
+<% if defined?(Loggerator::Railtie) -%>
+
+  # Requiring 'loggerator/rails' automatically overrides Rails' log subscribers
+  # for controller handling with it's own log subscriber.
+  #
+  # In case you may need to disable this functionality, the following is
+  # a simple method for turning this off, causing the default logging to be
+  # modified.
+  #
+  # Additionally, the line below could be added only to config/environments/development.rb
+  # to disable Loggerator's controller logging in development only.
+  #
+  #config.rails_default_subscribers = true
+<% end -%>
+end
+
+# Beyond the above configuration method, you can also set loggerator's config via
+# a hash.
+#
+#Loggerator.config = { default_context: { app: "<%= app_name %>" } }
+#
+# Or parsed from a yaml file.
+#
+#Loggerator.config = YAML.load_file(File.expand_path("../../loggerator.yml", __FILE__))

data/lib/loggerator/configuration.rb

@@ -0,0 +1,22 @@
+module Loggerator
+  class Configuration
+    attr_accessor :default_context, :metrics_app_name, :rails_default_subscribers, :stdout, :stderr
+
+    def initialize(h = {})
+      @default_context           = h[:default_context]           || {}
+      @rails_default_subscribers = h[:rails_default_subscribers] || false
+      @metrics_app_name          = h[:metrics_app_name]          || "loggerator"
+
+      @stdout = h[:stdout] || $stdout
+      @stderr = h[:stderr] || $stderr
+    end
+
+    def to_h
+      {
+        default_context: default_context,
+        metrics_app_name: metrics_app_name,
+        rails_default_subscribers: rails_default_subscribers
+      }
+    end
+  end
+end

data/lib/loggerator/log.rb

@@ -0,0 +1,94 @@
+module Loggerator
+  # Don't expose internals into included modules so name-collisions are reduced
+  module Log
+    extend self
+
+    def local_context
+      RequestStore.store[:local_context] ||= {}
+    end
+
+    def local_context=(h)
+      RequestStore.store[:local_context] = h
+    end
+
+    def stdout=(stream)
+      Loggerator.config.stdout = stream
+    end
+
+    def stdout
+      Loggerator.config.stdout
+    end
+
+    def stderr=(stream)
+      Loggerator.config.stderr = stream
+    end
+
+    def stderr
+      Loggerator.config.stderr
+    end
+
+    def contexts(data)
+      Loggerator.config.default_context.merge(request_context.merge(local_context.merge(data)))
+    end
+
+    def to_stream(stream, data, &block)
+      unless block
+        str = unparse(data)
+        stream.print(str + "\n")
+      else
+        data = data.dup
+        start = Time.now
+        to_stream(stream, data.merge(at: 'start'))
+        begin
+          res = yield
+
+          to_stream(stream, data.merge(
+            at: 'finish', elapsed: (Time.now - start).to_f))
+          res
+        rescue
+          to_stream(stream, data.merge(
+            at: 'exception', elapsed: (Time.now - start).to_f))
+          raise $!
+        end
+      end
+    end
+
+    private
+      def request_context
+        RequestStore.store[:request_context] || {}
+      end
+
+      def unparse(attrs)
+        attrs.map { |k, v| unparse_pair(k, v) }.compact.join(" ")
+      end
+
+      def unparse_pair(k, v)
+        v = v.call if v.is_a?(Proc)
+        # only quote strings if they include whitespace
+        if v == nil
+          nil
+        elsif v == true
+          k
+        elsif v.is_a?(Float)
+          "#{k}=#{format("%.3f", v)}"
+        elsif v.is_a?(String) && v =~ /\s/
+          quote_string(k, v)
+        elsif v.is_a?(Time)
+          "#{k}=#{v.iso8601}"
+        else
+          "#{k}=#{v}"
+        end
+      end
+
+      def quote_string(k, v)
+        # try to find a quote style that fits
+        if !v.include?('"')
+          %{#{k}="#{v}"}
+        elsif !v.include?("'")
+          %{#{k}='#{v}'}
+        else
+          %{#{k}="#{v.gsub(/"/, '\\"')}"}
+        end
+      end
+  end
+end

data/lib/loggerator/loggerator.rb

@@ -1,22 +1,35 @@
-require_relative 'request_store'
-require_relative 'middleware'
+require "loggerator/log"
+require "loggerator/configuration"
+require "loggerator/request_store"
+require "loggerator/middleware"
 
 module Loggerator
-
   def self.included(mod)
     mod.extend self
   end
 
+  def self.config
+    @config ||= Configuration.new
+
+    return @config unless block_given?
+
+    yield(@config)
+  end
+
+  def self.config=(cfg)
+    @config = Configuration.new(cfg)
+  end
+
   def log(data, &block)
     Log.to_stream(Log.stdout, Log.contexts(data), &block)
   end
 
-  def log_error(e=$!, data = {})
-    exception_id = e.object_id
+  def log_error(error, data = {})
+    exception_id = error.object_id
 
     # Log backtrace in reverse order for easier digestion.
-    if e.backtrace
-      e.backtrace.reverse.each do |backtrace|
+    if error.backtrace
+      error.backtrace.reverse.each do |backtrace|
         Log.to_stream(Log.stderr, Log.contexts(
           exception_id: exception_id,
           backtrace:    backtrace
@@ -28,12 +41,12 @@ module Loggerator
     # a log trace as possible
     data.merge!(
       exception:    true,
-      class:        e.class.name,
-      message:      e.message,
+      class:        error.class.name,
+      message:      error.message,
       exception_id: exception_id
     )
 
-    data[:status] = e.status if e.respond_to?(:status)
+    data[:status] = error.status if error.respond_to?(:status)
 
     Log.to_stream(Log.stderr, Log.contexts(data))
   end
@@ -46,105 +59,4 @@ module Loggerator
     Log.local_context = old
     res
   end
-
-  # Don't expose internals into included modules so name-collisions are reduced
-  module Log
-    extend self
-
-    def default_context=(default_context)
-      @@default_context = default_context
-    end
-
-    def default_context
-      @@default_context ||= {}
-    end
-
-    def local_context
-      RequestStore.store[:local_context] ||= {}
-    end
-
-    def local_context=(h)
-      RequestStore.store[:local_context] = h
-    end
-
-    def stdout=(stream)
-      @@stdout = stream
-    end
-
-    def stdout
-      @@stdout ||= $stdout
-    end
-
-    def stderr=(stream)
-      @@stderr = stream
-    end
-
-    def stderr
-      @@stderr ||= $stderr
-    end
-
-    def contexts(data)
-      default_context.merge(request_context.merge(local_context.merge(data)))
-    end
-
-    def to_stream(stream, data, &block)
-      unless block
-        str = unparse(data)
-        stream.print(str + "\n")
-      else
-        data = data.dup
-        start = Time.now
-        to_stream(stream, data.merge(at: 'start'))
-        begin
-          res = yield
-
-          to_stream(stream, data.merge(
-            at: 'finish', elapsed: (Time.now - start).to_f))
-          res
-        rescue
-          to_stream(stream, data.merge(
-            at: 'exception', elapsed: (Time.now - start).to_f))
-          raise $!
-        end
-      end
-    end
-
-    private
-      def request_context
-        RequestStore.store[:request_context] || {}
-      end
-
-      def unparse(attrs)
-        attrs.map { |k, v| unparse_pair(k, v) }.compact.join(" ")
-      end
-
-      def unparse_pair(k, v)
-        v = v.call if v.is_a?(Proc)
-        # only quote strings if they include whitespace
-        if v == nil
-          nil
-        elsif v == true
-          k
-        elsif v.is_a?(Float)
-          "#{k}=#{format("%.3f", v)}"
-        elsif v.is_a?(String) && v =~ /\s/
-          quote_string(k, v)
-        elsif v.is_a?(Time)
-          "#{k}=#{v.iso8601}"
-        else
-          "#{k}=#{v}"
-        end
-      end
-
-      def quote_string(k, v)
-        # try to find a quote style that fits
-        if !v.include?('"')
-          %{#{k}="#{v}"}
-        elsif !v.include?("'")
-          %{#{k}='#{v}'}
-        else
-          %{#{k}="#{v.gsub(/"/, '\\"')}"}
-        end
-      end
-  end
 end

data/lib/loggerator/metrics.rb

@@ -1,34 +1,24 @@
-require_relative 'loggerator'
+require "loggerator"
 
 module Loggerator
   module Metrics
     include Loggerator
     extend self
 
-    @@metrics_name = 'loggerator'
-
-    def name=(name)
-      @@metrics_name = name
-    end
-
-    def name
-      @@metrics_name
-    end
-
     def count(key, value=1)
-      log("count##{name}.#{key}" => value)
+      log("count##{Loggerator.config.metrics_app_name}.#{key}" => value)
     end
 
     def sample(key, value)
-      log("sample##{name}.#{key}" => value)
+      log("sample##{Loggerator.config.metrics_app_name}.#{key}" => value)
     end
 
     def unique(key, value)
-      log("unique##{name}.#{key}" => value)
+      log("unique##{Loggerator.config.metrics_app_name}.#{key}" => value)
     end
 
-    def measure(key, value, units='s')
-      log("measure##{name}.#{key}" => "#{value}#{units}")
+    def measure(key, value, units="s")
+      log("measure##{Loggerator.config.metrics_app_name}.#{key}" => "#{value}#{units}")
     end
   end
 

data/lib/loggerator/middleware.rb

@@ -1,5 +1,5 @@
-require_relative 'middleware/request_store'
-require_relative 'middleware/request_id'
+require "loggerator/middleware/request_store"
+require "loggerator/middleware/request_id"
 
 module Loggerator
   module Middleware; end

data/lib/loggerator/namespace.rb

@@ -1,4 +1,4 @@
-require_relative 'loggerator'
+require "loggerator"
 
 module Loggerator
   module Namespace

data/lib/loggerator/rails.rb

@@ -1,22 +1,8 @@
-require_relative "loggerator"
+require "loggerator"
+require "loggerator/railtie/log_subscriber"
+require "loggerator/railtie/helper"
+require "loggerator/railtie/adapter"
 
 module Loggerator
-  class Railtie < Rails::Railtie
-
-    config.before_configuration do
-      Rails.application.middleware.insert_after ActionDispatch::RequestId, Loggerator::Middleware::RequestStore
-      Rails.application.middleware.swap         ActionDispatch::RequestId, Loggerator::Middleware::RequestID
-    end
-
-    config.before_initialize do
-      [ ActionView::Base,
-        ActiveRecord::Base,
-        ActionMailer::Base,
-        ActionController::Base ].each do |c|
-
-        c.include Loggerator
-      end
-    end
-
-  end
+  module Railtie; end
 end

data/lib/loggerator/railtie/adapter.rb

@@ -0,0 +1,24 @@
+module Loggerator
+  module Railtie
+    class Adapter < ::Rails::Railtie
+      config.before_configuration do
+        Rails.application.middleware.insert_after ActionDispatch::RequestId, Loggerator::Middleware::RequestStore
+        Rails.application.middleware.swap         ActionDispatch::RequestId, Loggerator::Middleware::RequestID
+      end
+
+      config.before_initialize do
+        [ ActionView::Base,
+          ActiveRecord::Base,
+          ActionMailer::Base,
+          ActionController::Base ].each do |c|
+
+          c.include Loggerator
+        end
+      end
+
+      config.after_initialize do
+        Loggerator::Railtie::Helper.setup(Rails.application)
+      end
+    end
+  end
+end

data/lib/loggerator/railtie/helper.rb

@@ -0,0 +1,48 @@
+module Loggerator
+  module Railtie
+    module Helper
+      # Implementation respectfully borrowed from:
+      # https://github.com/minefold/scrolls-rails
+      extend self
+
+      def setup(_app)
+        return unless subscribe?
+
+        detach_existing_subscribers
+        Loggerator::Railtie::LogSubscriber.attach_to(:action_controller)
+      end
+
+      def detach_existing_subscribers
+        ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+          case subscriber
+          when ActionView::LogSubscriber
+            unsubscribe(:action_view, subscriber)
+          when ActionController::LogSubscriber
+            unsubscribe(:action_controller, subscriber)
+          end
+        end
+      end
+
+      def subscribe?
+        !Loggerator.config.rails_default_subscribers
+      end
+
+      def unsubscribe(component, subscriber)
+        events = events_for_subscriber(subscriber)
+
+        events.each do |event|
+          notifier = ActiveSupport::Notifications.notifier
+          notifier.listeners_for("#{event}.#{component}").each do |listener|
+            if listener.instance_variable_get('@delegate') == subscriber
+              ActiveSupport::Notifications.unsubscribe(listener)
+            end
+          end
+        end
+      end
+
+      def events_for_subscriber(subscriber)
+        subscriber.public_methods(false).reject {|method| method.to_s == 'call' }
+      end
+    end
+  end
+end

data/lib/loggerator/railtie/log_subscriber.rb

@@ -0,0 +1,85 @@
+# Implementation respectfully borrowed from:
+# https://github.com/minefold/scrolls-rails
+require "loggerator"
+require "active_support/core_ext/class/attribute"
+require "active_support/log_subscriber"
+
+module Loggerator
+  module Railtie
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      include Loggerator
+
+      FIELDS = [:method, :path, :format, :controller, :action, :status,
+                :error, :duration, :view, :db, :location].freeze
+
+      def process_action(event)
+        exception = event.payload[:exception]
+        if exception.present?
+          # In Rails 3.2.9 event.payload[:exception] was changed from an
+          # Exception object to an Array containing the e.class.name and
+          # e.message. Adding handling for this case here.
+          if exception.is_a?(Array)
+            exception_class_name, exception_message = exception
+            exception = exception_class_name.constantize.new(exception_message)
+          end
+
+          self.log_error(exception, status: 500)
+        else
+          self.log(extract_request_data_from_event(event))
+        end
+      end
+
+      def redirect_to(event)
+        Thread.current[:scrolls_rails_location] = event.payload[:location]
+      end
+
+      private
+
+      def extract_request_data_from_event(event)
+        data          = extract_request(event.payload)
+        data[:status] = extract_status(event.payload)
+
+        data.merge!(runtimes(event))
+        data.merge!(location(event))
+      end
+
+      def extract_request(payload)
+        {
+          method:     payload[:method],
+          path:       payload[:path],
+          format:     payload[:format],
+          controller: payload[:params]["controller"],
+          action:     payload[:params]["action"]
+        }
+      end
+
+      def extract_status(payload)
+        if payload[:status]
+          payload[:status].to_i
+        else
+          0
+        end
+      end
+
+      def runtimes(event)
+        { duration: event.duration,
+          view:     event.payload[:view_runtime],
+          db:       event.payload[:db_runtime]
+        }.inject({}) do |runtimes, (name, runtime)|
+          runtimes[name] = runtime.to_f.round(2) if runtime
+          runtimes
+        end
+      end
+
+      def location(_event)
+        if location = Thread.current[:scrolls_rails_location]
+          Thread.current[:scrolls_rails_location] = nil
+
+          { location: location }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/test/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/test/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/test/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/test/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/test/loggerator/metrics_test.rb

@@ -0,0 +1,64 @@
+require_relative "../test_helper"
+require "loggerator/metrics"
+
+class TestLoggeratorMetrics < Minitest::Test
+  include Loggerator
+  include Loggerator::Metrics
+
+  def config
+    Loggerator.config
+  end
+
+  def test_name_equals
+    config.metrics_app_name = "test_name_equals"
+
+    assert_equal "test_name_equals", config.metrics_app_name
+  end
+
+  def test_name
+    config.metrics_app_name = "test_name"
+
+    assert_equal "test_name", self.name
+  end
+
+  def test_count
+    config.metrics_app_name = "test_count"
+    out, err = capture_subprocess_io do
+      self.count(:foo, 99)
+    end
+
+    assert_empty err
+    assert_match(/count#test_count\.foo=99/, out)
+  end
+
+  def test_sample
+    config.metrics_app_name = "test_sample"
+    out, err = capture_subprocess_io do
+      self.sample(:foo, :bar)
+    end
+
+    assert_empty err
+    assert_match(/sample#test_sample\.foo=bar/, out)
+  end
+
+  def test_unique
+    config.metrics_app_name = "test_unique"
+    out, err = capture_subprocess_io do
+      self.unique(:foo, :bar)
+    end
+
+    assert_empty err
+    assert_match(/unique#test_unique\.foo=bar/, out)
+  end
+
+  def test_measure
+    config.metrics_app_name = "test_measure"
+    out, err = capture_subprocess_io do
+      self.measure(:foo, 60, "ms")
+    end
+
+    assert_empty err
+    assert_match(/measure#test_measure\.foo=60ms/, out)
+  end
+end
+

data/test/loggerator/middleware/request_id_test.rb

@@ -1,9 +1,4 @@
-require 'rack/test'
-require 'minitest/mock'
-require 'minitest/autorun'
-require 'logger'
-
-require_relative '../../../lib/loggerator'
+require_relative "../../test_helper"
 
 class Loggerator::Middleware::TestRequestID < Minitest::Test
   include Rack::Test::Methods
@@ -13,21 +8,21 @@ class Loggerator::Middleware::TestRequestID < Minitest::Test
       use Rack::Lint
       use Loggerator::Middleware::RequestID
 
-      run ->(env) { [ 200, { }, [ 'hi' ] ] }
+      run ->(env) { [ 200, { }, [ "hi" ] ] }
     end
   end
 
   def test_sets_request_id
-    get '/'
+    get "/"
 
     assert_match ::Loggerator::Middleware::RequestID::UUID_PATTERN,
-      last_request.env['REQUEST_ID']
+      last_request.env["REQUEST_ID"]
   end
 
   def test_sets_request_ids
-    get '/'
+    get "/"
 
     assert_match ::Loggerator::Middleware::RequestID::UUID_PATTERN,
-      last_request.env['REQUEST_IDS'].first
+      last_request.env["REQUEST_IDS"].first
   end
 end

data/test/loggerator/middleware/request_store_test.rb

@@ -1,9 +1,4 @@
-require 'rack/test'
-require 'minitest/mock'
-require 'minitest/autorun'
-require 'logger'
-
-require_relative '../../../lib/loggerator'
+require_relative "../../test_helper"
 
 class Loggerator::Middleware::TestRequestStore < Minitest::Test
   include Rack::Test::Methods
@@ -13,14 +8,14 @@ class Loggerator::Middleware::TestRequestStore < Minitest::Test
       use Rack::Lint
       use Loggerator::Middleware::RequestStore
 
-      run ->(env) { [ 200, { }, [ 'hi' ] ] }
+      run ->(env) { [ 200, { }, [ "hi" ] ] }
     end
   end
 
   def test_clears_the_store
-    Thread.current[:request_store] = { something_added_before: 'bar' }
+    Thread.current[:request_store] = { something_added_before: "bar" }
 
-    get '/'
+    get "/"
 
     assert_nil Thread.current[:request_store][:something_added_before]
   end
@@ -28,7 +23,7 @@ class Loggerator::Middleware::TestRequestStore < Minitest::Test
   def test_seeds_the_store
     Thread.current[:request_store] = {}
 
-    get '/'
+    get "/"
 
     assert_equal Thread.current[:request_store], {
       request_id: nil,

data/test/loggerator/rails_test.rb

@@ -0,0 +1,60 @@
+require_relative "../test_helper"
+
+class TestLoggeratorRails < Minitest::Test
+  def test_middleware_modifications
+    # This ensures that the middlewares list includes our middlewares and that
+    # the default request id handler has been replaced.
+    middlewares = Rails.application.middleware
+
+    assert middlewares.include?(Loggerator::Middleware::RequestStore)
+    assert middlewares.include?(Loggerator::Middleware::RequestID)
+    refute middlewares.include?(ActionDispatch::RequestId)
+  end
+
+  def test_loggerator_included
+    # This ensures that Loggerator has been included in each of the classes below
+    # by checking to ensure that it's included in each classes "ancestors" list.
+    [ ActionView::Base,
+      ActiveRecord::Base,
+      ActionMailer::Base,
+      ActionController::Base
+    ].each do |c|
+      assert c.ancestors.include?(Loggerator)
+    end
+  end
+
+  def test_log_subscriber_attached
+    # This sets subscribers to a unique list of all log subscribers. Our
+    # LogSubscriber class should be included in this list.
+    subscribers = \
+      ActiveSupport::Notifications.notifier
+        .instance_variable_get("@subscribers")
+        .map { |subscriber|
+          subscriber.instance_variable_get("@delegate").class
+        }.uniq
+
+    assert subscribers.include?(Loggerator::Railtie::LogSubscriber)
+  end
+
+  def test_detach_existing_subscribers
+    # This sets subscribed_classes to the unique list of classes contstants
+    # which are currently subscribed to either "process_action.action_controller"
+    # or "redirect_to.action_controller". Given that only our LogSubscriber
+    # should be subscribed to these two events, only our LogSubscriber should
+    # be in the resulting list.
+    subscribed_classes = \
+      ActiveSupport::Notifications.notifier
+        .instance_variable_get("@subscribers")
+        .map { |subscriber|
+          subscriber.instance_variable_get("@delegate")
+        }.select { |delegate|
+          patterns = delegate.instance_variable_get("@patterns")
+          patterns && (
+            patterns.include?("process_action.action_controller") ||
+            patterns.include?("redirect_to.action_controller")
+          )
+        }.map(&:class).uniq
+
+    assert_equal subscribed_classes, [Loggerator::Railtie::LogSubscriber]
+  end
+end

data/test/loggerator/railtie/log_subscriber_test.rb

@@ -0,0 +1,44 @@
+require_relative "../../test_helper"
+
+class FakeEvent
+  attr_accessor :payload
+end
+
+class LoggeratorRailtieLogSubscriber < Minitest::Test
+  def setup
+    @sub = Loggerator::Railtie::LogSubscriber.new
+    @evt = FakeEvent.new
+  end
+
+  def test_process_action_with_array
+    out, err = capture_subprocess_io do
+      @evt.payload = {
+        exception: ["Exception", "Test array"]
+      }
+
+      @sub.process_action(@evt)
+    end
+
+    assert_empty(out)
+    assert_match(
+      /status=500 exception class=Exception message=\"Test array\" exception_id=\d+\n$/,
+      err
+    )
+  end
+
+  def test_process_action_with_exception
+    out, err = capture_subprocess_io do
+      @evt.payload = {
+        exception: Exception.new("Test exception")
+      }
+
+      @sub.process_action(@evt)
+    end
+
+    assert_empty(out)
+    assert_match(
+      /status=500 exception class=Exception message=\"Test exception\" exception_id=\d+\n$/,
+      err
+    )
+  end
+end

data/test/loggerator/request_store_test.rb

@@ -1,7 +1,4 @@
-require 'minitest/autorun'
-require 'logger'
-
-require_relative '../../lib/loggerator'
+require_relative "../test_helper"
 
 class Loggerator::TestRequestStore < Minitest::Test
   def setup
@@ -9,21 +6,21 @@ class Loggerator::TestRequestStore < Minitest::Test
     Thread.current[:request_store] = {}
 
     @env = {
-      'REQUEST_ID' => 'abc',
-      'REQUEST_IDS' => %w[ abc def ]
+      "REQUEST_ID" => "abc",
+      "REQUEST_IDS" => %w[ abc def ]
     }
   end
 
   def test_seeds_request_id
     Loggerator::RequestStore.seed(@env)
 
-    assert_equal 'abc,def', Loggerator::RequestStore.store[:request_id]
+    assert_equal "abc,def", Loggerator::RequestStore.store[:request_id]
   end
 
   def test_seeds_request_context
     Loggerator::RequestStore.seed(@env)
 
-    assert_equal 'abc,def', Loggerator::RequestStore.store[:request_context][:request_id]
+    assert_equal "abc,def", Loggerator::RequestStore.store[:request_context][:request_id]
   end
 
   def test_is_cleared_by_clear!

data/test/loggerator_test.rb

@@ -1,16 +1,44 @@
-require 'minitest/autorun'
-require 'logger'
-
-require_relative '../lib/loggerator'
+require_relative "test_helper"
 
 class TestLoggerator < Minitest::Test
   include Loggerator
+  include Loggerator::Log
 
   def setup
     # flush request store
     Thread.current[:request_store] = {}
 
-    self.default_context = {}
+    Loggerator.config.default_context = {}
+  end
+
+  def test_config_from_block
+    Loggerator.config do |c|
+      c.default_context = { foo: :bar }
+      c.metrics_app_name = "foo_bar"
+      c.rails_default_subscribers = true
+    end
+
+    expected = {
+      default_context: { foo: :bar },
+      metrics_app_name: "foo_bar",
+      rails_default_subscribers: true
+    }
+
+    assert_equal expected, Loggerator.config.to_h
+  end
+
+  def test_config_from_hash
+    expected = {
+      default_context: { foo: :bar },
+      metrics_app_name: "foo_bar",
+      rails_default_subscribers: true
+    }
+
+    refute_equal expected, Loggerator.config.to_h
+
+    Loggerator.config = expected
+
+    assert_equal expected, Loggerator.config.to_h
   end
 
   def test_logs_in_structured_format
@@ -41,7 +69,7 @@ class TestLoggerator < Minitest::Test
 
   def test_merges_default_context_with_eq
     # testing both methods
-    self.default_context = { app: 'my_app' }
+    Loggerator.config.default_context = { app: "my_app" }
 
     out, _ = capture_subprocess_io do
       log(foo: 'bar')
@@ -62,7 +90,7 @@ class TestLoggerator < Minitest::Test
 
   def test_log_context_merged_with_default_context
     out, _ = capture_subprocess_io do
-      self.default_context = { app: 'my_app' }
+      Loggerator.config.default_context = { app: 'my_app' }
       self.log_context(foo: 'bar') do
         log(bah: 'boo')
       end
@@ -70,4 +98,29 @@ class TestLoggerator < Minitest::Test
 
     assert_equal out, "app=my_app foo=bar bah=boo\n"
   end
+
+  def test_log_error
+    _, err = capture_subprocess_io do
+      begin
+        raise "an error"
+      rescue => ex
+        self.log_error(ex, foo: :bar_bah_boo)
+      end
+    end
+
+    assert_match(/message="an error"/, err)
+    assert_match(/foo=bar_bah_boo/, err)
+  end
+
+  def test_log_error_without_data
+    _, err = capture_subprocess_io do
+      begin
+        raise "another error"
+      rescue => ex
+        self.log_error(ex)
+      end
+    end
+
+    assert_match(/message="another error"/, err)
+  end
 end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+# like running `ruby -W0`
+$VERBOSE = nil
+
+require "rack/test"
+require "minitest/mock"
+require "minitest/autorun"
+require "pry"
+require "pp"
+
+require "logger"
+
+require "combustion"
+Combustion.path = "test/internal"
+Combustion.initialize! :all
+
+# Unfreeze rails middleware
+Rails.application.middleware.instance_variable_set(:@middlewares,
+  Rails.application.middleware.instance_variable_get(:@middlewares).dup)
+
+require "loggerator"
+require "loggerator/rails"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggerator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - Joshua Mervine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies: []
 description: Simple web application extension for logging, following the 12factor
   pattern.
@@ -23,6 +23,8 @@ files:
 - lib/generators/loggerator/log_generator.rb
 - lib/generators/templates/log.rb.erb
 - lib/loggerator.rb
+- lib/loggerator/configuration.rb
+- lib/loggerator/log.rb
 - lib/loggerator/loggerator.rb
 - lib/loggerator/metrics.rb
 - lib/loggerator/middleware.rb
@@ -30,12 +32,24 @@ files:
 - lib/loggerator/middleware/request_store.rb
 - lib/loggerator/namespace.rb
 - lib/loggerator/rails.rb
+- lib/loggerator/railtie/adapter.rb
+- lib/loggerator/railtie/helper.rb
+- lib/loggerator/railtie/log_subscriber.rb
 - lib/loggerator/request_store.rb
 - lib/loggerator/test.rb
+- test/internal/config/database.yml
+- test/internal/config/routes.rb
+- test/internal/db/schema.rb
+- test/internal/log/.gitignore
+- test/internal/public/favicon.ico
+- test/loggerator/metrics_test.rb
 - test/loggerator/middleware/request_id_test.rb
 - test/loggerator/middleware/request_store_test.rb
+- test/loggerator/rails_test.rb
+- test/loggerator/railtie/log_subscriber_test.rb
 - test/loggerator/request_store_test.rb
 - test/loggerator_test.rb
+- test/test_helper.rb
 homepage: https://github.com/heroku/loggerator
 licenses:
 - MIT
@@ -61,7 +75,16 @@ signing_key:
 specification_version: 4
 summary: 'loggerator: A Log Helper'
 test_files:
+- test/internal/config/database.yml
+- test/internal/config/routes.rb
+- test/internal/db/schema.rb
+- test/internal/log/.gitignore
+- test/internal/public/favicon.ico
+- test/loggerator/metrics_test.rb
 - test/loggerator/middleware/request_id_test.rb
 - test/loggerator/middleware/request_store_test.rb
+- test/loggerator/rails_test.rb
+- test/loggerator/railtie/log_subscriber_test.rb
 - test/loggerator/request_store_test.rb
 - test/loggerator_test.rb
+- test/test_helper.rb