logjoy 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1c163f606f4ff39547e838da0dead49bf4b3ec13824e17f97ab5bc43398e51
-  data.tar.gz: d3344d8049afb40f20786739a945ac1706ad47f41bed08f6939d5a827d6ffb5c
+  metadata.gz: 1473ad9c6f6b63a7df1d13b6492ab037c3560e524aa4cf04e21d8331aa995c6f
+  data.tar.gz: 0d7180652480d0763120a818b1867d8940be2a7efdb2470032cd53d11ea6d625
 SHA512:
-  metadata.gz: 1a1b5d286379fbdaa60f2dd0b81d6a8258ccff40706ce37dfdd9e16c9b135a31ef6e6048e1cc6ff9d22bc6fe9298ce1ee2f6ef6a6bd1a411af7e9349524d0344
-  data.tar.gz: a7cf2a4837f14532ce79591b271eab83a3074e818657e44fc564221f74741d210fee001dd5464f27bfb0508c589bf5d2b1dbaa5cf74cc3cc8f42045cb9cb8f05
+  metadata.gz: aae9b5331fc525afec2aa46130467c9d9cc7d036534bced3ef3d3c94d53a33e07390c2d2853b750c3f561a21e4529eeefaaee5f3fe15a7e53db121186eb9bee2
+  data.tar.gz: 3dc63a6b4d9b9ab10fa6a9dad2a8ac2da3acd6d7ddb79b4737255cd2dd6a3cc1d2525101a07a5698baea35c693cd39bc06747895504d87c56549c6a8c51d61db

data/README.md

@@ -53,6 +53,8 @@ Rails.application.configure do |config|
   config.logjoy.customizer = CustomizerClass
   # or
   config.logjoy.customizer = ->(event) { ... }
+
+  config.logjoy.filters = ['/health_check']
 end
 ```
 
@@ -64,6 +66,9 @@ It should return a hash that will be added to the log in a `:custom` field.
 More documentation about this event can be found here:
 https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller
 
+The filters configuration can be used to ignore requests with the given path to
+reduce log noise from things like health checks.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/logjoy/log_subscribers/action_controller.rb

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
 require 'active_support/log_subscriber'
-require 'action_controller/base'
 require 'action_controller/log_subscriber'
 
 module Logjoy
   module LogSubscribers
     class ActionController < ActiveSupport::LogSubscriber
       def process_action(event)
+        return if ignore_event?(event)
+
         info do
           payload = event.payload
 
-          log = payload.slice(:controller, :action, :format, :method, :path, :status)
+          log = payload.slice(:controller, :action, :format, :method, :status)
+          log[:path] = strip_query(payload[:path])
           log[:view_runtime] = rounded_ms(payload[:view_runtime])
           log[:db_runtime] = rounded_ms(payload[:db_runtime])
           log[:duration] = rounded_ms(event.duration)
@@ -35,6 +37,15 @@ module Logjoy
 
       private
 
+      def strip_query(path_with_query)
+        uri = URI.parse(path_with_query)
+        uri.path
+      end
+
+      def ignore_event?(event)
+        Logjoy.filters.include?(event.payload[:path])
+      end
+
       def rounded_ms(value)
         return 'N/A' if value.nil?
 

data/lib/logjoy/railtie.rb

@@ -11,6 +11,10 @@ module Logjoy
       Logjoy.set_customizer(app)
     end
 
+    config.after_initialize do |app|
+      Logjoy.set_path_filters(app)
+    end
+
     Logjoy::REPLACE_SUBSCRIBERS.each do |component|
       config.after_initialize do |app|
         Logjoy.detach_default_subscriber(app, component)

data/lib/logjoy/version.rb

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

data/lib/logjoy.rb

@@ -4,6 +4,7 @@ require 'action_view/log_subscriber'
 require 'action_controller/log_subscriber'
 require 'action_mailer/log_subscriber'
 require 'active_storage/log_subscriber'
+require 'active_support/core_ext/string/inflections'
 
 require_relative 'logjoy/version'
 require_relative 'logjoy/log_subscribers/action_controller'
@@ -12,7 +13,8 @@ module Logjoy
   class Error < StandardError; end
   module_function
 
-  mattr_accessor :customizer
+  mattr_accessor :customizer, :filters
+  self.filters = []
 
   def custom_fields(event)
     return {} if customizer.nil?
@@ -26,6 +28,12 @@ module Logjoy
     self.customizer = app.config.logjoy.customizer
   end
 
+  def set_path_filters(app)
+    return unless enabled?(app)
+
+    self.filters = app.config.logjoy.filters || []
+  end
+
   REPLACE_SUBSCRIBERS = %i[action_controller].freeze
   DETACH_SUBSCRIBERS = %i[action_view action_mailer active_storage].freeze
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjoy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Pat McGee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer