nypl_log_formatter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5d63110408241c2f2ba556c448fb4fafe72cfea6ad8a6d1102f4bd0478816d1
-  data.tar.gz: 276af5118f265e03f57c0c8101ed9856dfc81353b0ba9f29a2aa435e314d64c0
+  metadata.gz: cd40e2cd4eb74fc6ced36167ddbae1cdf7311d63ee7eefde5339eb49de30fb04
+  data.tar.gz: a8851f466ec347427d1f351eef57731fc9cc06055fa0bfe3421af9af961d902f
 SHA512:
-  metadata.gz: 14586be188d33b6d9329adc82ba7a08e6e3fc66025ea9e15f1d457230de5b84f4d4c07e0e48965727476579ef5b702ddb346c12ca1fe338928ebcae2c82279f8
-  data.tar.gz: 86bc20340c14fbb7c07da15311ac337619572518e81d3929f6975ae7ae5277c4cdf211112026afdcbdf2cb8987c5f8a598a817777191cc799c9f0aa981898b56
+  metadata.gz: d727480ed486f211fcd0f6997f054fce95bb97ed7cf8c3c2eb3434384310f8903573fcb4b7d2030c2381a3af85a1f0b9b39f9a1f4bb30781d60ced7957697e2b
+  data.tar.gz: 63beecc9f84b35a4afae85177ed9e709fc7ebbe1e8255c79604a7632d27fa2359e29d3931d612b4aaddc0404caee9d07b3ec3c43f1710175b7f9cea1509b7d0c

data/README.md

@@ -8,7 +8,7 @@ The only advantage to subclassing is that we can bake in [custom formatting](htt
 
 ## Ruby Version Support
 
-Our [`.travis.yml`]('.travis.yml') tests against multiple Ruby versions.
+Our [`.travis.yml`](.travis.yml) tests against multiple Ruby versions.
 Feel free to add more.
 
 ## Installation
@@ -54,6 +54,26 @@ That includes:
 
 For more info see your ruby version's documentation for the `Logger` class.
 
+### Logging Additional Key/Value Pairs
+
+You can pass a second argument, a Hash that will end up as keys/values in the
+logged JSON.
+
+```ruby
+logger = NyplLogFormatter.new('path/to/file.log')
+
+logger.error(
+  'Something went wrong',
+  user: {email: 'simon@example.com', name: 'simon'},
+  permissions: ['admin', 'good-boy']
+)
+
+# Contents of file.log
+  # Logfile created on 2018-01-17 15:51:31 -0500 by logger.rb/61378
+  #{"level":"ERROR","message":"Something went wrong","timestamp":"2018-02-07T16:47:22.017-0500","user":{"email":"simon@example.com","name":"simon"},"permissions":["admin","good-boy"]}
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nypl_log_formatter.rb

@@ -10,17 +10,42 @@ class NyplLogFormatter < ::Logger
     super(*args)
     # This has to happen _after_ call to super, otherwise ::Logger will set the formatter
     set_formatter
+    allow_arbitrary_keys
   end
 
-private
+  private
+
+  # Redefines #log(), #error(), etc...but explodes the `progname` arg
+  # to be more than a simple string.
+  # See original implementations here: https://github.com/ruby/ruby/blob/trunk/lib/logger.rb#L524
+  def allow_arbitrary_keys
+    Logger::Severity.constants.each do |severity_name|
+      define_singleton_method(severity_name.to_s.downcase.to_sym) do |*progname, &block|
+        add(eval(severity_name.to_s), nil, progname, &block)
+      end
+    end
+  end
 
   def set_formatter
     self.formatter = proc do |severity, datetime, progname, msg|
       message_hash = {
         level:     severity.upcase,
-        message:   msg,
+        message:   msg.is_a?(Array) ? msg.shift : msg,
         timestamp: Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%z")
       }
+
+      if msg.is_a?(Array)
+        msg.each do |additional_key_values|
+          additional_key_values.each do |key, value|
+            message_hash[key] = value
+          end
+        end
+      end
+
+      if progname && !progname.empty?
+        message_hash['programName'] = progname[0]
+      end
+
       "#{JSON.generate(message_hash)}\n"
     end
   end

data/lib/nypl_log_formatter/version.rb

@@ -1,3 +1,3 @@
 module NyplLogFormatterVersion
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nypl_log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - nodanaonlyzuul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry