epilog 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c73f8fcac8b47000824334dce31d8b781aa5e730201f2e67816c4c395cbe3966
-  data.tar.gz: 7f45a7801cb9a815cb576c39de3fb49c09f6b928e7cc2f2b1b50435df548d0e1
+  metadata.gz: 26a731d5297bcf87056341855af05c6c57b18fbb29115a0dcc3d00b1c2a9086e
+  data.tar.gz: 032c613192e81a8c4b97993b1f42c7d100272c16b1a4457f1df9a9afb54a84b6
 SHA512:
-  metadata.gz: ff73c27fe2100ffc880d689196fc4deed995c3e2978f4d01412bdd63ec7b73de3e11903af43570a0ca29a5040fec275d6a4fad0cbfdf2d0d41bd01da11469045
-  data.tar.gz: 34bb7195d88534537637e43a729314ba6439f3e40a4c150c33c46c0bb0aa41e9bf544e0f0d47e10cff534c7e71877b53206b5f928c412e9337da471846a34b75
+  metadata.gz: 44373cd845a4114af0b41654265f697c0bc2ab9584342d1b5c40de4a539e1228608ac1d548bf14150c24ddaa6987c272601f402453dac1ff0356a23a65cd8bd8
+  data.tar.gz: e654189bc9d0431e165c0d948f234972171f16c016260ba287e05cf5f268f5802e30fedf02884d5699ff49241548eab5b3d46f7065e836988a37cace563c476e

data/.rubocop.yml

@@ -2,24 +2,30 @@
 AllCops:
   TargetRubyVersion: 2.3
 
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+
 Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
 Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
-Layout/IndentArray:
+Layout/IndentFirstArgument:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
-Style/Documentation:
-  Enabled: false
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
+Style/Documentation:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: true
   EnforcedStyle: always

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## 0.6.0
+
+- Add support for Rails 5 API-only controllers [#17](https://github.com/machinima/epilog/pull/17)
+
+## 0.5.0
+
+- Add options to enable/disable start and end logs [#15](https://github.com/machinima/epilog/pull/15)
+- Fix with_context to use ensure [#16](https://github.com/machinima/epilog/pull/16)
+
+## 0.4.0
+
+- Add context support to Logger [#12](https://github.com/machinima/epilog/pull/12)
+
+## 0.3.1
+
+- Add context to request log [#10](https://github.com/machinima/epilog/pull/10)
+
+## 0.3
+
+- Update development dependencies [#1](https://github.com/machinima/epilog/pull/1)
+- Allow controllers to add context to logs [#2](https://github.com/machinima/epilog/pull/2)
+- Fix removing Rails default parameters when filter_parameters are set [#4](https://github.com/machinima/epilog/pull/4)
+- Add a filter using Rails filter_parameters [#3](https://github.com/machinima/epilog/pull/3)
+- Change action view logs to DEBUG [#5](https://github.com/machinima/epilog/pull/5)
+- Filter all request data using filter_parameters [#6](https://github.com/machinima/epilog/pull/6)
+
+## 0.2
+
+Initial public release

data/epilog.gemspec

@@ -19,16 +19,17 @@ Gem::Specification.new do |spec|
     .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 'bundler', '>= 1.12'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'combustion', '~> 1.1.0'
+  spec.add_development_dependency 'irb'
   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 'rake', '~> 13.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
   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 'rubocop', '0.75'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'sqlite3', '~> 1.3', '< 1.4'
   spec.add_development_dependency 'yard', '~> 0.9.11'
 end

data/lib/epilog.rb

@@ -3,6 +3,7 @@
 require 'logger'
 
 require 'epilog/version'
+require 'epilog/context_logging'
 require 'epilog/logger'
 require 'epilog/mock_logger'
 require 'epilog/log_formatter'

data/lib/epilog/context_logging.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Epilog
+  module ContextLogger
+    def with_context(context)
+      push_context(context)
+      yield
+    ensure
+      pop_context
+    end
+
+    def push_context(context)
+      formatter.push_context(context)
+    end
+
+    def pop_context
+      formatter.pop_context
+    end
+  end
+
+  module ContextFormatter
+    def context
+      Thread.current[current_context_key] ||= begin
+        result = {}
+        context_stack.each { |frame| result.merge!(frame) }
+        result
+      end.freeze
+    end
+
+    def push_context(frame)
+      clear_context
+      context_stack.push(frame)
+    end
+
+    def pop_context
+      clear_context
+      context_stack.pop
+    end
+
+    private
+
+    def clear_context
+      Thread.current[current_context_key] = nil
+    end
+
+    def context_stack
+      Thread.current[stack_key] ||= []
+    end
+
+    def stack_key
+      @stack_key ||= "epilog_context_stack:#{object_id}"
+    end
+
+    def current_context_key
+      @current_context_key ||= "epilog_context_current:#{object_id}"
+    end
+  end
+end

data/lib/epilog/filter.rb

@@ -2,3 +2,4 @@
 
 require 'epilog/filter/hash_key'
 require 'epilog/filter/blacklist'
+require 'epilog/filter/filter_parameters'

data/lib/epilog/filter/filter_parameters.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Epilog
+  module Filter
+    class FilterParameters < Blacklist
+      private
+
+      def filter_parameters
+        return @filter_parameters if @filter_parameters
+
+        filtered = Hash[
+          ::Rails.application.config.filter_parameters.map do |p|
+            [p.to_s.downcase, true]
+          end
+        ]
+
+        @filter_parameters = filtered if ::Rails.initialized?
+        filtered
+      end
+
+      def key?(key)
+        filter_parameters.key?(key.to_s.downcase)
+      end
+    end
+  end
+end

data/lib/epilog/log_formatter.rb

@@ -2,6 +2,8 @@
 
 module Epilog
   class Formatter
+    include ContextFormatter
+
     SEVERITY_MAP = {
       'FATAL' => 'ALERT',
       'WARN' => 'WARNING'
@@ -18,6 +20,7 @@ module Epilog
 
     def call(severity, time, progname, msg)
       log = base_log(severity, time, progname)
+      log.merge!(context)
       log.merge!(message(msg))
 
       if log[:exception].is_a?(Exception)

data/lib/epilog/logger.rb

@@ -2,6 +2,8 @@
 
 module Epilog
   class Logger < ::Logger
+    include ContextLogger
+
     def initialize(*args, **options)
       super
       self.formatter = Formatter.new

data/lib/epilog/mock_logger.rb

@@ -2,8 +2,8 @@
 
 module Epilog
   class MockLogger < ::Logger
-    def initialize
-      super(nil)
+    def initialize(**options)
+      super(nil, **options)
       reset
     end
 
@@ -44,6 +44,21 @@ module Epilog
 
     def reset
       @logs = []
+      @context = []
+    end
+
+    def with_context(context)
+      push_context(context)
+      yield
+      pop_context
+    end
+
+    def push_context(context)
+      @context << context
+    end
+
+    def pop_context
+      @context.pop
     end
 
     private
@@ -53,7 +68,7 @@ module Epilog
     end
 
     def write(severity, time, prog, message)
-      @logs << [severity, time, prog, message]
+      @logs << [severity, time, prog, message, @context.dup]
     end
   end
 end

data/lib/epilog/rails/action_controller_subscriber.rb

@@ -7,24 +7,17 @@ module Epilog
       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
+        push_context(
+          { request: short_request_hash(event) }
+          .merge(event.payload[:context])
+        )
+
+        log_start(event) if config.double_request_logs
       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
+        log_end(event)
+        pop_context
       end
 
       def start_processing(*)
@@ -77,8 +70,37 @@ module Epilog
 
       private
 
+      def log_start(event)
+        info do
+          {
+            message: "#{request_string(event)} started",
+            request: request_hash(event)
+          }
+        end
+      end
+
+      def log_end(event) # rubocop:disable MethodLength
+        request = if config.double_request_logs
+          short_request_hash(event)
+        else
+          request_hash(event)
+        end
+
+        info do
+          {
+            message: response_string(event),
+            request: request,
+            response: response_hash(event),
+            metrics: process_metrics(event.payload[:metrics]
+              .merge(request_runtime: event.duration.round(2)))
+          }
+        end
+      end
+
       def request_hash(event) # rubocop:disable AbcSize, MethodLength
         request = event.payload[:request]
+        param_filter = request.send(:parameter_filter)
+
         {
           id: request.uuid,
           ip: request.remote_ip,
@@ -86,13 +108,15 @@ module Epilog
           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),
+          path: request.path,
+          query: param_filter.filter(request.query_parameters),
+          cookies: param_filter.filter(request.cookies),
+          headers: param_filter.filter(
+            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]
@@ -104,13 +128,13 @@ module Epilog
         {
           id: request.uuid,
           method: request.method,
-          path: request.fullpath
+          path: request.path
         }
       end
 
       def request_string(event)
         request = event.payload[:request]
-        "#{request.request_method} #{request.fullpath}"
+        "#{request.request_method} #{request.path}"
       end
 
       def response_hash(event)
@@ -147,6 +171,10 @@ module Epilog
           obj[key] = value.round(2) if value.is_a?(Numeric)
         end
       end
+
+      def rails_params
+        @rails_params ||= RAILS_PARAMS + RAILS_PARAMS.map(&:to_s)
+      end
     end
   end
 end

data/lib/epilog/rails/action_view_subscriber.rb

@@ -4,15 +4,15 @@ module Epilog
   module Rails
     class ActionViewSubscriber < LogSubscriber
       def render_template(event)
-        info { hash(event, 'Rendered template') }
+        debug { hash(event, 'Rendered template') }
       end
 
       def render_partial(event)
-        info { hash(event, 'Rendered partial') }
+        debug { hash(event, 'Rendered partial') }
       end
 
       def render_collection(event)
-        info { hash(event, 'Rendered collection') }
+        debug { hash(event, 'Rendered collection') }
       end
 
       private

data/lib/epilog/rails/active_job_subscriber.rb

@@ -12,6 +12,9 @@ module Epilog
       end
 
       def perform_start(event)
+        push_context(job: short_job_hash(event.payload[:job]))
+        return unless config.double_job_logs
+
         info { event_hash('Performing job', event) }
       end
 
@@ -23,6 +26,7 @@ module Epilog
             }
           )
         end
+        pop_context
       end
 
       private
@@ -45,6 +49,13 @@ module Epilog
         }
       end
 
+      def short_job_hash(job)
+        {
+          class: job.class.name,
+          id: job.job_id
+        }
+      end
+
       def format_time(time)
         Time.at(time).utc.strftime(Epilog::Formatter::DEFAULT_TIME_FORMAT)
       end

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

@@ -29,7 +29,8 @@ module Epilog
         request: request,
         response: response,
         controller: self.class.name,
-        action: action_name
+        action: action_name,
+        context: epilog_context
       }
     end
 
@@ -39,7 +40,14 @@ module Epilog
         view_runtime: view_runtime
       }
     end
+
+    def epilog_context
+      {}
+    end
   end
 end
 
 ActionController::Base.prepend(Epilog::ActionControllerExt)
+if defined? ActionController::API
+  ActionController::API.prepend(Epilog::ActionControllerExt)
+end

data/lib/epilog/rails/log_subscriber.rb

@@ -9,6 +9,18 @@ module Epilog
         super()
         @logger = logger
       end
+
+      def push_context(context)
+        @logger.try(:push_context, context)
+      end
+
+      def pop_context
+        @logger.try(:pop_context)
+      end
+
+      def config
+        ::Rails.application.config.epilog
+      end
     end
   end
 end

data/lib/epilog/rails/railtie.rb

@@ -20,6 +20,8 @@ module Epilog
       ].freeze
 
       config.epilog = ActiveSupport::OrderedOptions.new
+      config.epilog.double_request_logs = true
+      config.epilog.double_job_logs = true
       config.epilog.subscriptions = %i[
         action_controller
         action_mailer

data/lib/epilog/version.rb

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

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: epilog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2020-05-26 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
@@ -30,28 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: irb
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -78,28 +92,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -132,30 +146,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.61'
+        version: '0.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.61'
+        version: '0.75'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +177,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,6 +187,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +216,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -210,8 +231,10 @@ files:
 - bin/yri
 - epilog.gemspec
 - lib/epilog.rb
+- lib/epilog/context_logging.rb
 - lib/epilog/filter.rb
 - lib/epilog/filter/blacklist.rb
+- lib/epilog/filter/filter_parameters.rb
 - lib/epilog/filter/hash_key.rb
 - lib/epilog/log_formatter.rb
 - lib/epilog/logger.rb
@@ -251,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A JSON logger with Rails support