rt-logman 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb547bfe89e346a9c9198e1fe5f49c536d8a81e8
-  data.tar.gz: 6fd763746e3360aef85d2296002ecad1fbf28693
+  metadata.gz: 3532e63f6b57a4160f02ef0d59b85b66ebb8eff6
+  data.tar.gz: 728484d7773b6767795a6a1b1cb474fb55e6bab3
 SHA512:
-  metadata.gz: c48037c426a5a926734a06cf3a9e0feaf40eb4752ae7a36e4847914f672374f46cdbd5f350cf5c9f09777c0d6e60f0a2def30e52e8edf9b3c7534ec8d00102fa
-  data.tar.gz: 83ab488cf6dc57d35790134b385b9d6d7ff1ca860bc1f9c943863ed158f86e3710ce3e298c2d6b7404216b4df6421dab525d2d38f4a92b4543618cbdd14b02de
+  metadata.gz: 3c975db44a0a5d3721f2fc81267d45a4a7ba4c9e1a75841c0506ff5abdc29df2a51713a0654772d247c87f350e1a6c93cea47a82da7aad193856d5dc0c29e7fc
+  data.tar.gz: 5435f732788c988d6303a6c56783ccea9e09edb0251f64c04d3830098729a38c54a9446294fbedce1fc877602e8fa825ec255f3c468fdf7f817df11e0324225e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rt-logman (0.10.0)
+    rt-logman (0.11.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -21,7 +21,7 @@ To log an informative message to STDOUT, use the following code snippet:
 Logman.info("Hello World")
 
 # Output:
-# level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Hello World'
+# {"level":"INFO","time":"2017-12-12 09:33:00 +0000","pid":10950,"message":"Hello World"}
 ```
 
 Every log event can be extended with metadata — a hash with key value pairs:
@@ -30,7 +30,7 @@ Every log event can be extended with metadata — a hash with key value pairs:
 Logman.info("Hello World", :from => "renderedtext", :to => "The World")
 
 # Output:
-# level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Hello World' from='renderedtext' to='The World'
+# {"level":"INFO","time":"2017-12-12 09:33:21 +0000","pid":10950,"message":"Hello World","from":"renderedtext","to":"The World"}
 ```
 
 Every log event has a severity. In the previous examples we have used `info`. To
@@ -40,7 +40,7 @@ log an `error` use the following snippet:
 Logman.error("Team does not exists", :owner => "renderedtext", :team_name => "z-fightes")
 
 # Output:
-# level='E' time='2017-12-11 09:47:27 +0000' pid='1234' event='Team does not exists' owner='renderedtext' team_name='z-fighters'
+# {"level":"ERROR","time":"2017-12-12 09:33:47 +0000","pid":10950,"message":"Team does not exists","owner":"renderedtext","team_name":"z-fightes"}
 ```
 
 Logman supports multiple severity levels:
@@ -95,7 +95,7 @@ class VideoProcessor
 
     @logger.info("finished")
   rescue => exception
-    @logger.error("failed", :message => exception.message)
+    @logger.error("failed", :exception => exception.message)
 
     raise
   end
@@ -106,18 +106,18 @@ end
 In case of a successful processing of a video, we would see the following:
 
 ``` txt
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='started' id='31312' title='Keyboard Cat' component='video_processor'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='loaded into memory' component='video_processor' id='31312' title='Keyboard Cat' size='3123131312'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='compressed' component='video_processor' id='31312' title='Keyboard Cat' size='12312312'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='upload_to_s3' component='video_processor' id='31312' title='Keyboard Cat' s3_path='s3://random'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='finished' component='video_processor' id='31312' title='Keyboard Cat'
+{"level":"INFO","time":"2017-12-12 09:35:19 +0000","pid":10950,"message":"started","compoent":"video_processor","id":9312,"title":"Keyboard Cat"}
+{"level":"INFO","time":"2017-12-12 09:35:34 +0000","pid":10950,"message":"loaded into memory","compoent":"video_processor","id":9312,"title":"Keyboard Cat","size":41241241}
+{"level":"INFO","time":"2017-12-12 09:35:44 +0000","pid":10950,"message":"compressed","compoent":"video_processor","id":9312,"title":"Keyboard Cat","size":1312312}
+{"level":"INFO","time":"2017-12-12 09:36:08 +0000","pid":10950,"message":"uploaded to S3","compoent":"video_processor","id":9312,"title":"Keyboard Cat","s3_path":"s3://hehe/a.mpeg"}
+{"level":"INFO","time":"2017-12-12 09:36:27 +0000","pid":10950,"message":"finished","compoent":"video_processor","id":9312,"title":"Keyboard Cat"}
 ```
 
 In case of an error, we would see the following:
 
 ``` txt
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='started' id='31312' title='Keyboard Cat' component='video_processor'
-level='E' time='2017-12-11 09:47:27 +0000' pid='1234' event='failed' component='video_processor' id='31312' title='Keyboard Cat' message='Out of memory'
+{"level":"INFO","time":"2017-12-12 09:35:19 +0000","pid":10950,"message":"started","compoent":"video_processor","id":9312,"title":"Keyboard Cat"}
+{"level":"ERROR","time":"2017-12-12 09:35:34 +0000","pid":10950,"message":"failed","compoent":"video_processor","id":9312,"title":"Keyboard Cat","size":41241241,"exception": "Out of memory"}
 ```
 
 Logman can receive a [Ruby Logger](http://ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html)
@@ -151,7 +151,7 @@ create a new Logman instance with the same fields as the previous instance:
 
 @team_api_logger.info("Hello")
 
-# level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Hello' version='v2'
+# {"level":"INFO","time":"2017-12-12 09:39:07 +0000","pid":10950,"message":"Hello","version":"v2"}
 ```
 
 With Logman, you can instrument data processing with a logger block. For
@@ -166,18 +166,18 @@ Logman.process("user-registration", :username => "shiroyasha") do |logger|
   logger.info("Sent signup email")
 
   team.add(user)
-  logger.info("Added user to a team", :team_id => team)
+  logger.info("Added user to a team", :team_id => team.id)
 end
 ```
 
 The above will log the following information:
 
 ``` txt
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-started' username='shiroyasha'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='User Record Created' username='shiroyasha'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Sent signup email' username='shiroyasha'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Added user to a team' username='shiroyasha' team_id='312'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-finished' username='shiroyasha'
+{"level":"INFO","time":"2017-12-12 09:40:39 +0000","pid":10950,"message":"user-registration-started","username":"shiroyasha"}
+{"level":"INFO","time":"2017-12-12 09:40:39 +0000","pid":10950,"message":"User Record Created","username":"shiroyasha"}
+{"level":"INFO","time":"2017-12-12 09:40:39 +0000","pid":10950,"message":"Sent signup email","username":"shiroyasha"}
+{"level":"INFO","time":"2017-12-12 09:40:39 +0000","pid":10950,"message":"Added user to a team","username":"shiroyasha","team_id":21}
+{"level":"INFO","time":"2017-12-12 09:40:39 +0000","pid":10950,"message":"user-registration-finished","username":"shiroyasha"}
 ```
 
 In case of an exception, the error will be logger and re-thrown:
@@ -198,10 +198,10 @@ end
 ```
 
 ``` ruby
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-started' username='shiroyasha'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='User Record Created' username='shiroyasha'
-level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Sent signup email' username='shiroyasha'
-level='E' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-failed' username='shiroyasha' type='RuntimeError' message='Exception'
+{"level":"INFO","time":"2017-12-12 09:41:27 +0000","pid":10950,"message":"user-registration-started","username":"shiroyasha"}
+{"level":"INFO","time":"2017-12-12 09:41:27 +0000","pid":10950,"message":"User Record Created","username":"shiroyasha"}
+{"level":"INFO","time":"2017-12-12 09:41:27 +0000","pid":10950,"message":"Sent signup email","username":"shiroyasha"}
+{"level":"ERROR","time":"2017-12-12 09:41:27 +0000","pid":10950,"message":"Exception","username":"shiroyasha","type":"RuntimeError"}
 ```
 
 ## Development

data/lib/logman/version.rb

@@ -1,3 +1,3 @@
 class Logman
-  VERSION = "0.10.0".freeze
+  VERSION = "0.11.0".freeze
 end

data/lib/logman.rb

@@ -1,5 +1,6 @@
 require "logman/version"
 require "logger"
+require "json"
 
 # :reek:PrimaDonnaMethod { exclude: [clear! ] }
 # :reek:TooManyStatements{ exclude: [process ] }
@@ -71,13 +72,13 @@ class Logman
   private
 
   def log(level, message, metadata = {})
-    @logger.public_send(level, { :event => message }.merge(@fields).merge(metadata))
+    @logger.public_send(level, { :message => message }.merge(@fields).merge(metadata))
   end
 
   def formatter
     proc do |severity, datetime, _progname, msg|
       event = {
-        :level => severity[0].upcase,
+        :level => severity.upcase,
         :time => datetime,
         :pid => Process.pid
       }.merge(msg)
@@ -87,6 +88,6 @@ class Logman
   end
 
   def format(event_hash)
-    event_hash.map { |key, value| "#{key}='#{value}'" }.join(" ")
+    event_hash.to_json
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rt-logman
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rendered Text
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Logman, formalized logging micro-abstraction