journald-logger 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: facbc1ed0842610f785cefd1744337d8f76c282f
-  data.tar.gz: 3f90384e426a5009ba0dab5dfd412572e1407946
+  metadata.gz: 9687426a5dfa6a08d6911f0039a2b96baf58f59b
+  data.tar.gz: bbd7f7f9ef41c560dbaff136dcbf7796c7785495
 SHA512:
-  metadata.gz: f269abff54386cb0cfadbbadffec2125e782c8d91e9093850c546fa369b59273ff3a694d1925651c7f72bc961c8944eb5046e59084a92b9f8c8dd856defe58ca
-  data.tar.gz: 4d41970f8f8bb429ef8d1067ab65b6c0112c4572caf02daa6414ff4a00cc55911109a2268b2e7a32edc0d0f3ac68384375ec6dc20592cf65872fe13972f45fb9
+  metadata.gz: 6e95eb9a3d24918e802228d5789916ffff5992182a33e4abf1f20fffbf11fc6159b6c394f44e3f34e52060c3b76721ba717a306d3a3976ab7ac569d870985e50
+  data.tar.gz: a995a08142c11a182ab6d8025b82aaf0b1b3d3d1b5d348d194fcaf845b2908e68346bf74abd190560e0fa4ce29d36e2f8d8ad544de10f4198468d247137dde79

data/.gitignore

@@ -21,6 +21,7 @@ tmp
 *.a
 mkmf.log
 Makefile
+.idea/
 *.iml
 *.ipr
 *.iws

data/README.md

@@ -1,5 +1,8 @@
 # journald-logger
 
+[![Gem Version](https://badge.fury.io/rb/journald-logger.svg)](http://badge.fury.io/rb/journald-logger)
+[![Reference Status](https://www.versioneye.com/ruby/journald-logger/reference_badge.svg)](https://www.versioneye.com/ruby/journald-logger/references)
+
 A Logger drop-in replacement that logs directly to systemd-journal with some additional features
 
 ## Usage
@@ -8,7 +11,7 @@ A Logger drop-in replacement that logs directly to systemd-journal with some add
 require 'journald/logger'
 
 logger = Journald::Logger.new('gandalf') # simple logger, sets SYSLOG_IDENTIFIER to 'gandalf'
-logger = Journald::TracerLogger.new('gandalf') # tracing logger, logs caller's file, line number and function name
+logger = Journald::TraceLogger.new('gandalf') # tracing logger, logs caller's file, line number and function name
 ```
 
 ## Logger replacement
@@ -77,6 +80,30 @@ logger.log_err 'Error'
 logger.log_debug 'Debug'
 ```
 
+## Exception logging
+
+```ruby
+begin
+  raise "Aw, snap!"
+rescue => e
+  logger.exception e # log exception with LOG_CRIT level by default
+  logger.exception e, severity: Logger::WARN        # use Logger severity
+  logger.exception e, priority: Journald::LOG_ALERT # use Syslog priority 
+end
+```
+
+Exception logger automatically fills the following fields:
+
+```
+EXCEPTION_CLASS=ExceptionRealClassName
+EXCEPTION_MESSAGE=Original exception message
+BACKTRACE=full backtrace
+CAUSE=exception cause (Ruby >= 2.1)
+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```
+
 ## License
 
 MIT, see LICENSE.txt

data/journald-logger.gemspec

@@ -1,6 +1,6 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'journald/logger/version'
+require 'journald/modules/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'journald-logger'

data/lib/journald/classes/logger.rb

@@ -0,0 +1,93 @@
+module Journald
+  class Logger
+    include Exceptionable
+    include Loggable
+    include Sysloggable
+
+    def initialize(progname = nil, tags = {})
+      @tags   = tags
+      @logger = Native
+      self.progname = progname
+    end
+
+    def progname
+      tag_value(:syslog_identifier)
+    end
+
+    def progname=(value)
+      tag(:syslog_identifier, value)
+    end
+
+    # systemd-journal style
+
+    # send systemd-journal message
+    def send(hash)
+      hash_to_send = @tags.merge(hash)
+      real_send(hash_to_send)
+    end
+
+    def print(priority, message)
+      send({
+        priority: priority,
+        message:  message,
+      })
+    end
+
+    # add tags
+
+    # add tag to all log messages
+    def tag(key, value)
+      @tags[key] = value
+
+      if block_given?
+        yield
+        untag(key)
+      end
+    end
+
+    # get tag value
+    def tag_value(key)
+      @tags[key]
+    end
+
+    # stop adding the tag
+    def untag(key)
+      @tags.delete(key)
+    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
+
+        if block_given?
+          yield
+          untag_trace_location
+        end
+      end
+
+      def untag_trace_location
+        untag :code_file
+        untag :code_line
+        untag :code_func
+      end
+
+    private
+
+      def real_send(hash)
+        hash = hash.delete_if { |_, v| v.nil? }
+
+        array_to_send = hash.map do |k,v|
+          key = k.to_s.upcase
+          value = v.to_s
+
+          "#{key}=#{value}"
+        end
+
+        @logger.send(*array_to_send)
+      end
+  end
+end

data/lib/journald/classes/trace_logger.rb

@@ -0,0 +1,40 @@
+module Journald
+  class TraceLogger
+    def initialize(progname = nil, tags = {})
+      @wrapped_logger = Logger.new(progname, tags)
+    end
+
+    PASSTHROUGH_METHODS = [
+        :tag,
+        :tag_value,
+        :untag,
+        :progname,
+        :'progname=',
+        :level,
+        :'level=',
+    ]
+
+    METHODS = (
+      Journald::Logger.               public_instance_methods(false) +
+      Journald::Logger::Exceptionable.public_instance_methods(false) +
+      Journald::Logger::Loggable.     public_instance_methods(false) +
+      Journald::Logger::Sysloggable.  public_instance_methods(false)
+    )
+
+    METHODS.each do |method|
+      if PASSTHROUGH_METHODS.include? method
+        define_method(method) do |*args, &block|
+          @wrapped_logger.public_send(method, *args, &block)
+        end
+      else
+        define_method(method) do |*args, &block|
+          @wrapped_logger.__send__(:tag_trace_location, caller_locations[0])
+          @wrapped_logger.public_send(method, *args, &block)
+        end
+      end
+    end
+  end
+
+  # alias for the old class name
+  TracerLogger = TraceLogger
+end

data/lib/journald/logger.rb

@@ -1,102 +1,10 @@
 require 'logger'
 require 'journald/native'
 
-require_relative 'logger/version'
-require_relative 'logger/exceptionable'
-require_relative 'logger/loggable'
-require_relative 'logger/sysloggable'
+require_relative 'modules/version'
+require_relative 'modules/exceptionable'
+require_relative 'modules/loggable'
+require_relative 'modules/sysloggable'
 
-require_relative 'tracer_logger'
-
-module Journald
-  class Logger
-    include Exceptionable
-    include Loggable
-    include Sysloggable
-
-    def initialize(progname = nil, tags = {})
-      @tags   = tags
-      @logger = Native
-      self.progname = progname
-    end
-
-    def progname
-      tag_value(:syslog_identifier)
-    end
-
-    def progname=(value)
-      tag(:syslog_identifier, value)
-    end
-
-    # systemd-journal style
-
-    # send systemd-journal message
-    def send(hash)
-      hash_to_send = @tags.merge(hash)
-      real_send(hash_to_send)
-    end
-
-    def print(priority, message)
-      send({
-        priority: priority,
-        message:  message,
-      })
-    end
-
-    # add tags
-
-    # add tag to all log messages
-    def tag(key, value)
-      @tags[key] = value
-
-      if block_given?
-        yield
-        untag(key)
-      end
-    end
-
-    # get tag value
-    def tag_value(key)
-      @tags[key]
-    end
-
-    # stop adding the tag
-    def untag(key)
-      @tags.delete(key)
-    end
-
-    protected
-
-      def tag_trace_location(location)
-        tag :code_file, location.path
-        tag :code_line, location.lineno
-        tag :code_func, location.label
-
-        if block_given?
-          yield
-          untag_trace_location
-        end
-      end
-
-      def untag_trace_location
-        untag :code_file
-        untag :code_line
-        untag :code_func
-      end
-
-    private
-
-      def real_send(hash)
-        hash = hash.delete_if { |_, v| v.nil? }
-
-        array_to_send = hash.map do |k,v|
-          key = k.to_s.upcase
-          value = v.to_s
-
-          "#{key}=#{value}"
-        end
-
-        @logger.send(*array_to_send)
-      end
-  end
-end
+require_relative 'classes/logger'
+require_relative 'classes/trace_logger'

data/lib/journald/{logger → modules}/version.rb

@@ -1,5 +1,5 @@
 module Journald
   class Logger
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journald-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Anton Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: journald-native
@@ -65,12 +65,13 @@ files:
 - README.md
 - Rakefile
 - journald-logger.gemspec
+- lib/journald/classes/logger.rb
+- lib/journald/classes/trace_logger.rb
 - lib/journald/logger.rb
-- lib/journald/logger/exceptionable.rb
-- lib/journald/logger/loggable.rb
-- lib/journald/logger/sysloggable.rb
-- lib/journald/logger/version.rb
-- lib/journald/tracer_logger.rb
+- lib/journald/modules/exceptionable.rb
+- lib/journald/modules/loggable.rb
+- lib/journald/modules/sysloggable.rb
+- lib/journald/modules/version.rb
 homepage: https://github.com/sandfox-im/journald-logger
 licenses:
 - MIT
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: systemd-journal native logger

data/lib/journald/tracer_logger.rb

@@ -1,18 +0,0 @@
-module Journald
-  class TracerLogger
-    def initialize(progname = nil, tags = {})
-      @wrapped_logger = Logger.new(progname, tags)
-    end
-
-    def method_missing(meth, *args, &block)
-      super unless @wrapped_logger.respond_to? meth
-
-      @wrapped_logger.__send__(:tag_trace_location, caller_locations[0])
-      @wrapped_logger.__send__(meth, *args, &block)
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      @wrapped_logger.respond_to?(method_name, include_private)
-    end
-  end
-end