logging-journald 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad48095f0f3c6a845ce0d02b237d930fa6cf7f7e
+  data.tar.gz: 5c0e263ef33b5ef0f1424ca188ac37af33ff7323
+SHA512:
+  metadata.gz: f677953b81185870ca3ca2559a49eb12227f4e6f769baf6bc4aa212b0188bf1117cbbd8ebf45eb744703b282a452b682bd6db922900411558801a337b32c5100
+  data.tar.gz: 67c8a31e1470e1987dba165b9deafecc29b2f797f6d1e3fb90c0e41646677097f8f8da3be38d7d864b4ead4d8cd4dd86f1ad9e7154e3097a3b25d6c02eb87a39

data/.gitignore

@@ -0,0 +1,7 @@
+coverage/
+doc/
+pkg/
+tmp/
+vendor/
+.rbx
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,6 @@
+---
+Metrics:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_install:
+  - sudo apt-get install -y libsystemd-journal-dev
+install: "bundle install"
+script: "bundle exec rake"
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    logging-journald (1.0.0)
+      journald-logger
+      logging
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    journald-logger (2.0.3)
+      journald-native (~> 1.0)
+    journald-native (1.0.9)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    metaclass (0.0.4)
+    mocha (1.3.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.13.1)
+    power_assert (1.1.1)
+    rake (12.3.0)
+    test-unit (3.2.7)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  logging-journald!
+  mocha
+  rake
+  test-unit
+
+BUNDLED WITH
+   1.15.3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2007-2016 Tim Pease
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+## Logging Journald
+by Lukas Zapletal [![](https://secure.travis-ci.org/lzap/logging-journald.svg)](https://travis-ci.org/lzap/logging-journald)
+
+* [Homepage](http://rubygems.org/gems/logging-journald)
+* [Github Project](https://github.com/lzap/logging-journald)
+
+### Description
+
+**Logging Journald** is a plugin for [logging gem](https://github.com/TwP/logging) - the flexible logging library for use in Ruby programs. It supports logging to system journal via journald-logger and journald-native gems.
+
+### Installation
+
+```
+gem install logging-journald
+```
+
+The gem provides journald appender and noop layout that does no formatting since core library does not provide such a layout. Apppender options are:
+
+* name - name of the appender (required)
+* ident - optional log ident (appender name by default)
+* layout - optional layout (no formatting by default)
+* mdc - log mdc into custom journal fields (true by default)
+* ndc - log ndc hash values into custom journal fields (true by default)
+* facility - optional syslog facility rendered as SYSLOG_FACILITY (LOG_USER (8) by default)
+* extra - extra custom journal fields as hash
+
+All custom fields are converted to uppercase by joudnald automatically, for more details [visit official documentation](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html).
+
+### Examples
+
+Use MDC to send arbitrary key/value pairs to system journal:
+
+```ruby
+require 'logging'
+
+log = Logging.logger['app']
+log.add_appenders(Logging.appenders.journald('myservice'))
+
+# use mapped diagnostic context to send custom fields
+Logging.mdc['signed_user'] = 'Ondra'
+logger.debug "blah blah"
+```
+
+The example above will be rendered as:
+
+```
+# journalctl -o verbose
+  MESSAGE=blah blah
+  SYSLOG_FACILITY=8
+  SIGNED_USER=Ondra
+  PRIORITY=2
+  SYSLOG_IDENTIFIER=myapp
+  _PID=25979
+  _TRANSPORT=journal
+  _UID=1000
+  _GID=1000
+  _MACHINE_ID=xxx
+  _HOSTNAME=xxx
+  _BOOT_ID=xxx
+  ...
+```
+
+Mapped diagnostic contexts are great for global values like logged user, request or session id. There are two more options to send arbitrary key/value pairs:
+
+```ruby
+require 'logging'
+
+log = Logging.logger['app']
+log.add_appenders(Logging.appenders.journald('myservice'))
+
+# nested diagnostic context is a stack of values and
+# it can be used but only hashes are taken into account
+begin
+  Logging.ndc << { exception: err, backtrace: err.backtrace }
+  log.fatal "an exception occured"
+ensure
+  Logging.ndc.clear
+end
+
+# hash can be provided instead of string but in this case
+# layout cannot be used to format message in the system journal
+log.info message: "this must be called 'message'", akey: "a value"
+```
+
+There are some examples in the [examples folder](/examples).
+
+### License
+
+The MIT License - see the [LICENSE](/LICENSE) file for the full text.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask.rb'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t .verbose = true
+end
+
+task :default => [:test]

data/examples/simple.rb

@@ -0,0 +1,31 @@
+require 'logging'
+
+log = Logging.logger['example']
+log.add_appenders(Logging.appenders.journald('simple',
+  ident: 'simple', # optional log ident (appender name by default)
+  layout: Logging.layouts.pattern(pattern: "%m\n"), # optional layout
+  mdc: true, # log mdc into custom journal fields (true by default)
+  ndc: true, # log ndc hash values into custom journal fields (true by default)
+  facility: ::Syslog::Constants::LOG_USER, # optional syslog facility
+  extra: {}, # extra custom journal fields
+  ))
+log.add_appenders(Logging.appenders.stdout)
+log.level = :debug
+
+# mapped diagnostic context is logged when mdc is set to true
+Logging.mdc['USERNAME'] = 'Ondra'
+
+# logging into journal is straight-forward
+log.debug "this is debug message"
+log.info "a very nice little info message"
+log.warn "this is your last warning"
+
+# hash instead string is supported with arbitrary key/value pairs but
+# layout is ignored in this case
+log.error message: "oh no an error", akey: "a value"
+
+# when ndc is enabled, any number of hash objects can be pushed
+# and will be logged with the message
+Logging.ndc << { akey: "a value" }
+log.fatal "an exception occured"
+Logging.ndc.clear

data/lib/logging/appenders/journald.rb

@@ -0,0 +1,95 @@
+require 'journald/logger'
+
+module Logging
+  module Appenders
+
+    def self.journald(name, *args)
+      if args.empty?
+        return self['journald'] || ::Logging::Appenders::Journald.new(name)
+      end
+      ::Logging::Appenders::Journald.new(name, *args)
+    end
+
+    class Journald < ::Logging::Appender
+      attr_reader :ident, :mdc, :ndc, :facility, :extra, :journal
+
+      def initialize(name, opts = {})
+        opts[:layout] ||= ::Logging::Layouts::Noop.new
+        @ident = opts.fetch(:ident, name)
+        @mdc = opts.fetch(:mdc, true)
+        @ndc = opts.fetch(:ndc, true)
+        @facility = Integer(opts.fetch(:facility, -1))
+        @extra = opts.fetch(:extra, {})
+        @logger_name = opts.fetch(:logger_name, false)
+        @map = [
+          ::Journald::LOG_DEBUG,
+          ::Journald::LOG_INFO,
+          ::Journald::LOG_WARNING,
+          ::Journald::LOG_ERR,
+          ::Journald::LOG_CRIT
+        ]
+        map = opts.fetch(:map, nil)
+        self.map = map unless map.nil?
+        @journal = ::Journald::Logger.new(ident, ::Journald::LOG_DEBUG)
+        #@journal.sev_threshold = ::Journald::LOG_DEBUG
+        super(name, opts)
+      end
+
+      def map=(levels)
+        map = []
+        levels.keys.each do |lvl|
+          num = ::Logging.level_num(lvl)
+          map[num] = syslog_level_num(levels[lvl])
+        end
+        @map = map
+      end
+
+      def close(*args)
+        super(false)
+      end
+
+      private
+
+      def syslog_level_num(level)
+        case level
+        when Integer; level
+        when String, Symbol
+          level = level.to_s.upcase
+          self.class.const_get level
+        else
+          raise ArgumentError, "unknown level '#{level}'"
+        end
+      end
+
+      def write(event)
+        record = {}
+        record.merge!(extra) unless extra.empty?
+        record[:SYSLOG_FACILITY] = @facility if @facility >= 0
+        record.merge!(Logging.mdc.context) if mdc
+        if ndc
+          Logging.ndc.context.each do |item|
+            record.merge!(item) if item.instance_of?(Hash)
+          end
+        end
+        if event.instance_of?(::Logging::LogEvent)
+          record[:priority] = (@map[event.level] || ::Journald::LOG_DEBUG)
+          record[@logger_name] = event.logger if @logger_name
+          if event.data.instance_of?(Hash)
+            record.merge!(event.data)
+          else
+            record[:message] = @layout.format(event)
+          end
+        else
+          record[:message] = event
+        end
+        @journal.send(record)
+        self
+      rescue StandardError => err
+        self.level = :off
+        ::Logging.log_internal 'system journal appender have been disabled'
+        ::Logging.log_internal_error(err)
+        raise(err)
+      end
+    end
+  end
+end

data/lib/logging/layouts/noop.rb

@@ -0,0 +1,13 @@
+module Logging::Layouts
+
+  def self.noop(*args)
+    return ::Logging::Layouts::Noop if args.empty?
+    ::Logging::Layouts::Noop.new(*args)
+  end
+
+  class Noop < ::Logging::Layout
+    def format(event)
+      event.data.to_s
+    end
+  end
+end

data/lib/logging/plugins/journald.rb

@@ -0,0 +1,14 @@
+module Logging
+  module Plugins
+    module Journald
+      extend self
+
+      VERSION ||= '1.0.0'.freeze
+
+      def initialize_journald
+        require File.expand_path('../../layouts/noop', __FILE__)
+        require File.expand_path('../../appenders/journald', __FILE__)
+      end
+    end
+  end
+end

data/logging-journald.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logging/plugins/journald'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logging-journald'
+  spec.version       = Logging::Plugins::Journald::VERSION
+  spec.authors       = ['Lukas Zapletal']
+  spec.email         = ['lukas-x@zapletalovi.com']
+  spec.summary       = "Journald appender for logging gem"
+  spec.description   = "Plugin for logging gem providing journald appender"
+  spec.homepage      = 'https://github.com/lzap/logging-journald'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_runtime_dependency 'journald-logger'
+  spec.add_runtime_dependency 'logging'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+end

data/test/test_appenders.rb

@@ -0,0 +1,125 @@
+require 'logging'
+require 'test/unit'
+require 'mocha/test_unit'
+
+Logging.initialize_plugins
+
+module TestLogging
+  module TestAppenders
+    DEBUG = ::Journald::LOG_DEBUG
+    INFO = ::Journald::LOG_INFO
+    WARN = ::Journald::LOG_WARNING
+    ERR = ::Journald::LOG_ERR
+    CRIT = ::Journald::LOG_CRIT
+
+    class TestJournald < Test::Unit::TestCase
+      def setup
+        @log = Logging.logger['test']
+        @log.clear_appenders
+        @log.level = :debug
+      end
+
+      def setup_appender(*args)
+        @appender = Logging.appenders.journald('simple', *args)
+        @log.add_appenders(@appender)
+      end
+
+      def test_initialize
+        setup_appender
+        assert_equal "test", @log.name
+        assert_equal 1, @log.appenders.size
+      end
+
+      def test_simple_debug_line
+        setup_appender
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: DEBUG)).once.returns(true)
+        @log.debug "test"
+      end
+
+      def test_simple_debug_line_with_facility
+        setup_appender facility: 10
+        @appender.journal.expects(:send).with(has_entries(message: "test", SYSLOG_FACILITY: 10, priority: DEBUG)).once.returns(true)
+        @log.debug "test"
+      end
+
+      def test_simple_debug_line_with_logger
+        setup_appender logger_name: :lg
+        @appender.journal.expects(:send).with(has_entries(message: "test", lg: 'test', priority: DEBUG)).once.returns(true)
+        @log.debug "test"
+      end
+
+      def test_simple_debug_line_level_info
+        setup_appender
+        @log.level = :info
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: DEBUG)).never.returns(true)
+        @log.debug "test"
+      end
+
+      def test_simple_info_line
+        setup_appender
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: INFO)).once.returns(true)
+        @log.info "test"
+      end
+
+      def test_simple_warning_line
+        setup_appender
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: WARN)).once.returns(true)
+        @log.warn "test"
+      end
+
+      def test_simple_error_line
+        setup_appender
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: ERR)).once.returns(true)
+        @log.error "test"
+      end
+
+      def test_simple_fatal_line
+        setup_appender
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: CRIT)).once.returns(true)
+        @log.fatal "test"
+      end
+
+      def test_simple_debug_line_as_hash
+        setup_appender
+        @appender.journal.expects(:send).with(has_entries("message" => "test", priority: DEBUG)).once.returns(true)
+        @log.debug "message" => "test"
+      end
+
+      def test_simple_debug_line_as_hash_with_layout
+        setup_appender(layout: Logging.layouts.pattern(pattern: "X %m X"))
+        @appender.journal.expects(:send).with(has_entries("message" => "test", priority: DEBUG)).once.returns(true)
+        @log.debug "message" => "test"
+      end
+
+      def test_simple_info_line_with_mdc
+        setup_appender
+        Logging.mdc['test'] = 'value'
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: INFO, "test" => "value")).once.returns(true)
+        @log.info "test"
+      ensure
+        Logging.mdc.clear
+      end
+
+      def test_simple_info_line_with_ndc
+        setup_appender
+        Logging.ndc << { test: "value" }
+        @appender.journal.expects(:send).with(has_entries(message: "test", priority: INFO, test: "value")).once.returns(true)
+        @log.info "test"
+      ensure
+        Logging.ndc.clear
+      end
+
+      def test_simple_info_line_with_layout_mdc_ndc
+        setup_appender(layout: Logging.layouts.pattern(pattern: "%m %X{test1} %x"))
+        Logging.mdc['test1'] = 'value'
+        Logging.ndc << { "test2" => "value" }
+        @appender.journal.expects(:send).with(has_entries(message: "test value {\"test2\"=>\"value\"}", priority: INFO, "test1" => "value", "test2" => "value")).once.returns(true)
+        @log.info "test"
+      ensure
+        Logging.mdc.clear
+        Logging.ndc.clear
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: logging-journald
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lukas Zapletal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: journald-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: Plugin for logging gem providing journald appender
+email:
+- lukas-x@zapletalovi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- examples/simple.rb
+- lib/logging/appenders/journald.rb
+- lib/logging/layouts/noop.rb
+- lib/logging/plugins/journald.rb
+- logging-journald.gemspec
+- test/test_appenders.rb
+homepage: https://github.com/lzap/logging-journald
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Journald appender for logging gem
+test_files:
+- test/test_appenders.rb