lorekeeper 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8b0a7ef791f5abaf9fc2452ac135e9c5ec37510b879b19a02039cb3d1096342
-  data.tar.gz: 418c008350fd3f1a221291266b3ab39e59d8333f796148bffba16f717399c066
+  metadata.gz: b72498ad2cf067d82c9371e7affa84ce85974332d2eaa962d34fa9b687ff897f
+  data.tar.gz: af9356d08c95dbadd903dd340a3a3acbe8f1d26768333e20add816f232f93bf8
 SHA512:
-  metadata.gz: fb7b5c1889b2e133bfe6f6a55be4424bcdfbe26718f2096889b1409d09609678ad57fc50fa2363fa17b7e59f79342422e1ac2ff3c22fd7572fec14fa09da5692
-  data.tar.gz: 6933ce6d182c41fd7fd23950df831bc3e9f93c3d72c31198dd93906882f50a24395919b5cb2ba1a65587c0a5adc240b397872a27e25e2a7e251324661669e795
+  metadata.gz: a1e4267df3ae911fccb7245e22f6c8271df78e4d454e39740fb966cb881cadeb27ee67cfef54b3f580ffa554bd1c0370895c9287af6b5c25a8fd5dd8ed90659e
+  data.tar.gz: a7e7c0f9c916abf6bb575053ba6a5ce29832ff0eb0f4bdc7f9044bd2a615c0eacb5f6c0a9aa32e063d11bcce83f68fa67ecc86875b379db9f9e3bc77efee22b3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.8.0
+* Allow to use named parameters in the .exception method
+
 # 1.7.2
 * Add a second parameter to respond_to? to avoid Ruby 2.6 warnings
 * Drop support for unsupported Ruby 2.1 and Ruby 2.2

data/README.md

@@ -169,6 +169,24 @@ Will output:
 }
 ```
 
+Alternatively you can use named parameters:
+
+
+```ruby
+rescue => e
+  logger.exception(e, message: "custom msg!", data: { some: { data: 123 } }, level: :warn)
+end
+```
+
+This is specially useful when there is no custom message or data:
+
+```ruby
+rescue => e
+  logger.exception(e, level: :warn)
+end
+```
+
+
 
 ## License
 

data/Rakefile

@@ -50,10 +50,10 @@ task :benchmark do
   simple_log = create_simple_logger
 
   Benchmark.ips do |bm|
-    bm.report('short content') { log.error(contents) }
-    bm.report('Logger short content') { simple_log.info(contents) }
-    bm.report('long content') { log.info(long_contents) }
-    bm.report('Logger long content') { simple_log.info(long_contents) }
+    bm.report('JSON short content') { log.debug(contents) }
+    bm.report('Logger short content') { simple_log.debug(contents) }
+    bm.report('JSON long content') { log.debug(long_contents) }
+    bm.report('Logger long content') { simple_log.debug(long_contents) }
     bm.compare!
   end
 

data/lib/lorekeeper/json_logger.rb

@@ -29,7 +29,7 @@ module Lorekeeper
     LOGGING_METHODS.each do |method_name|
       define_method "#{method_name}_with_data", ->(message_param = nil, data = {}, &block) do
         return true if METHOD_SEVERITY_MAP[method_name] < @level
-        extra_fields = { 'data' => (data || {}) }
+        extra_fields = { DATA => (data || {}) }
         with_extra_fields(extra_fields) { # Using do/end here only valid on Ruby>= 2.3
           add(METHOD_SEVERITY_MAP[method_name], message_param, nil, &block)
         }
@@ -61,25 +61,31 @@ module Lorekeeper
     end
 
     # @param exception: instance of a class inheriting from Exception
-    # We will output backtrace twice. Once inside the stack so it can be parsed by software
-    # And the other inside the message so it is readable to humans
-    def exception(exception, custom_message = nil, custom_data = nil, level = :error)
-      log_level = METHOD_SEVERITY_MAP[level] || ERROR
+    # By default message comes from exception.message
+    # Optional and named parameters to overwrite message, level and add data
+    def exception(exception, custom_message = nil, custom_data = nil, custom_level = :error,
+                             message: nil, data: nil, level: nil) # Backwards compatible named params
+
+      param_level = level || custom_level
+      param_data = data || custom_data
+      param_message = message || custom_message
+
+      log_level = METHOD_SEVERITY_MAP[param_level] || ERROR
 
       if exception.is_a?(Exception)
         backtrace = exception.backtrace || []
         exception_fields = {
-          'exception' => "#{exception.class}: #{exception.message}",
-          'stack' => backtrace
+          EXCEPTION => "#{exception.class}: #{exception.message}",
+          STACK => backtrace
         }
-        exception_fields['data'] = custom_data if custom_data
+        exception_fields[DATA] = param_data if param_data
 
-        message = custom_message || exception.message
+        message = param_message || exception.message
         with_extra_fields(exception_fields) { log_data(log_level, message) }
       else
         log_data(METHOD_SEVERITY_MAP[:warn], 'Logger exception called without exception class.')
-        message = "#{exception.class}: #{exception.inspect} #{custom_message}"
-        with_extra_fields('data' => (custom_data || {})) { log_data(log_level, message) }
+        message = "#{exception.class}: #{exception.inspect} #{param_message}"
+        with_extra_fields(DATA => (param_data || {})) { log_data(log_level, message) }
       end
     end
 
@@ -94,6 +100,9 @@ module Lorekeeper
     MESSAGE = 'message'
     TIMESTAMP = 'timestamp'
     DATE_FORMAT = '%FT%T.%6NZ'
+    EXCEPTION = 'exception'
+    STACK = 'stack'
+    DATA = 'data'
 
     def with_extra_fields(fields)
       state[:extra_fields] = fields
@@ -108,11 +117,12 @@ module Lorekeeper
     end
 
     def log_data(severity, message)
+      current_state = state # Accessing state is slow. Do it only once per call.
       # merging is slow, we do not want to merge with empty hash if possible
-      fields_to_log = if state[:extra_fields].empty?
-        state[:base_fields]
+      fields_to_log = if current_state[:extra_fields].empty?
+        current_state[:base_fields]
       else
-        state[:base_fields].merge(state[:extra_fields])
+        current_state[:base_fields].merge(current_state[:extra_fields])
       end
 
       fields_to_log[MESSAGE] = message

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lorekeeper
-  VERSION = '1.7.2'
+  VERSION = '1.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj