journald-logger 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d2d53d4a1407b0920b2c2be1d0df05b1f54ab9
-  data.tar.gz: 710e877b8743df26f72ba87dafde4471f442b6a2
+  metadata.gz: eaa7f70e9a09a6429c672b60ba973d4f9d545c06
+  data.tar.gz: b01df4422dd13e47c001eddeaafe05398ded8ac7
 SHA512:
-  metadata.gz: 4cbbb86b7a317ee62d44cbcdc0e13c1659b57cde072609ffbd27e94867237f0f23b36b8a11a6f03133067b5d26b886c391c12aec1f4e1a51ead9d3bc083552dd
-  data.tar.gz: 3eafb8f19e5fcbe74827798ee9a4a81c895e00c014cba99274093296fca5c3cec13535cbec2b52b756d1d58d07ea6eb8d4565105a66818c27b107bf8b7dfd53c
+  metadata.gz: ba24c66aceca488ab25698c9db07716a5116cb1556de8d9b449f8bbd924f729941e7a09712527ff9eea2ec79dc748e4814f6b813d7172fee64089124a67480c5
+  data.tar.gz: bbdcde2b188bb1cea50809dac1d4c4aaf563be3a9b3f15380c86845588e9d13b74d8095994ba4ffe56af7233a8251fdd4c76e19d15399adb1c5b1acee566fd04

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Anton Smirnov
+Copyright (c) 2014-2015 Anton Smirnov
 
 MIT License
 

data/README.md

@@ -56,12 +56,14 @@ Tags are used to add systemd-journal fields to all subsequent log calls until re
 
 ```ruby
 logger = Journald::Logger.new('gandalf', world: 'arda') # set world tag in costructor
-logger.tag :location, 'moria' # add/replace location
-logger.tag(:object, 'balrog') do # use object field in the block
-  # log as 'MESSAGE=you shall not pass!', 'PRIORITY=4', 'LOCATION=moria', 'OBJECT=balrog', 'WORLD=arda'
+logger.tag location: 'shire', weapon: 'staff' # add/replace location and weapon
+logger.tag(location: 'moria', object: 'balrog') do # change location and use object in the block
+  # log as 'MESSAGE=you shall not pass!', 'PRIORITY=4', 'LOCATION=moria', 'OBJECT=balrog', 'WORLD=arda', 'WEAPON=staff'
   logger.warn 'you shall not pass!'
-end
-logger.untag :location # remove location
+end # return location & object to the previous state
+# log as 'MESSAGE=That was not in canon!', 'PRIORITY=6', 'LOCATION=shire', 'WORLD=arda', 'WEAPON=staff'
+logger.info 'That was not in canon!'
+logger.untag :location, :weapon # remove location and weapon
 ```
 
 Tag names must follow systemd-journal fields naming convention:
@@ -72,11 +74,11 @@ letters, numbers, underscores, cannot begin with underscore. Library upcases all
 Two methods which look similarly to native systemd-journal api
 
 ```ruby
-logger.send({
+logger.send(
   message: 'hi!',
   priority: Journald::LOG_NOTICE,
   any_field: 'any_value',
-}) # tags will be added here
+) # tags will be added here
 logger.print Journald::LOG_NOTICE, 'hi!' # and here
 ```
 
@@ -107,11 +109,11 @@ Exception logger automatically fills the following fields:
 EXCEPTION_CLASS=ExceptionRealClassName
 EXCEPTION_MESSAGE=Original exception message
 BACKTRACE=full backtrace
-CAUSE=exception cause (Ruby >= 2.1)
+CAUSE=exception cause
 GEM_LOGGER_MESSAGE_TYPE=Exception
 ```
 
-In Ruby 2.1 it also tries to log ```CODE_LINE```, ```CODE_FILE``` and ```CODE_FUNC``` and try to recurse into Cause and log it into a separate message with ```GEM_LOGGER_MESSAGE_TYPE=ExceptionCause```
+It also tries to log ```CODE_LINE```, ```CODE_FILE``` and ```CODE_FUNC``` and try to recurse into Cause and log it into a separate message with ```GEM_LOGGER_MESSAGE_TYPE=ExceptionCause```
 
 ## License
 

data/journald-logger.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_runtime_dependency 'journald-native', '~> 1.0'
 

data/lib/journald/classes/logger.rb

@@ -4,17 +4,7 @@ module Journald
     include Loggable
     include Sysloggable
 
-    def initialize(progname = nil, min_priority = nil, tags = {})
-      if progname.is_a? Hash
-        tags = progname
-        progname = min_priority = nil
-      end
-
-      if min_priority.is_a? Hash
-        tags = min_priority
-        min_priority = nil
-      end
-
+    def initialize(progname = nil, min_priority = nil, **tags)
       @tags   = tags
       @logger = Native
       self.min_priority = min_priority
@@ -26,7 +16,7 @@ module Journald
     end
 
     def progname=(value)
-      tag(:syslog_identifier, value)
+      tag(syslog_identifier: value)
     end
 
     attr_reader :min_priority
@@ -52,13 +42,22 @@ module Journald
 
     # add tags
 
-    # add tag to all log messages
-    def tag(key, value)
-      @tags[key] = value
+    # add tags to all log messages
+    def tag(**tags)
+      values = {}
+      if block_given?
+        # remember old values
+        values = tag_values(*tags.keys)
+      end
+
+      tags.each do |key, value|
+        @tags[key] = value
+      end
 
       if block_given?
         yield
-        untag(key)
+        # restore old values
+        tag(values)
       end
     end
 
@@ -67,29 +66,37 @@ module Journald
       @tags[key]
     end
 
+    # get tag values
+    # return everything including nil for non-set
+    def tag_values(*keys)
+      keys.inject({}) { |hash, key| hash[key] = @tags[key]; hash }
+    end
+
     # stop adding the tag
-    def untag(key)
-      @tags.delete(key)
+    def untag(*keys)
+      keys.each do |key|
+        @tags.delete(key)
+      end
     end
 
     protected
 
       # used internally by exception() and TraceLogger
       def tag_trace_location(location)
-        tag :code_file, location.path
-        tag :code_line, location.lineno
-        tag :code_func, location.label
+        values = tag_values(:code_file, :code_line, :code_func)
+
+        tag code_file: location.path,
+            code_line: location.lineno,
+            code_func: location.label
 
         if block_given?
           yield
-          untag_trace_location
+          tag(values)
         end
       end
 
       def untag_trace_location
-        untag :code_file
-        untag :code_line
-        untag :code_func
+        untag :code_file, :code_line, :code_func
       end
 
     private

data/lib/journald/classes/trace_logger.rb

@@ -1,6 +1,6 @@
 module Journald
   class TraceLogger
-    def initialize(progname = nil, min_priority = nil, tags = {})
+    def initialize(progname = nil, min_priority = nil, **tags)
       @wrapped_logger = ::Journald::Logger.new(progname, min_priority, tags)
     end
 
@@ -38,7 +38,4 @@ module Journald
       end
     end
   end
-
-  # alias for the old class name
-  TracerLogger = TraceLogger
 end

data/lib/journald/modules/exceptionable.rb

@@ -9,11 +9,8 @@ module Journald
       private
 
         def real_exception(e, priority, is_cause)
-          # for Ruby 2.1 get cause if present
-          cause = if e.respond_to? :cause; e.cause; end
-          # for Ruby 2.1 get backtrace if present
-          bt = e.respond_to?(:backtrace_locations) &&
-               e.backtrace_locations &&
+          # get backtrace if present
+          bt = e.backtrace_locations &&
                e.backtrace_locations.length > 0
 
           tag_trace_location(e.backtrace_locations[0]) if bt
@@ -24,13 +21,13 @@ module Journald
               gem_logger_message_type:  is_cause ? 'ExceptionCause' : 'Exception',
               exception_class:          e.class.name,
               exception_message:        e.message,
-              backtrace:                e.backtrace.join("\n"),
-              cause:                    cause ? cause.inspect : nil,
+              backtrace:                bt ? e.backtrace.join("\n"): nil,
+              cause:                    e.cause ? e.cause.inspect : nil,
           })
 
           untag_trace_location if bt
 
-          real_exception(cause, priority, true) if cause
+          real_exception(e.cause, priority, true) if e.cause
         end
     end
   end

data/lib/journald/modules/version.rb

@@ -1,5 +1,5 @@
 module Journald
   class Logger
-    VERSION = '1.1.1'
+    VERSION = '2.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journald-logger
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Anton Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: journald-native
@@ -84,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: systemd-journal native logger