epilog 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fd0a8c3e9e8399b9f1e5f7c16a3de10b61a46274a0490ac1f39ed168b5812b8
-  data.tar.gz: f83444e51908ca573918cfc5e8fd9515ccb1f4275aa80b17fa1da66c0593bf15
+  metadata.gz: 7c182e5b6fad45d60dcbf0e37843e075e6775d76e3888a632056cef356235768
+  data.tar.gz: bb7095818994ab3532c70c691180fe1018089e587cc7819faf1441bb6532acf9
 SHA512:
-  metadata.gz: ff61b605c231ebd750c5e3ce1909c498afe203824fbfd0c70f061e71ffdb7ec7e02e0bc6a33e2ee44f4043d27e2bd14befbc23ad33c6f464d65910dedc200b3e
-  data.tar.gz: 750683aa14e5c0c965088af4bcaf8de2180f58156e44a074d7ca4382275eaa6db1e12c02cc6afcce5dfa8122ceecb75a892876b4cad8144c0dc111c2b868843e
+  metadata.gz: 07552c37f2ebcc5febb7d94f227801c8f89e15eae7904e493c6575bd83819a1989b7229a9d1559ffc9f4651884611160b77779cfce11fa1abcf48c71bd484612
+  data.tar.gz: 5664a1841cdd95b1af21e8796a374f30d5ddfd26faf6ef4782abc9de435098d351f3e29d2b778358e74c1af5ae55b9cb4d4155c0cba776201ed9d350286abc41

data/CHANGLOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 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)

data/lib/epilog/context_logging.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Epilog
+  module ContextLogger
+    def with_context(context)
+      push_context(context)
+      yield
+      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/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,31 @@ module Epilog
       RAILS_PARAMS = %i[controller action format _method only_path].freeze
 
       def request_received(event)
+        push_context(
+          { request: short_request_hash(event) }
+          .merge(event.payload[:context])
+        )
+
         info do
-          event.payload[:context].merge(
+          {
             message: "#{request_string(event)} started",
             request: request_hash(event)
-          )
+          }
         end
       end
 
       def process_request(event)
         info do
-          event.payload[:context].merge(
+          {
             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
+
+        pop_context
       end
 
       def start_processing(*)

data/lib/epilog/rails/active_job_subscriber.rb

@@ -12,6 +12,7 @@ module Epilog
       end
 
       def perform_start(event)
+        push_context(job: short_job_hash(event.payload[:job]))
         info { event_hash('Performing job', event) }
       end
 
@@ -23,6 +24,7 @@ module Epilog
             }
           )
         end
+        pop_context
       end
 
       private
@@ -45,6 +47,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/log_subscriber.rb

@@ -9,6 +9,14 @@ module Epilog
         super()
         @logger = logger
       end
+
+      def push_context(context)
+        @logger.try(:push_context, context)
+      end
+
+      def pop_context
+        @logger.try(:pop_context)
+      end
     end
   end
 end

data/lib/epilog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Epilog
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epilog
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2019-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -231,6 +231,7 @@ 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