logjoy 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56329a258274b0bd9cfb93908a2c0eabd282d997199df65338754f2bf21553bc
-  data.tar.gz: c9f0fe2944b7fd218492a8e71e6381bed4815afef1fd54606b29091a074d095a
+  metadata.gz: 4da07c8943cc57684a2c27c541726b4f6545e82ec3581e50193ca4f9334dfce9
+  data.tar.gz: 856d0f47719d071519550dadaec792ab10e117046b13770d4d7dc198ab2fbc65
 SHA512:
-  metadata.gz: 692adfc536f2bd584fe5cbf0c2037f3489d3b874e83d0e8d4dc286c61a4f96a6284beb770d03653f92464b2d881243f3b475ce9e576cd59a2a984fc1ec834034
-  data.tar.gz: '09bd6e67e9ce7f7bcf8a026ce93a748a50e96d3cc135b7fffb2493fd970ae37a5ad38a052f240a6b20763bad3f8175e845ab1cf750e9edb0aa9770e027cc68f7'
+  metadata.gz: 91bcc54414715010cf08c114c6fdf27ff4999bf3de2ed6b78e538f1a67adbf45b5ae858d707a8daf8a720ca31aa0ce880db60eff66b7e76931c427e42b42b538
+  data.tar.gz: 4fd305c8b89ae177cb7884eab52a24904430ff3ffb5c8912a04f33ed2f1c3f9b2afcf6178f3281ee4eae2bbfac3a6054623a6ef04be7e66786e5b41f4e336313

data/Gemfile

@@ -2,7 +2,6 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logjoy.gemspec
 gemspec
 
 gem 'minitest', '5.14.4'

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.4'
+  VERSION = '0.3.5'
 end

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')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjoy
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Pat McGee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -96,7 +96,7 @@ dependencies:
         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: