lorekeeper 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d61606d89f285ae3a17849136a54458689a32aa2
-  data.tar.gz: 667a0f789f27c27303509c4ca254ef956e34028a
+  metadata.gz: '055989651779854042e33d2d16964ab14024c6de'
+  data.tar.gz: 5244927f5b0474aa268bcb19023c0a756d9f05b6
 SHA512:
-  metadata.gz: 09f0e761139364e6c219ed4bd6a01b098e2d5e9ac170e663deed23654555908ecdf0b7ac455e8cfe6c7c1d3fed296743008e3c7a1246fe3760e4747a39f00f2c
-  data.tar.gz: e3883fcac259aee4cfcdb1622c1d85a454a389252c3bbd39dce62281289f04ae2e98ee19d50d37c2f46b49c37da676667c174cde837c8c7c88f1bfc9b635fcf2
+  metadata.gz: 2592040a77cfce274449eebaa446b57c5f690e34335dd39a686161c3c0ffc20b1f0ba93d9f42760080d44c50918158db41e8bc816ceeeca68bbd167e03a1f9be
+  data.tar.gz: 9af69c2084fb453a53207a87061acdbcf774c07760024ee8e4f497dbf031a07f4648f7c51a19e22b21b98a2fed5ce78e6119a6c6ebe3bd8d71a97a110310d529

data/.rubocop.yml

@@ -1,2 +1,2 @@
 Metrics/LineLength:
-  Max: 100
+  Max: 120

data/.travis.yml

@@ -1,10 +1,12 @@
-language: 'ruby'
-cache: 'bundler'
-sudo: false
+language: ruby
+cache: bundler
 
 rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - 2.4.0
-script: 'bundle exec rspec'
+  - 2.1.10
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0-rc1
+
+script: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.7.0
+* Add the `level` property to the JSON Logger output
+
 # 1.6.2
 * Update oj gem to resolve segmentation fault issue
 

data/README.md

@@ -10,49 +10,78 @@ When used without extra fields it outputs 20% faster than the standard Logger fo
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lorekeeper'
+gem 'lorekeeper', '~> 1.7'
 ```
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 
 ## Usage
 
 ### Normal logging methods
 
-LoreKeeper::JSONLogger API is compatible with standard lib's Logger's. Level is not showed in the output.
+[LoreKeeper::JSONLogger](./lib/lorekeeper/json_logger.rb) API is compatible with the stdlib's Logger's.
 
-```Ruby
+```ruby
 logger.error("This is a message")
 ```
 
 Will output:
 ```
-{ "message": "This is a message", "timestamp": "1970-01-01T00:00:00.000+0100" }
+{
+  "message": "This is a message",
+  "timestamp": "1970-01-01T00:00:00.000+0100",
+  "level": "debug"
+}
 ```
 
-Timestamps use ISO8601
-Messages are json escaped so the total result is JSON parseable.
+Timestamps use ISO8601.
+Messages are JSON escaped so the total result is JSON parseable.
+
+
+### Log Levels
+
+| Method Name | JSON Property          |
+| ----------- | ---------------------- |
+| debug       | "level": "debug"       |
+| info        | "level": "info"        |
+| warn        | **"level": "warning"** |
+| error       | "level": "error"       |
+| fatal       | "level": "fatal"       |
 
 
 ### Adding keys to the output
 
-Keys can be added to the output at any moment. These keys will be output in each message till they are removed again. If you want to output keys in only one message use the _with_data method instead.
+Keys can be added to the output at any moment.
+These keys will be output in each message till they are removed again.
+If you want to output keys in only one message use the `*_with_data` method instead.
 
 Keys can be added using the `add_fields` method which accepts a hash:
 
-```Ruby
-logger.add_fields( 'role' => 'backend' )
+```ruby
+logger.add_fields("role" => "backend")
 logger.error("This is a message")
-logger.warning("This is another message")
+logger.warn("This is another message")
 ```
 
 Will output:
-```json
-{ "message": "This is a message", "timestamp": "1970-01-01T00:00:00.000+0100", "role": "backend" }
-{ "message": "This is another message", "timestamp": "1970-01-01T00:00:00.000+0100", "role": "backend" }
+```javascript
+{
+  "message": "This is a message",
+  "timestamp": "1970-01-01T00:00:00.000+0100",
+  "level": "error",
+  "role": "backend"
+}
+{
+  "message": "This is another message",
+  "timestamp": "1970-01-01T00:00:00.000+0100",
+  "level": "warning",
+  "role": "backend"
+}
 ```
 
 Because of speed purposes the JSON dumping is done as simply as possible. If you provide a hash of keys like:
@@ -60,23 +89,31 @@ Because of speed purposes the JSON dumping is done as simply as possible. If you
 { key: 'value' }
 ```
 The output will include:
-```json
+```javascript
 { ":key": "value" }
 ```
 
 
 ### Logging methods with data
 
-All methods (info, debug, etc.) has a _with_data equivalent: "info_with_data", "debug_with_data".
+All methods (info, debug, etc.) have a `*_with_data` equivalent: `info_with_data`, `debug_with_data`, etc.
 These methods accept and extra hash to add it to the JSON.
 
-```Ruby
-logger.error_with_data('message', {data1: 'Extra data', data2: 'Extra data2'})
+```ruby
+logger.error_with_data('message', { data1: 'Extra data', data2: 'Extra data2' })
 ```
 
 Will output:
-```json
-{ "message": "This is a message", "timestamp": "1970-01-01T00:00:00.000+0100", "data": {"data1": "Extra data", "data2": "Extra data2"} }
+```javascript
+{
+  "message": "This is a message",
+  "timestamp": "1970-01-01T00:00:00.000+0100",
+  "level": "debug",
+  "data": {
+    "data1": "Extra data",
+    "data2": "Extra data2"
+  }
+}
 ```
 
 
@@ -84,23 +121,27 @@ Will output:
 
 There is a method to help you log exceptions in an standard way.
 
-```Ruby
-rescue StandardError => e
+```ruby
+rescue => e
   logger.exception(e)
+end
 ```
 
 Will output:
-```json
-{ "message": "#{e.message}", "timestamp": "1970-01-01T00:00:00.000+0100", "exception": "<exception name>", "stack": ["<stacktraceline1>", "<stacktraceline2>"] }
+```javascript
+{
+  "message": "#{e.message}",
+  "timestamp": "1970-01-01T00:00:00.000+0100",
+  "level": "error",
+  "exception": "<exception name>",
+  "stack": [
+    "<stacktraceline1>",
+    "<stacktraceline2>"
+  ]
+}
 ```
 
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/JordiPolo/lorekeeper.
-
-
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/lorekeeper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lorekeeper/version'
 require 'lorekeeper/fast_logger'
 require 'lorekeeper/simple_logger'

data/lib/lorekeeper/fast_logger.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# The comment above will make all strings in a current file frozen
+
 require 'logger'
 
 module Lorekeeper
@@ -21,8 +21,29 @@ module Lorekeeper
       @file = file # We only keep this so we can inspect where we are sending the logs
     end
 
-    LOGGING_METHODS = [:debug, :info, :warn, :error, :fatal]
-    METHOD_SEVERITY_MAP = { debug: DEBUG, info: INFO, warn: WARN, error: ERROR, fatal: FATAL }
+    LOGGING_METHODS = [
+      :debug,
+      :info,
+      :warn,
+      :error,
+      :fatal
+    ].freeze
+
+    METHOD_SEVERITY_MAP = {
+      debug: DEBUG,
+      info: INFO,
+      warn: WARN,
+      error: ERROR,
+      fatal: FATAL
+    }.freeze
+
+    SEVERITY_NAMES_MAP = {
+      DEBUG => 'debug',
+      INFO => 'info',
+      WARN => 'warning',
+      ERROR => 'error',
+      FATAL => 'fatal'
+    }.freeze
 
     # We define the behaviour of all the usual logging methods
     # We support a string as a parameter and also a block
@@ -69,6 +90,7 @@ module Lorekeeper
 
       def write(message)
         return unless @iodevice
+
         @iomutex.synchronize do
           @iodevice.write(message)
         end
@@ -78,11 +100,13 @@ module Lorekeeper
 
       def to_iodevice(file)
         return nil unless file
-        iodevice = if file.respond_to?(:write) and file.respond_to?(:close)
+
+        iodevice = if file.respond_to?(:write) && file.respond_to?(:close)
           file
         else
           open_logfile(file)
         end
+
         iodevice.sync = true if iodevice.respond_to?(:sync=)
         iodevice
       end

data/lib/lorekeeper/json_logger.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
-# The comment above will make all strings in a current file frozen
+
 require 'oj'
 require 'lorekeeper/fast_logger'
 
 module Lorekeeper
   # The JSONLogger provides a logger which will output messages in JSON format
   class JSONLogger < FastLogger
-
     def initialize(file)
       reset_state
-      @base_fields = { MESSAGE => '', TIMESTAMP => '' }
+      @base_fields = { MESSAGE => '', TIMESTAMP => '', LEVEL => '' }
       super(file)
     end
 
@@ -64,7 +63,9 @@ module Lorekeeper
     # @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)
+    def exception(exception, custom_message = nil, custom_data = nil, level = :error)
+      log_level = METHOD_SEVERITY_MAP[level] || ERROR
+
       if exception.is_a?(Exception)
         backtrace = exception.backtrace || []
         exception_fields = {
@@ -74,10 +75,11 @@ module Lorekeeper
         exception_fields['data'] = custom_data if custom_data
 
         message = custom_message || exception.message
-        with_extra_fields(exception_fields) { log_data(:error, message) }
+        with_extra_fields(exception_fields) { log_data(log_level, message) }
       else
-        log_data(:warning, 'Logger exception called without exception class.')
-        error_with_data("#{exception.class}: #{exception.inspect} #{custom_message}", custom_data)
+        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) }
       end
     end
 
@@ -87,10 +89,11 @@ module Lorekeeper
 
     private
 
-    THREAD_KEY = 'lorekeeper_jsonlogger_key'.freeze # Shared by all threads but unique by thread
-    MESSAGE = 'message'.freeze
-    TIMESTAMP = 'timestamp'.freeze
-    DATE_FORMAT = '%FT%T.%6NZ'.freeze
+    THREAD_KEY = 'lorekeeper_jsonlogger_key' # Shared by all threads but unique by thread
+    LEVEL = 'level'
+    MESSAGE = 'message'
+    TIMESTAMP = 'timestamp'
+    DATE_FORMAT = '%FT%T.%6NZ'
 
     def with_extra_fields(fields)
       state[:extra_fields] = fields
@@ -104,7 +107,7 @@ module Lorekeeper
       end
     end
 
-    def log_data(_severity, message)
+    def log_data(severity, message)
       # 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]
@@ -114,9 +117,9 @@ module Lorekeeper
 
       fields_to_log[MESSAGE] = message
       fields_to_log[TIMESTAMP] = Time.now.utc.strftime(DATE_FORMAT)
+      fields_to_log[LEVEL] = SEVERITY_NAMES_MAP[severity]
 
       @iodevice.write(Oj.dump(fields_to_log) << "\n")
     end
   end
-
 end

data/lib/lorekeeper/multi_logger.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Lorekeeper
   # Allows to create a logger that will pass information to any logger registered
-  # It is useful so send the same message thought different loggers to different sinks
+  # It is useful so send the same message through different loggers to different sinks
   class MultiLogger
     def initialize
       @loggers = []
@@ -16,7 +17,7 @@ module Lorekeeper
     end
 
     def respond_to?(method)
-      @loggers.all?{ |logger| logger.respond_to?(method) }
+      @loggers.all? { |logger| logger.respond_to?(method) }
     end
 
     def method_missing(method, *args, &block)

data/lib/lorekeeper/simple_logger.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# The comment above will make all strings in a current file frozen
+
 require 'lorekeeper/fast_logger'
 
 module Lorekeeper
@@ -10,13 +10,19 @@ module Lorekeeper
     # 33: yellow
     # 31: red
     # 37: light gray
+
+    COLOR_DEFAULT = '39'
+    COLOR_YELLOW = '33'
+    COLOR_RED = '31'
+    COLOR_LIGHT_GRAY = '37'
+
     SEVERITY_TO_COLOR_MAP = {
-      DEBUG => '39'.freeze,
-      INFO => DEBUG,
-      WARN => '33'.freeze,
-      ERROR => '31'.freeze,
-      FATAL => ERROR,
-      UNKNOWN => '37'.freeze
+      DEBUG => COLOR_DEFAULT,
+      INFO => COLOR_DEFAULT,
+      WARN => COLOR_YELLOW,
+      ERROR => COLOR_RED,
+      FATAL => COLOR_RED,
+      UNKNOWN => COLOR_LIGHT_GRAY
     }.freeze
 
     # \e[colorm sets a color \e[0m resets all properties
@@ -37,16 +43,17 @@ module Lorekeeper
       end
     end
 
-    def exception(exception, custom_message = nil, custom_data = nil)
+    def exception(exception, custom_message = nil, custom_data = nil, level = :error)
+      log_level = METHOD_SEVERITY_MAP[level] || ERROR
+
       if exception.is_a?(Exception)
         backtrace = exception.backtrace || []
         message = custom_message || exception.message
-        error_with_data("#{exception.class}: #{message}", backtrace.join("\n"))
+        log_data(log_level, "#{exception.class}: #{exception.message}; #{message}, data: #{backtrace.join("\n")}")
       else
-        log_data(:warning, 'Logger exception called without exception class.')
+        log_data(METHOD_SEVERITY_MAP[:warn], 'Logger exception called without exception class.')
         error_with_data("#{exception.class}: #{exception.inspect} #{custom_message}", custom_data)
       end
     end
   end
-
 end

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# The comment above will make all strings in a current file frozen
+
 module Lorekeeper
-  VERSION = '1.6.2'.freeze
+  VERSION = '1.7.0'
 end

data/lorekeeper.gemspec

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# The comment above will make all strings in a current file frozen
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lorekeeper/version'
@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jordi Polo']
   spec.email         = ['mumismo@gmail.com']
 
-  spec.summary       = ' Very fast JSON logger '
-  spec.description   = ' Opinionated logger which outputs messages in JSON format '
-  spec.homepage      = 'http://www.github.com/jordipolo/lorekeeper'
+  spec.summary       = 'Very fast JSON logger'
+  spec.description   = 'Opinionated logger which outputs messages in JSON format'
+  spec.homepage      = 'https://github.com/JordiPolo/lorekeeper'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -20,13 +20,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'oj', '>= 3.3.1', '< 4.0'
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency 'oj', '>= 3.4', '< 4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 1.16', '< 3.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'benchmark-ips', '~> 2.3'
   spec.add_development_dependency 'timecop', '~> 0.8'
   spec.add_development_dependency 'byebug', '~> 8.0'
   spec.add_development_dependency 'rbtrace', '~> 0.4'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '3.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '3.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -34,30 +34,36 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +134,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-description: " Opinionated logger which outputs messages in JSON format "
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Opinionated logger which outputs messages in JSON format
 email:
 - mumismo@gmail.com
 executables: []
@@ -153,7 +173,7 @@ files:
 - lib/lorekeeper/simple_logger.rb
 - lib/lorekeeper/version.rb
 - lorekeeper.gemspec
-homepage: http://www.github.com/jordipolo/lorekeeper
+homepage: https://github.com/JordiPolo/lorekeeper
 licenses:
 - MIT
 metadata: {}
@@ -165,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -173,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Very fast JSON logger