journald-logger 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8729c7c1ba62b774a54972c7d3a0b23d4d5b3998
-  data.tar.gz: 40fe1b977ba36e122aa05c60732c654b7044b3dd
+  metadata.gz: facbc1ed0842610f785cefd1744337d8f76c282f
+  data.tar.gz: 3f90384e426a5009ba0dab5dfd412572e1407946
 SHA512:
-  metadata.gz: 5e83926ed316069259f4278b20434bcbb7e90ae81b570499b6453b2cbedc5f82df18e8e444de3d9c25924be7ea8109d38ca177bd2da993dacf38bbecb415db7a
-  data.tar.gz: 937543adba69ae300afb6036a7e579523d031e3b7261f444f2eb640570c24bf2ebb05fbaece13a476a5d850b545685c2a924c3f52a9d2549d17caca4a580d2f8
+  metadata.gz: f269abff54386cb0cfadbbadffec2125e782c8d91e9093850c546fa369b59273ff3a694d1925651c7f72bc961c8944eb5046e59084a92b9f8c8dd856defe58ca
+  data.tar.gz: 4d41970f8f8bb429ef8d1067ab65b6c0112c4572caf02daa6414ff4a00cc55911109a2268b2e7a32edc0d0f3ac68384375ec6dc20592cf65872fe13972f45fb9

data/README.md

@@ -0,0 +1,82 @@
+# journald-logger
+
+A Logger drop-in replacement that logs directly to systemd-journal with some additional features
+
+## Usage
+
+```ruby
+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 replacement
+
+This gem is designed to be accurate drop-in Logger replacement
+
+```ruby
+logger.warn "you shall not pass!"           # works
+logger.info("gollum") { "my preciousss" }   # also works!
+logger.progname = "saruman"                 # sets value for SYSLOG_IDENTIFIER to 'saruman'
+logger.formatter = SomeFormatter.new        # does nothing, journald-logger does not require a formatter
+logger.close                                # does nothing, nothing to close
+```
+
+We map Ruby severity to Syslog priority by this map
+
+```ruby
+LEVEL_MAP = {
+  ::Logger::UNKNOWN => LOG_ALERT,
+  ::Logger::FATAL   => LOG_CRIT,
+  ::Logger::ERROR   => LOG_ERR,
+  ::Logger::WARN    => LOG_WARNING,
+  ::Logger::INFO    => LOG_INFO,
+  ::Logger::DEBUG   => LOG_DEBUG,
+}
+```
+
+You may notice it's somewhat different from the one from Syslog::Logger
+
+## Tags
+
+Tags are used to add systemd-journal fields to all subsequent log calls until removed
+
+```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.warn 'you shall not pass!'
+end
+logger.untag :location # remove location
+```
+
+Tag names must follow systemd-journal fields naming convention:
+letters, numbers, underscores, cannot begin with underscore. Library upcases all letters automatically
+
+## systemd-journal style
+
+Two methods which look similarly to native systemd-journal api
+
+```ruby
+logger.send({
+  message: 'hi!',
+  priority: Journald::LOG_NOTICE,
+  any_field: 'any_value',
+}) # tags will be added here
+logger.print Journald::LOG_NOTICE, 'hi!' # and here
+```
+
+## Syslog style
+
+Just to add some more confusion you may use methods with syslog severity names prefixed with ```log_```
+
+```ruby
+logger.log_err 'Error'
+logger.log_debug 'Debug'
+```
+
+## License
+
+MIT, see LICENSE.txt

data/journald-logger.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'journald/logger/version'
@@ -17,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 = '>= 1.9.2'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_runtime_dependency 'journald-native', '~> 1.0'
 

data/lib/journald/logger/exceptionable.rb

@@ -0,0 +1,35 @@
+module Journald
+  class Logger
+    module Exceptionable
+      def exception(e, priority: nil, severity: nil)
+        priority ||= severity_to_priority(severity) || Journald::LOG_CRIT
+        real_exception(e, priority, false)
+      end
+
+      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.length > 0
+
+          tag_trace_location(e.backtrace_locations[0]) if bt
+
+          send({
+              priority:                 priority,
+              message:                  "Exception #{e.inspect}",
+              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,
+          })
+
+          untag_trace_location if bt
+
+          real_exception(cause, priority, true) if cause
+        end
+    end
+  end
+end

data/lib/journald/logger/loggable.rb

@@ -0,0 +1,85 @@
+module Journald
+  class Logger
+    module Loggable
+      # ruby Logger style
+
+      # our map differs from Syslog::Logger
+      LEVEL_MAP = {
+          ::Logger::UNKNOWN => LOG_ALERT,
+          ::Logger::FATAL   => LOG_CRIT,
+          ::Logger::ERROR   => LOG_ERR,
+          ::Logger::WARN    => LOG_WARNING,
+          ::Logger::INFO    => LOG_INFO,
+          ::Logger::DEBUG   => LOG_DEBUG,
+      }
+
+      def add(severity, message = nil, progname = nil, &block)
+        priority = severity_to_priority(severity) || LEVEL_MAP[::Logger::UNKNOWN]
+
+        # some black magic from Logger O__o
+        progname ||= self.progname
+        if message.nil?
+          if block_given?
+            message = block.call
+          else
+            message = progname
+            progname = self.progname
+          end
+        end
+
+        send({
+            priority: priority,
+            message:  message,
+            syslog_identifier: progname,
+        })
+      end
+
+      alias_method :log, :add
+
+      # add methods a la Logger.warn or Logger.error
+      ::Logger::Severity::constants.each do |severity|
+        severity_key   = severity.downcase
+        severity_value = ::Logger::Severity.const_get(severity)
+
+        define_method(severity_key) do |progname = nil, &block|
+          add(severity_value, nil, progname, &block)
+        end
+
+        define_method("#{severity_key}?".to_sym) do
+          true # journald always logs everything
+        end
+      end
+
+      def <<(value)
+        debug(value)
+      end
+
+      # Logger accessors
+
+      # journald always logs everything
+      def level
+        ::Logger::DEBUG
+      end
+
+      def sev_threshold
+        ::Logger::DEBUG
+      end
+
+      def level=(_); end
+      def sev_threshold=(_); end
+
+      # journald does not require formatter or formatting
+      def formatter; end
+      def formatter=(_); end
+      def datetime_format; end
+      def datetime_format=(_); end
+
+      def close; end
+
+      private
+        def severity_to_priority(severity)
+          LEVEL_MAP[severity]
+        end
+    end
+  end
+end

data/lib/journald/logger/sysloggable.rb

@@ -0,0 +1,13 @@
+module Journald
+  class Logger
+    module Sysloggable
+      # methods with syslog priorities like logger.log_err, logger.log_warning
+      [:LOG_EMERG, :LOG_ALERT, :LOG_CRIT, :LOG_ERR, :LOG_WARNING, :LOG_NOTICE, :LOG_INFO, :LOG_DEBUG].each do |level|
+        define_method(level.downcase) do |message = nil, &block|
+          message ||= block.call
+          print(Journald.const_get(level), message)
+        end
+      end
+    end
+  end
+end

data/lib/journald/logger/version.rb

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

data/lib/journald/logger.rb

@@ -1,6 +1,102 @@
-require 'journald/logger/version'
+require 'logger'
+require 'journald/native'
+
+require_relative 'logger/version'
+require_relative 'logger/exceptionable'
+require_relative 'logger/loggable'
+require_relative 'logger/sysloggable'
+
+require_relative 'tracer_logger'
 
 module Journald
-  module Logger
+  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

data/lib/journald/tracer_logger.rb

@@ -0,0 +1,18 @@
+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

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: journald-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Anton Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: journald-native
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -59,14 +59,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - journald-logger.gemspec
 - 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
 homepage: https://github.com/sandfox-im/journald-logger
 licenses:
 - MIT
@@ -77,19 +81,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: systemd-journal native logger
 test_files: []
-has_rdoc: 

data/README.rdoc

@@ -1,5 +0,0 @@
-= journald-logger
-
-Logger that logs directly to systemd-journal
-
-Work in progress, still not usable