logjoy 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1473ad9c6f6b63a7df1d13b6492ab037c3560e524aa4cf04e21d8331aa995c6f
-  data.tar.gz: 0d7180652480d0763120a818b1867d8940be2a7efdb2470032cd53d11ea6d625
+  metadata.gz: 8465ed2ff48074e8353f4502bc13b563bdd63ce1c35e1651536b12b51ce1b2e4
+  data.tar.gz: 80644fc030801240e16486e66ff163ab079b0670ac6b1098fdf8546e7dba4cf0
 SHA512:
-  metadata.gz: aae9b5331fc525afec2aa46130467c9d9cc7d036534bced3ef3d3c94d53a33e07390c2d2853b750c3f561a21e4529eeefaaee5f3fe15a7e53db121186eb9bee2
-  data.tar.gz: 3dc63a6b4d9b9ab10fa6a9dad2a8ac2da3acd6d7ddb79b4737255cd2dd6a3cc1d2525101a07a5698baea35c693cd39bc06747895504d87c56549c6a8c51d61db
+  metadata.gz: 1c14f59ce816476068423c31b321974909adb9c3efd7e89b6ba1e34edda462d6b0984cad287a849ed2f6a34e2c41877f37fd0a8da14f752220970fd38bd2ab71
+  data.tar.gz: 2cacd55977b12fda7e4edccd14efe7be349b6faf55460b55e15128f32647c9167311a0069b7c489a33bb72f7109468e8cb27ca74d9cc314e1705647eb313e9ec

data/Gemfile

@@ -2,11 +2,10 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logjoy.gemspec
 gemspec
 
 gem 'minitest', '5.14.4'
 gem 'pry', '0.14.1'
-gem 'rails', '6.1.4.1'
+gem 'rails', '7.0.3'
 gem 'rake', '13.0.6'
 gem 'rubocop', '1.21.0'

data/README.md

@@ -1,5 +1,7 @@
 # Logjoy
 
+## Overview
+
 Logjoy makes some changes to Rails default `ActiveSupport::LogSubscriber`s in order
 to provide streamlined request logs for use in production.
 
@@ -7,27 +9,9 @@ The name is an homage to the [lograge gem](https://github.com/roidrage/lograge)
 which is no longer maintained and which this gem is intended to replace.
 
 See
-[LOGRAGE_README](https://github.com/pathouse/logjoy/blob/main/LOGRAGE_README.md)
+[LOGRAGE_README](https://github.com/DogParkLabs/logjoy/blob/main/LOGRAGE_README.md)
 for more information about the differences between this gem and lograge.
 
-```json
-{
-  "controller": "PagesController",
-  "action": "index",
-  "format": "html",
-  "method": "GET",
-  "path": "/",
-  "status": 200,
-  "view_runtime": 123.456,
-  "db_runtime": 123.456,
-  "duration": 1234.567,
-  "params": {},
-  "request_id": "95cb397a-df23-4548-b641-ae8eef9d3a4e",
-  "event": "process_action.action_controller",
-  "allocations": 123456
-}
-```
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -40,10 +24,42 @@ And then execute:
 
     $ bundle install
 
-## Usage
+## Configuration
 
 Logjoy can be configured with the following options:
 
+### enabled
+
+`config.logjoy.enabled = true`
+
+You will likely only want to enable Logjoy in production, e.g. `config.logjoy.enabled = Rails.env.production?`
+
+### customizer
+
+You can provide a lambda:
+
+`config.logjoy.customizer = ->(event) { ... }`
+
+or a class that implements a `.call` method:
+
+`config.logjoy.customizer = CustomizerClass`
+
+The customizer will receive an `ActiveSupport::Notification` event for the
+`process_action.action_controller` event.
+It should return a hash that will be added to the log message.
+
+More documentation about this event can be found here:
+https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller
+
+### filters
+
+`config.logjoy.filters = ['/paths', '/to', '/ignore']`
+
+The filters configuration can be used to ignore requests with the given path to
+reduce log noise from things like health checks.
+
+### Example of full configuration
+
 `config/initializers/logjoy.rb`
 
 ```ruby
@@ -58,16 +74,41 @@ Rails.application.configure do |config|
 end
 ```
 
-The customizer configuration may be a class that implements a `.call` method, or a lambda.
-The customizer will receive an `ActiveSupport::Notification` event for the
-`process_action.action_controller` event.
-It should return a hash that will be added to the log in a `:custom` field.
+## Log Format
 
-More documentation about this event can be found here:
-https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller
+Log messages are JSON formatted.
 
-The filters configuration can be used to ignore requests with the given path to
-reduce log noise from things like health checks.
+```json
+{
+  "controller": "PagesController",
+  "action": "index",
+  "format": "html",
+  "method": "GET",
+  "path": "/",
+  "status": 200,
+  "view_runtime": 123.456,
+  "db_runtime": 123.456,
+  "duration": 1234.567,
+  "params": {},
+  "request_id": "95cb397a-df23-4548-b641-ae8eef9d3a4e",
+  "event": "process_action.action_controller",
+  "allocations": 123456
+}
+```
+
+If you are using `Logger::Formatter` to format your logs the output should look something like:
+
+`I, [timestamp]  INFO -- : [request_id] {"controller":"PagesController", ...}`
+
+If you define your own formatter keep in mind that `msg` is already JSON formatted in the `#call` method that you will define:
+
+```
+class MyFormatter < Logger::Formatter
+  def call(severity, time, progname, msg)
+    # msg is a JSON string
+  end
+end
+```
 
 ## Development
 
@@ -84,10 +125,10 @@ git commits and the created tag, and push the `.gem` file to
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/pathouse/logjoy. This project is intended to be a safe,
+https://github.com/DogParkLabs/logjoy. This project is intended to be a safe,
 welcoming space for collaboration, and contributors are expected to adhere to
 the [code of
-conduct](https://github.com/[USERNAME]/logjoy/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/DogParkLabs/logjoy/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/logjoy/version.rb

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

data/lib/logjoy.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/inflections'
 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'

data/logjoy.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |spec|
   spec.name          = 'logjoy'
   spec.version       = Logjoy::VERSION
   spec.authors       = ['Pat McGee']
-  spec.email         = ['patmcgee331@gmail.com']
+  spec.email         = ['pat@gooddog.com']
 
   spec.summary       = 'Alternative set of LogSubscriber classes for Rails for more structured JSON logs'
-  spec.homepage      = 'https://github.com/pathouse/logjoy'
+  spec.homepage      = 'https://github.com/DogParkLabs/logjoy'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'actionmailer', '~> 6'
-  spec.add_runtime_dependency 'actionpack', '~> 6'
-  spec.add_runtime_dependency 'actionview', '~> 6'
-  spec.add_runtime_dependency 'activestorage', '~> 6'
-  spec.add_runtime_dependency 'activesupport', '~> 6'
-  spec.add_runtime_dependency 'railties', '~> 6'
+  spec.add_runtime_dependency 'actionmailer', '>= 6'
+  spec.add_runtime_dependency 'actionpack', '>= 6'
+  spec.add_runtime_dependency 'actionview', '>= 6'
+  spec.add_runtime_dependency 'activestorage', '>= 6'
+  spec.add_runtime_dependency 'activesupport', '>= 6'
+  spec.add_runtime_dependency 'railties', '>= 6'
 end

metadata

@@ -1,102 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: logjoy
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Pat McGee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: activestorage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6'
 description:
 email:
-- patmcgee331@gmail.com
+- pat@gooddog.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -118,13 +118,13 @@ files:
 - lib/logjoy/railtie.rb
 - lib/logjoy/version.rb
 - logjoy.gemspec
-homepage: https://github.com/pathouse/logjoy
+homepage: https://github.com/DogParkLabs/logjoy
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/pathouse/logjoy
-  source_code_uri: https://github.com/pathouse/logjoy
-  changelog_uri: https://github.com/pathouse/logjoy/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/DogParkLabs/logjoy
+  source_code_uri: https://github.com/DogParkLabs/logjoy
+  changelog_uri: https://github.com/DogParkLabs/logjoy/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Alternative set of LogSubscriber classes for Rails for more structured JSON