sonnet 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 273fb36aa6154de4836aae0cb4f44ccb4b9799652f8dfebbd08a9ee04d2fa669
-  data.tar.gz: d8f9d7f79f4a5b436754c7ee7adab6d39a30440b041e306e5e37861592ba7beb
+  metadata.gz: 2fde1c29033040450a05efda38fc80a4ab39647af542de057bf1a51a12ae9c98
+  data.tar.gz: e02bacca362f4992aa567576d88720c961e3b733e7c9abdba5bdba9487aad0ac
 SHA512:
-  metadata.gz: d4ec687ec2c6e93d459a30065d6c4849dff9533cca1dbd6861c9cf18591b490b52e0f250d9e07e4c107d543b83546afb0160f4a23d0ff8ccc2b6663a09c477c5
-  data.tar.gz: 83305c920737815295ddfc792ae7b979247d3b334a848ff726afa1ea2e16ff73974be8d53513bc9376a5c38235cb7de44b025d4aa02c857bcbd42b8ab33af850
+  metadata.gz: 1bb24a4c08a4429764bd50319d088e342147fbf794ccb908213bd0dc74f010d01acafe9aa2c39f87b3b09396f9d29f072ae3f37a76fd6b2ef2730cd437ba8f0e
+  data.tar.gz: 65509aff4d33b784ec8576e3e78f2ef6bfe2fb9ffea11f9cf03f2877955eba628b12a7051667c68f679ecaf8381d7ac2142bf6f8b4448bcb5a86acfd6f8fc281

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sonnet (0.1.4)
+    sonnet (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,11 +1,23 @@
 # Sonnet
 
-Structured logging for Ruby applications.
+JSON logging for Ruby applications.
+
+## Philosophy
+
+* Adhere to Ruby conventions as much as possible. Keep API as close as possible
+  to
+  [Logger](https://ruby-doc.org/stdlib-2.6.2/libdoc/logger/rdoc/Logger.html).
+  If Sonnet were removed, your log lines should continue to work (though they
+  might be ugly).
+* Configurable, to a point
+* For advanced use cases, see below alternatives.
+* Work as well for Ruby application as for Rails
 
 ## Alternatives
 
 * [Ougai](https://github.com/tilfin/ougai)
 * [Semantic Logger](https://github.com/rocketjob/semantic_logger)
+* Custom log formatter (seriously, it's really easy!)
 
 ## Installation
 
@@ -27,10 +39,37 @@ Or install it yourself as:
 
 ```ruby
 require "sonnet"
-logger = Logger.new(STDOUT)
-logger.extend(Sonnet::Logger)
+logger = Sonnet::Logger.new(Logger.new(STDOUT))
 ```
 
+## Ruby on Rails
+
+It shouldn't be as much of a pain as it is to configure Rails to log JSON. Even
+if you're able to do it, every gem introduces another logger that might have to
+be configured.
+
+### ActiveSupport::TaggedLogger
+
+The easiest workaround is to just not use it. However, Rails uses it
+internally, and _it modifies the logger passed to it_! So you (currently) can't
+escape monkeypatching Rails.
+
+Additionally, it is useful to be able to specify context info that gets logged
+with every line inside of a block. I have plans to possibly support `#tagged`,
+but I'm not sure what a sensible default is for converting string tags into a
+hash. Some options:
+* store in a `tags` array
+* attempt to guess at keys for each tag (possble if passing symbols to
+  `log_tags`, but probably can't handle every use case).
+* Allow user to define keys for each tag
+
+### ActionDispatch::DebugExceptions
+
+This middleware logs exceptions as strings. Since it is included by default,
+the easiest workaround is to monkeypatch it to log the exception rather than
+strings, which means we can handle it with our usual exception logging in
+Sonnet::Formatter.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/allspiritseve/sonnet.

data/lib/sonnet/logger.rb

@@ -11,6 +11,10 @@ module Sonnet
       ::Logger.const_get((ENV["LOG_LEVEL"] || "INFO").upcase)
     end
 
+    def self.new(logger)
+      logger.extend(self)
+    end
+
     def with_context(context = {})
       formatter.current_context.push(context)
       yield self

data/lib/sonnet/version.rb

@@ -1,3 +1,3 @@
 module Sonnet
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/sonnet_test.rb

@@ -28,6 +28,13 @@ class SonnetTest < Minitest::Test
     assert_log_line log[1], message: "definitely maybe"
   end
 
+  def test_new
+    logger = Sonnet::Logger.new(Logger.new(io))
+    assert_equal logger.formatter, Sonnet::Formatter
+    logger.info("What's the story, morning glory?")
+    assert_log_line log[0], level: "info", message: "What's the story, morning glory?"
+  end
+
   def assert_log_line(actual, expected)
     assert_equal expected, actual.slice(*expected.keys)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonnet
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Cory Kaufman-Schofield
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler