epilog 0.2.0

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/yard

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/bin/yri

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/epilog.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epilog/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'epilog'
+  spec.version = Epilog::VERSION
+  spec.authors = ['Justin Howard']
+  spec.email = ['jmhoward0@gmail.com']
+  spec.license = 'Apache-2.0'
+
+  spec.summary = 'A JSON logger with Rails support'
+  spec.homepage = 'https://github.com/machinima/epilog'
+
+  spec.files = `git ls-files -z`
+    .split("\x0")
+    .reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'combustion', '~> 1.0.0'
+  spec.add_development_dependency 'rails', '>= 4.2', '< 6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec-rails', '~> 3.8.1'
+  spec.add_development_dependency 'rubocop', '~> 0.61'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'yard', '~> 0.9.11'
+end

data/lib/epilog.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require 'epilog/version'
+require 'epilog/logger'
+require 'epilog/mock_logger'
+require 'epilog/log_formatter'
+require 'epilog/filter'
+require 'epilog/rails' if defined?(Rails)

data/lib/epilog/filter.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'epilog/filter/hash_key'
+require 'epilog/filter/blacklist'

data/lib/epilog/filter/blacklist.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Filter
+    class Blacklist < HashKey
+      DEFAULT_BLACKLIST = %w[
+        password
+        pass
+        pw
+        secret
+      ].freeze
+
+      attr_reader :blacklist
+
+      def initialize(blacklist = DEFAULT_BLACKLIST)
+        @blacklist = Hash[blacklist.map { |b| [b.to_s.downcase, nil] }]
+      end
+
+      private
+
+      def key?(key)
+        @blacklist.key?(key.to_s.downcase)
+      end
+
+      def filter(value)
+        "[filtered #{value.class.name}]"
+      end
+    end
+  end
+end

data/lib/epilog/filter/hash_key.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Filter
+    class HashKey
+      def call(log)
+        fix(log)
+      end
+
+      private
+
+      def fix(value)
+        if value.is_a?(Hash)
+          fix_hash(value)
+        elsif value.is_a?(Array)
+          value.map { |i| fix(i) }
+        else
+          value
+        end
+      end
+
+      def fix_hash(hash)
+        hash.each_with_object({}) do |(key, value), obj|
+          obj[key] = if key?(key)
+            filter(value)
+          else
+            fix(value)
+          end
+        end
+      end
+
+      def key?(_key)
+        true
+      end
+
+      def filter(value)
+        "[filtered #{value.class.name}]"
+      end
+    end
+  end
+end

data/lib/epilog/log_formatter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Epilog
+  class Formatter
+    SEVERITY_MAP = {
+      'FATAL' => 'ALERT',
+      'WARN' => 'WARNING'
+    }.freeze
+
+    DEFAULT_TIME_FORMAT = '%Y-%m-%dT%H:%M:%S%z'
+
+    attr_reader :filter
+    attr_writer :datetime_format
+
+    def initialize(options = {})
+      @filter = options[:filter] || Filter::Blacklist.new
+    end
+
+    def call(severity, time, progname, msg)
+      log = base_log(severity, time, progname)
+      log.merge!(message(msg))
+
+      if log[:exception].is_a?(Exception)
+        log[:exception] = format_error(log[:exception])
+      end
+
+      log = before_write(log)
+      "#{JSON.dump(log)}\n"
+    end
+
+    def datetime_format
+      @datetime_format || DEFAULT_TIME_FORMAT
+    end
+
+    private
+
+    def base_log(severity, time, progname)
+      {
+        timestamp: time.strftime(datetime_format),
+        severity: SEVERITY_MAP[severity] || severity,
+        source: progname
+      }
+    end
+
+    def message(msg)
+      return { message: msg.message, exception: msg } if msg.is_a?(Exception)
+      return msg.to_h if msg.respond_to?(:to_h)
+
+      { message: msg.to_s }
+    end
+
+    def format_error(error)
+      hash = {
+        name: error.class.name,
+        message: error.message,
+        trace: error.backtrace
+      }
+      cause = error.cause
+      hash[:parent] = format_error(cause) unless cause.nil?
+      hash
+    end
+
+    def before_write(log)
+      @filter ? @filter.call(log) : log
+    end
+  end
+end

data/lib/epilog/logger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Epilog
+  class Logger < ::Logger
+    def initialize(*args, **options)
+      super
+      self.formatter = Formatter.new
+    end
+
+    def datetime_format
+      return unless formatter
+
+      formatter.datetime_format
+    end
+
+    def datetime_format=(format)
+      return unless formatter
+
+      formatter.datetime_format = format
+    end
+  end
+end

data/lib/epilog/mock_logger.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Epilog
+  class MockLogger < ::Logger
+    def initialize
+      super(nil)
+      reset
+    end
+
+    # rubocop:disable MethodLength
+    def add(severity, message = nil, progname = nil)
+      severity ||= Logger::UNKNOWN
+      return true if severity < level
+
+      prog ||= progname
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = prog
+          prog = progname
+        end
+      end
+
+      write(format_severity(severity), current_time, prog, message)
+    end
+    # rubocop:enable MethodLength
+    alias log add
+
+    def reopen(_logdev = nil)
+    end
+
+    def [](index)
+      @logs[index].dup || []
+    end
+
+    def to_a
+      (0...@logs.size).map { |i| self[i] }
+    end
+
+    def freeze_time(time)
+      @time = time
+    end
+
+    def reset
+      @logs = []
+    end
+
+    private
+
+    def current_time
+      @time || Time.now
+    end
+
+    def write(severity, time, prog, message)
+      @logs << [severity, time, prog, message]
+    end
+  end
+end

data/lib/epilog/rails.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'action_controller/log_subscriber'
+require 'action_dispatch/middleware/debug_exceptions'
+require 'action_mailer/log_subscriber'
+require 'action_view/log_subscriber'
+require 'active_record/log_subscriber'
+require 'active_job/logging'
+
+require 'epilog/rails/ext/event_delegate'
+require 'epilog/rails/ext/active_support_logger'
+require 'epilog/rails/ext/rack_logger'
+require 'epilog/rails/ext/action_controller'
+require 'epilog/rails/ext/debug_exceptions'
+
+require 'epilog/rails/epilog_ext'
+require 'epilog/rails/log_subscriber'
+require 'epilog/rails/action_controller_subscriber'
+require 'epilog/rails/action_mailer_subscriber'
+require 'epilog/rails/action_view_subscriber'
+require 'epilog/rails/active_record_subscriber'
+require 'epilog/rails/active_job_subscriber'
+require 'epilog/rails/railtie'

data/lib/epilog/rails/action_controller_subscriber.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+# rubocop:disable ClassLength
+module Epilog
+  module Rails
+    class ActionControllerSubscriber < LogSubscriber
+      RAILS_PARAMS = %i[controller action format _method only_path].freeze
+
+      def request_received(event)
+        info do
+          {
+            message: "#{request_string(event)} started",
+            request: request_hash(event)
+          }
+        end
+      end
+
+      def process_request(event)
+        info do
+          {
+            message: response_string(event),
+            request: short_request_hash(event),
+            response: response_hash(event),
+            metrics: process_metrics(event.payload[:metrics]
+              .merge(request_runtime: event.duration.round(2)))
+          }
+        end
+      end
+
+      def start_processing(*)
+      end
+
+      def process_action(*)
+      end
+
+      def send_data(event)
+        info { basic_message(event, "Sent data #{event.payload[:filename]}") }
+      end
+
+      def send_file(event)
+        info { basic_message(event, "Sent file #{event.payload[:path]}") }
+      end
+
+      def redirect_to(event)
+        info { basic_message(event, "Redirect > #{event.payload[:location]}") }
+      end
+
+      def halted_callback(event)
+        info do
+          basic_message(event, 'Filter chain halted as ' \
+            "#{event.payload[:filter].inspect} rendered or redirected")
+        end
+      end
+
+      def unpermitted_parameters(event)
+        debug do
+          basic_message(event, 'Unpermitted parameters: ' \
+            "#{event.payload[:keys].join(', ')}")
+        end
+      end
+
+      %i[
+        write_fragment
+        read_fragment
+        exist_fragment?
+        expire_fragment
+        expire_page
+        write_page
+      ].each do |method|
+        define_method(method) do |event|
+          return unless logger.info?
+
+          path = Array(event.payload[:key] || event.payload[:path]).join('/')
+          debug(basic_message(event, "#{method} #{path}"))
+        end
+      end
+
+      private
+
+      def request_hash(event) # rubocop:disable AbcSize, MethodLength
+        request = event.payload[:request]
+        {
+          id: request.uuid,
+          ip: request.remote_ip,
+          host: request.host,
+          protocol: request.protocol.to_s.gsub('://', ''),
+          method: request.request_method,
+          port: request.port,
+          path: request.fullpath,
+          query: request.query_parameters,
+          cookies: request.cookies,
+          headers: request.headers.to_h.keep_if do |key, _value|
+            key =~ ActionDispatch::Http::Headers::HTTP_HEADER
+          end,
+          params: request.filtered_parameters.except(*RAILS_PARAMS),
+          format: request.format.try(:ref),
+          controller: event.payload[:controller],
+          action: event.payload[:action]
+        }
+      end
+
+      def short_request_hash(event)
+        request = event.payload[:request]
+        {
+          id: request.uuid,
+          method: request.method,
+          path: request.fullpath
+        }
+      end
+
+      def request_string(event)
+        request = event.payload[:request]
+        "#{request.request_method} #{request.fullpath}"
+      end
+
+      def response_hash(event)
+        { status: normalize_status(event) }
+      end
+
+      def response_string(event)
+        status = normalize_status(event)
+        status_string = Rack::Utils::HTTP_STATUS_CODES[status]
+        "#{request_string(event)} > #{status} #{status_string}"
+      end
+
+      def normalize_status(event)
+        payload = event.payload
+        status = payload[:response].status
+        if status.nil? && payload[:exception].present?
+          status = ActionDispatch::ExceptionWrapper
+            .status_code_for_exception(payload[:exception].first)
+        end
+        status
+      end
+
+      def basic_message(event, message)
+        {
+          message: message,
+          metrics: process_metrics(duration: event.duration)
+        }
+      end
+
+      def process_metrics(metrics)
+        metrics.each_with_object({}) do |(key, value), obj|
+          next if value.nil?
+
+          obj[key] = value.round(2) if value.is_a?(Numeric)
+        end
+      end
+    end
+  end
+end
+# rubocop:enable ClassLength