mimi-logger 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dac6f3cbaeef0582579cb7f695e92896676d9267c286e7d82d95d7d72312219
-  data.tar.gz: 3e9866931dff24f400dca04da3e1e41d59139f33860c621d2e7136656f80f87d
+  metadata.gz: fc1a61b8b50fe78090ba13f5e6c84f492e2477d3b787bf309e31e45b53bcc552
+  data.tar.gz: 4135fb3a61883a0bfb507a5fd753497bc2fb251f7c30f35ca2beff912b6a63d9
 SHA512:
-  metadata.gz: 0c02fa6f4e89c807b5b6284aec1e304939cf3aec08820c73db08380b81a0b0f071e85e99c55810bf8e0b584a5497f227748311dd44b7d4e9b087b649970a2b2a
-  data.tar.gz: 62cdc14d5fcbfe555e2fe45af17db5c004d051767445802dbb35fa3525825f4de514afad51da9fd700f110ae4c1ad70680344da47641b3bba50250a7c2dfdf9e
+  metadata.gz: 3ba848ac8604e7b000eb303996f1cc73abd9e7652edfed6c65f2e38672849d30b3af99215ffac0f1d44ef422da8f7f4bc5694a53d57f570c45921c3bb616a719
+  data.tar.gz: 90ab9b7c5e6587e704059d9b0d59630fe70de3fdacd8269d5e644a1ab35a7466f8016bfb14c981975f5f663db7e1392e4a745ad51fa3173e7627809afd67cf8b

data/README.md

@@ -63,6 +63,50 @@ logger.info 'Jobs done', t: Time.now - t_start
 # => '{"s":"I","m":"Jobs done","c":"60eecc2e764fe2f6", "t": 13.794034499}'
 ```
 
+### How to log structured data
+
+There are multiple ways to log an event. The first and the simplest one is to log just a text
+message:
+
+```ruby
+require 'mimi/logger'
+
+logger = Mimi::Logger.new
+
+logger.info 'I am a banana'
+# or using a block variant
+logger.debug { 'Debug this banana' }
+```
+
+Alternatively you can log a structured object, by passing a Hash in addition to the message:
+
+```ruby
+require 'mimi/logger'
+
+logger = Mimi::Logger.new
+
+logger.info 'I am a banana', banana: { id: 123, weight: 456 }
+# => {"s":"I","m":"I am a banana","c":"d8b6f859bf9d0190","banana":{"id":123,"weight":456}}
+```
+
+Or specify the object/Hash explicitly:
+```ruby
+...
+logger.info m: 'I am a banana', banana: { id: 123, weight: 456 }
+```
+
+Or with a block variant:
+```ruby
+...
+logger.debug do
+  { banana: { id: 123, weight: 456 } }
+end
+
+# a block can also return an Array of one (Hash) or two (String,Hash) elements:
+logger.debug { [m: 'Debug this banana', banana: { id: 123, weight: 456 }] }
+logger.debug { ['Debug this banana', banana: { id: 123, weight: 456 }] }
+```
+
 ### Logging context
 
 Logging context refers to a set of instructions that are somehow logically grouped. For example,

data/lib/mimi/logger.rb

@@ -16,7 +16,7 @@ module Mimi
     extend Forwardable
     include Mimi::Core::Module
 
-    attr_reader :logger_instance
+    attr_reader :logger_instance, :options
     delegate [
       :debug?, :info?, :warn?, :error?, :fatal?,
       :<<, :add, :log
@@ -49,11 +49,11 @@ module Mimi
       opts ||= {}
       raise ArgumentError, '(io, opts) are expected as parameters' unless args.empty?
 
-      opts = self.class.module_options.deep_merge(opts)
+      @options = self.class.module_options.deep_merge(opts)
       @logger_instance = ::Logger.new(io)
-      @logger_instance.level = self.class.level_from_any(opts[:level])
+      @logger_instance.level = self.class.level_from_any(options[:level])
       io.sync = true if io.respond_to?(:sync=)
-      @logger_instance.formatter = self.class.formatter
+      @logger_instance.formatter = self.class.formatter(options)
     end
 
     # Returns the current log level
@@ -124,12 +124,12 @@ module Mimi
     #
     # @return [Proc]
     #
-    def self.formatter
-      case module_options[:format].to_s
+    def self.formatter(options)
+      case options[:format].to_s
       when 'json'
-        formatter_json
+        formatter_json(options)
       when 'string'
-        formatter_string
+        formatter_string(options)
       else
         raise "Invalid format specified for Mimi::Logger: '#{module_options[:format]}'"
       end
@@ -137,12 +137,14 @@ module Mimi
 
     # Returns formatter for 'json' format
     #
+    # @param options [Hash] logger options
+    #
     # @return [Proc]
     #
-    def self.formatter_json
+    def self.formatter_json(options)
       proc do |severity, _datetime, _progname, message|
         h = formatter_message_args_to_hash(message)
-        h[:c] = context_id if module_options[:log_context]
+        h[:c] = context_id if options[:log_context]
         h[:s] = severity.to_s[0]
         h.to_json
       end
@@ -150,15 +152,17 @@ module Mimi
 
     # Returns formatter for 'string' format
     #
+    # @param options [Hash] logger options
+    #
     # @return [Proc]
     #
-    def self.formatter_string
+    def self.formatter_string(options)
       proc do |severity, _datetime, _progname, message|
         h = formatter_message_args_to_hash(message)
         parts = []
         parts << severity.to_s[0]
-        parts << context_id if module_options[:log_context]
-        parts << h[:m].to_s.tr("\n", module_options[:cr_character])
+        parts << context_id if options[:log_context]
+        parts << h[:m].to_s.tr("\n", options[:cr_character])
         parts << '...' unless h.except(:m).empty?
         parts.join(', ')
       end

data/lib/mimi/logger/version.rb

@@ -1,5 +1,5 @@
 module Mimi
   class Logger
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.2.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mimi-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimi-core