epilog 0.2.0

data/lib/epilog/rails/action_mailer_subscriber.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Rails
+    class ActionMailerSubscriber < LogSubscriber
+      def deliver(event)
+        info do
+          hash(
+            event,
+            message: 'Sent mail',
+            recipients: Array(event.payload[:to])
+          )
+        end
+      end
+
+      def receive(event)
+        info do
+          hash(
+            event,
+            message: 'Received mail'
+          )
+        end
+      end
+
+      def process(event)
+        debug do
+          hash(
+            event,
+            message: 'Processed outbound mail',
+            mailer: event.payload[:mailer],
+            action: event.payload[:action]
+          )
+        end
+      end
+
+      private
+
+      def hash(event, attrs = {})
+        if logger.debug? && event.payload[:mail]
+          attrs[:body] = event.payload[:mail]
+        end
+
+        attrs[:metrics] = { duration: event.duration.round(2) }
+        attrs
+      end
+    end
+  end
+end

data/lib/epilog/rails/action_view_subscriber.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Rails
+    class ActionViewSubscriber < LogSubscriber
+      def render_template(event)
+        info { hash(event, 'Rendered template') }
+      end
+
+      def render_partial(event)
+        info { hash(event, 'Rendered partial') }
+      end
+
+      def render_collection(event)
+        info { hash(event, 'Rendered collection') }
+      end
+
+      private
+
+      def hash(event, message)
+        {
+          message: message,
+          template: fix_path(event.payload[:identifier]),
+          layout: fix_path(event.payload[:layout]),
+          metrics: {
+            duration: event.duration.round(2)
+          }
+        }
+      end
+
+      def fix_path(template)
+        return if template.nil?
+
+        base = File.join(::Rails.root, 'app', 'views', '')
+        pattern = /^#{Regexp.escape(base)}/
+        template.gsub(pattern, '')
+      end
+    end
+  end
+end

data/lib/epilog/rails/active_job_subscriber.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Rails
+    class ActiveJobSubscriber < LogSubscriber
+      def enqueue(event)
+        info { event_hash('Enqueued job', event) }
+      end
+
+      def enqueue_at(event)
+        enqueue(event)
+      end
+
+      def perform_start(event)
+        info { event_hash('Performing job', event) }
+      end
+
+      def perform(event)
+        info do
+          event_hash('Performed job', event).merge(
+            metrics: {
+              job_runtime: event.duration
+            }
+          )
+        end
+      end
+
+      private
+
+      def event_hash(message, event)
+        {
+          message: message,
+          job: job_hash(event.payload[:job]),
+          adapter: adapter_name(event.payload[:adapter])
+        }
+      end
+
+      def job_hash(job)
+        {
+          class: job.class.name,
+          id: job.job_id,
+          queue: job.queue_name,
+          arguments: job.arguments,
+          scheduled_at: job.scheduled_at ? format_time(job.scheduled_at) : nil
+        }
+      end
+
+      def format_time(time)
+        Time.at(time).utc.strftime(Epilog::Formatter::DEFAULT_TIME_FORMAT)
+      end
+
+      def adapter_name(adapter)
+        adapter = adapter.class unless adapter.is_a?(Class)
+        adapter.name
+      end
+    end
+  end
+end

data/lib/epilog/rails/active_record_subscriber.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Rails
+    class ActiveRecordSubscriber < LogSubscriber
+      IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
+
+      def sql(event)
+        ActiveRecord::LogSubscriber.runtime += event.duration
+
+        return unless logger.debug?
+
+        payload = event.payload
+        return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+        debug(
+          message: payload[:name],
+          sql: payload[:sql],
+          binds: binds_info(payload[:binds] || []),
+          metrics: metrics(event)
+        )
+      end
+
+      private
+
+      def metrics(event)
+        {
+          query_runtime: event.duration.round(2)
+        }
+      end
+
+      def binds_info(binds)
+        binds.map do |bind|
+          if bind.is_a?(Array)
+            bind_column_info(*bind)
+          else
+            bind_attr_info(bind)
+          end
+        end
+      end
+
+      def bind_column_info(column, value)
+        info = { type: column.type, name: column.name }
+        if column.binary?
+          info[:bytes] = value.bytesize
+        else
+          info[:value] = value
+        end
+        info
+      end
+
+      def bind_attr_info(attr)
+        info = { type: attr.type.type, name: attr.name }
+        if attr.type.binary? && attr.value
+          info[:bytes] = attr.value_for_database.to_s.bytesize
+        else
+          info[:value] = attr.value_for_database
+        end
+        info
+      end
+    end
+  end
+end

data/lib/epilog/rails/epilog_ext.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Epilog
+  class Logger
+    include LoggerSilence
+
+    def silencer
+      false
+    end
+  end
+end

data/lib/epilog/rails/ext/action_controller.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Epilog
+  module ActionControllerExt
+    def process_action(*)
+      epilog_instrument('request_received')
+      epilog_instrument('process_request') do |payload|
+        begin
+          super
+        ensure
+          payload[:response] = response
+          payload[:metrics] = epilog_metrics
+        end
+      end
+    end
+
+    private
+
+    def epilog_instrument(name, &block)
+      ActiveSupport::Notifications.instrument(
+        "#{name}.action_controller",
+        epilog_payload,
+        &block
+      )
+    end
+
+    def epilog_payload
+      {
+        request: request,
+        response: response,
+        controller: self.class.name,
+        action: action_name
+      }
+    end
+
+    def epilog_metrics
+      {
+        db_runtime: try(:db_runtime),
+        view_runtime: view_runtime
+      }
+    end
+  end
+end
+
+ActionController::Base.prepend(Epilog::ActionControllerExt)

data/lib/epilog/rails/ext/active_support_logger.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  class Logger
+    # Rails uses this method to attach additional loggers to the main
+    # Rails.logger object when using the rails console or server. This results
+    # in extra unformatted log output in those cases. Prevent that by
+    # overriding the method with a stub. Examples can be found in
+    #
+    # - railties/lib/rails/commands/server.rb
+    # - active_record/lib/active_record/railtie.rb
+    def self.broadcast(*_args)
+      Module.new
+    end
+  end
+end

data/lib/epilog/rails/ext/debug_exceptions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  class DebugExceptions
+    private
+
+    def log_error(env, wrapper)
+      logger = logger(env)
+      return unless logger.is_a?(Epilog::Logger)
+
+      if wrapper.status_code == 500
+        logger.fatal(wrapper.exception)
+      else
+        logger.warn(wrapper.exception)
+      end
+    end
+  end
+end

data/lib/epilog/rails/ext/event_delegate.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Epilog
+  module EventDelegateExt
+    # Rails has no public API to determine the delegate for an event
+    # object. Add this method to allow checking if the delegate matches
+    # a given object.
+    def delegates_to?(delegate)
+      @delegate == delegate
+    end
+  end
+end
+
+ActiveSupport::Notifications::Fanout::Subscribers::Evented.include(
+  Epilog::EventDelegateExt
+)

data/lib/epilog/rails/ext/rack_logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rails
+  module Rack
+    class Logger
+      # The Rails rack logger extension adds unformatted log output with
+      # duplicate information. Disable those logs completely.
+      def logger
+        @logger ||= ::Logger.new(nil)
+      end
+    end
+  end
+end

data/lib/epilog/rails/log_subscriber.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Rails
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      attr_reader :logger
+
+      def initialize(logger)
+        super()
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/epilog/rails/railtie.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Rails
+    class Railtie < ::Rails::Railtie
+      SUBSCRIBERS = {
+        action_controller: ActionControllerSubscriber,
+        action_mailer: ActionMailerSubscriber,
+        action_view: ActionViewSubscriber,
+        active_record: ActiveRecordSubscriber,
+        active_job: ActiveJobSubscriber
+      }.freeze
+
+      SUBSCRIBER_BLACKLIST = [
+        ActionController::LogSubscriber,
+        ActionMailer::LogSubscriber,
+        ActionView::LogSubscriber,
+        ActiveRecord::LogSubscriber,
+        ActiveJob::Logging::LogSubscriber
+      ].freeze
+
+      config.epilog = ActiveSupport::OrderedOptions.new
+      config.epilog.subscriptions = %i[
+        action_controller
+        action_mailer
+        action_view
+        active_record
+        active_job
+      ]
+
+      initializer 'epilog.configure' do |app|
+        disable_rails_defaults
+
+        ::Rails.logger ||= Logger.new($stdout)
+
+        app.config.epilog.subscriptions.each do |namespace|
+          subscriber_class = SUBSCRIBERS[namespace]
+          subscriber_class.attach_to(
+            namespace,
+            subscriber_class.new(::Rails.logger)
+          )
+        end
+      end
+
+      private
+
+      def disable_rails_defaults
+        blacklisted_subscribers.each do |subscriber|
+          subscriber.patterns.each do |pattern|
+            unsubscribe_listeners(subscriber, pattern)
+          end
+        end
+      end
+
+      def unsubscribe_listeners(subscriber, pattern)
+        notifier = ActiveSupport::Notifications.notifier
+        notifier.listeners_for(pattern).each do |listener|
+          if listener.delegates_to?(subscriber)
+            ActiveSupport::Notifications.unsubscribe(listener)
+          end
+        end
+      end
+
+      def blacklisted_subscribers
+        ActiveSupport::LogSubscriber.log_subscribers.select do |subscriber|
+          SUBSCRIBER_BLACKLIST.include?(subscriber.class)
+        end
+      end
+    end
+  end
+end

data/lib/epilog/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Epilog
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: epilog
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Justin Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: 
+email:
+- jmhoward0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check-version
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/yard
+- bin/yardoc
+- bin/yri
+- epilog.gemspec
+- lib/epilog.rb
+- lib/epilog/filter.rb
+- lib/epilog/filter/blacklist.rb
+- lib/epilog/filter/hash_key.rb
+- lib/epilog/log_formatter.rb
+- lib/epilog/logger.rb
+- lib/epilog/mock_logger.rb
+- lib/epilog/rails.rb
+- lib/epilog/rails/action_controller_subscriber.rb
+- lib/epilog/rails/action_mailer_subscriber.rb
+- lib/epilog/rails/action_view_subscriber.rb
+- lib/epilog/rails/active_job_subscriber.rb
+- lib/epilog/rails/active_record_subscriber.rb
+- lib/epilog/rails/epilog_ext.rb
+- lib/epilog/rails/ext/action_controller.rb
+- lib/epilog/rails/ext/active_support_logger.rb
+- lib/epilog/rails/ext/debug_exceptions.rb
+- lib/epilog/rails/ext/event_delegate.rb
+- lib/epilog/rails/ext/rack_logger.rb
+- lib/epilog/rails/log_subscriber.rb
+- lib/epilog/rails/railtie.rb
+- lib/epilog/version.rb
+homepage: https://github.com/machinima/epilog
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: A JSON logger with Rails support
+test_files: []