event_logger_rails 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ba9a01dfc949b290f6142ac959cc206e705f5b286e2768381a82d6477f424d
-  data.tar.gz: aa992346f7623bb36cd0d12fd83aed155a92a8645c0cfbe8b47ec8c7d22fcc3e
+  metadata.gz: d7bfe805ac5781f56655df8ee5b2cd31f4e58ef9d489cea5ecaa08a2d6866ea1
+  data.tar.gz: 5b07e0e885cd7593e1647bc267f326b1d0658df5a6dee0dacfd22a6f3203a1dc
 SHA512:
-  metadata.gz: 7783f0fae629d0bf417b922a5b93257f22946b7b6b5f5304420341cf9e55f3a6471071fcd3bb36f1b00ed3862f181b6f222306f4975239c1353d24b57a3c94f8
-  data.tar.gz: 6abc431c12d4395ae0b119fb62b26731a8509d22f4b98ac3eeb868a8de27a8255b6ff6b81fc83a8ebb4764643eda90d946a36cf3c1ba81db63b34cf1c26d6e8b
+  metadata.gz: 1f37082b41da102a901a8457c19b7035a7dbf4d804a2eccc09a5271988ae3eb1fa481201cdb3102564867770b2984a590f2e0094a4f19b6d17d8cb6a45fa35d6
+  data.tar.gz: 60f84d836021a037baa968e3dd1a80c9af7378397884d422e186f1cb63353f9fb11cbde70c3bed01f3d689d5d12d59e0efb5aa7f9121c8efc0a5c5dd760e3296

data/README.md

@@ -21,7 +21,7 @@ Then, from the controller action that processes user signup's, include the `Logg
 
 ```ruby
 class UsersController < ApplicationController
-  include Loggable
+  include EventLoggerRails::Loggable
 
   def create
     user = User.new(user_params)
@@ -48,6 +48,18 @@ In this example, a possible successful signup could be structured like this:
 [ERROR | 2021-12-27T20:57:06+00:00 | user.signup.failure] {"controller"=>"Users", "action"=>"create", "method"=>"POST", "path"=>"/users", "remote_ip"=>"::1", "parameters"=>"{ "user"=>{ "first_name"=>"Test", "last_name"=>"User" } }", "errors"=>"{ "email"=>"is missing" }"}
 ```
 
+If you fail to register an event, the logger will emit an `event_logger_rails.event.unregistered` event:
+
+```
+[ERROR | 2021-12-27T20:57:06+00:00 | event_logger_rails.event.unregistered] {"controller"=>"Users", "action"=>"create", "method"=>"POST", "path"=>"/users", "remote_ip"=>"::1", "parameters"=>"{ "user"=>{ "first_name"=>"Test", "last_name"=>"User" } }", "message"=>"Event provided not registered: user.signup.failure"}
+```
+
+If you provide an invalid log level, the logger will emit an `event_logger_rails.logger_level.invalid` event:
+
+```
+[ERROR | 2021-12-27T20:57:06+00:00 | event_logger_rails.logger_level.invalid] {"controller"=>"Users", "action"=>"create", "method"=>"POST", "path"=>"/users", "remote_ip"=>"::1", "parameters"=>"{ "user"=>{ "first_name"=>"Test", "last_name"=>"User" } }", "message"=>"Invalid logger level provided: 'foo'. Valid levels: debug, info, warn, error, fatal."}
+```
+
 The log entry indicates the logger level (useful for filtering results), the registered event, and more useful information from the controller and request.
 This makes it simple use a tool like `awk` or another monitoring solution to parse the logs for emitted events, facilitating troubleshooting and analytics.
 

data/lib/event_logger_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_logger_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dick Davis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails