logjoy 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90661f240bf5c1fb3c326ecf2f95e7c5d1ed9049c71f58c8f982b4e16eba5903
-  data.tar.gz: 07e1678a7a947eba4aa63edee0914759026a0e34525095c8e4f285d794ed167e
+  metadata.gz: 11c513fbdb9b797a2d28791aa614408fc4cf714050b8f59283ccdcdb6fbcb6e7
+  data.tar.gz: 79215d5fe4b13fdc55fb82d2d62613c2c4bbc4ca3bf131160726918003d928de
 SHA512:
-  metadata.gz: 0e9ad2e6fd27e47be5f9f7808de85ba775a0c2e92400b1cb2ef7683ba68b88793440bcead1c5235375c9751cf6657bf3232f7ac5b5b48084e4721b500f40378b
-  data.tar.gz: 298bd247f702952959f06bbdb85bca43e7c6c174da7352914c79048661d661c39c981172bb9ab477be096d3fccc6dbd6ffb883e705d872b84acfd1e42c862065
+  metadata.gz: 67c25f433f4cc5bd88652ebfcbcbae71e9dc27c3ebc9b295b1dcc4d775a65132a63fa7de58b9a0ffe33b7630f29c037f10d17b755642ea8d4977da724adaa741
+  data.tar.gz: b88dfefcbea5ae84b29a11121ce6ec328c92f0cd4b40ec258824089a4e958d960fce2688a4ca74b4bb1d997be416b160f775568f609439a68cc083d4ca800ce7

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

@@ -8,10 +8,13 @@ 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)
@@ -19,14 +22,13 @@ module Logjoy
           log[:request_id] = payload[:request].request_id
           log[:event] = event.name
           log[:allocations] = event.allocations
-          log[:custom] = Logjoy.custom_fields(event) if Logjoy.customizer.present?
 
           if log[:status].nil? && (exception_class_name = payload[:exception]&.first)
             log[:exception] = exception_class_name
             log[:status] = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
           end
 
-          log.to_json
+          log.merge(Logjoy.custom_fields(event)).to_json
         end
       end
 
@@ -36,6 +38,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.1.0'
+  VERSION = '0.3.2'
 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.1.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Pat McGee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer