semantic_logger_journald 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 260b0fd7d7c655738989c1600094585550ce4d35a077ca94253f9e957dcaf317
+  data.tar.gz: 18dfcb5cf593531d3de481ac66f73471bc9feb041727235ec70f9c19edfe2cca
+SHA512:
+  metadata.gz: 023b495d21b0dbd9a876b4b3c1fe48f9f4a8ba78f2eadd87298186e49d173a82463db26de7049e2df92e9a84540c3edba359fbbf7069963e9299e6ef322fe36f
+  data.tar.gz: dc3b15c1f272f42dcb101227cc4133df9c1068020cab2d9bca1cdc8914a2bc714830a7d258cb7dd8d3394111d4f85fe953ba3a6c5a03b1b13b5fc6efa7c6ccdf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in semantic_logger_journald.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "rerun"

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    semantic_logger_journald (0.2.0)
+      journald-logger (~> 3.0)
+      semantic_logger (~> 4.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.6)
+    ffi (1.13.1)
+    journald-logger (3.0.1)
+      journald-native (~> 1.0)
+    journald-native (1.0.12)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.14.1)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rerun (0.13.0)
+      listen (~> 3.0)
+    semantic_logger (4.7.1)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rerun
+  semantic_logger_journald!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 scarfacedeb
+
+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,80 @@
+# SemanticLoggerJournald
+
+Plugin for semantic_logger that adds appender to send logs into journald.
+
+It uses [journald-logger](https://github.com/theforeman/journald-logger) under the hood.
+
+## Installation
+
+```ruby
+gem "semantic_logger_journald", "~> 0.1"
+```
+
+## Usage
+
+To add journald appender to semantic_logger:
+
+```ruby
+require "semantic_logger_journald"
+
+journald_appender = SemanticLoggerJournald::Appender.new(syslog_id: "my_service")
+SemanticLogger.add_appender(appender: journald_appender)
+
+logger = SemanticLogger[MyClass]
+logger.info "Signed In", user_id: 1
+```
+
+You can also directly pass a journald-logger instance:
+
+```ruby
+jlogger = Journald::Logger.new("my_service")
+journald_appender = SemanticLoggerJournald::Appender.new(logger: jlogger)
+SemanticLogger.add_appender(appender: journald_appender)
+```
+
+## Formatter
+
+By default, `SemanticLoggerJournald::Formatter` flattens the payload keys to convert them into individual fields:
+
+```ruby
+logger.info "Paid", order: { id: 1, status: "new" }
+```
+
+It'll produce the following journald fields:
+
+```
+MESSAGE=Paid
+ORDER__ID=1
+ORDER__STATUS=new
+```
+
+If you'd rather keep the payload intact, pass a custom formatter:
+
+```ruby
+formatter = SemanticLoggerJournald::Formatter.new(flatten_payload: false)
+
+journald_appender = SemanticLoggerJournald::Appender.new(
+  syslog_id: "my_service", 
+  formatter: formatter
+)
+
+SemanticLogger.add_appender(appender: journald_appender)
+
+logger.info "Paid", order: { id: 1, status: "new" }
+```
+
+It'll produce the following journald fields:
+
+```
+MESSAGE=Paid
+ORDER={ id: 1, status: "new" }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scarfacedeb/semantic_logger_journald.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "semantic_logger_journald"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rerun

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rerun' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rerun", "rerun")

data/lib/semantic_logger_journald.rb

@@ -0,0 +1,5 @@
+require "semantic_logger_journald/version"
+require "semantic_logger_journald/appender"
+
+module SemanticLoggerJournald
+end

data/lib/semantic_logger_journald/appender.rb

@@ -0,0 +1,24 @@
+require "semantic_logger"
+require "journald/logger"
+require "semantic_logger_journald/formatter"
+
+module SemanticLoggerJournald
+  class Appender < SemanticLogger::Subscriber
+    attr_reader :logger
+
+    def initialize(logger: nil, syslog_id: nil, **args, &block)
+      @logger = logger || Journald::Logger.new(syslog_id)
+      super(**args, &block)
+    end
+
+    def log(log)
+      @logger.send_message(formatter.call(log, self))
+    end
+
+    private
+
+    def default_formatter
+      SemanticLoggerJournald::Formatter.new
+    end
+  end
+end

data/lib/semantic_logger_journald/formatter.rb

@@ -0,0 +1,79 @@
+module SemanticLoggerJournald
+  class Formatter < SemanticLogger::Formatters::Raw
+    LEVEL_MAP = {
+      trace: Journald::LOG_DEBUG,
+      debug: Journald::LOG_DEBUG,
+      info: Journald::LOG_INFO,
+      warn: Journald::LOG_WARNING,
+      error: Journald::LOG_ERR,
+      fatal: Journald::LOG_CRIT
+    }.freeze
+
+    KEY_JOIN = "__"
+
+    def initialize(flatten_payload: KEY_JOIN, time_format: nil, **args)
+      @flatten_payload = flatten_payload
+      super(time_format: time_format, **args)
+    end
+
+    def level
+      hash[:priority] = LEVEL_MAP.fetch(log.level)
+    end
+
+    def time
+      hash[:syslog_timestamp] = time_format ? format_time(log.time) : format_syslog_time(log.time)
+    end
+
+    # It's already logged by journald as _PID
+    def pid
+      nil
+    end
+
+    def tags
+      hash.merge!(log.tags.map { |t| [t, 1] }.to_h) if log.tags&.any?
+    end
+
+    def named_tags
+      hash.merge!(log.named_tags) if log.named_tags&.any?
+    end
+
+    def payload
+      return if !log.payload || log.payload.empty?
+
+      payload = log.payload
+      payload = flatten_hash(payload) if flatten_payload?
+      hash.merge!(payload)
+    end
+
+    private
+
+    def flatten_payload?
+      log.payload&.any? && @flatten_payload
+    end
+
+    def flatten_hash(nested_hash)
+      nested_hash.each_with_object({}) do |(key, val), h|
+        if val.is_a?(Hash)
+          flatten_hash(val).map { |nested_key, nested_val|
+            h[join_keys(key, nested_key)] = nested_val
+          }
+        else
+          h[key] = val
+        end
+      end
+    end
+
+    def join_keys(*args)
+      args.join(@flatten_payload).to_sym
+    end
+
+    # from syslog_protocol gem
+    def format_syslog_time(time)
+      # The timestamp format requires that a day with fewer than 2 digits have
+      # what would normally be a preceding zero, be instead an extra space.
+      day = time.strftime("%d")
+      day = day.sub(/^0/, " ") if day =~ /^0\d/
+      time.strftime("%b #{day} %H:%M:%S")
+    end
+  end
+end

data/lib/semantic_logger_journald/version.rb

@@ -0,0 +1,3 @@
+module SemanticLoggerJournald
+  VERSION = "0.2.0"
+end

data/semantic_logger_journald.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/semantic_logger_journald/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "semantic_logger_journald"
+  spec.version       = SemanticLoggerJournald::VERSION
+  spec.authors       = ["Andrew Volozhanin"]
+  spec.email         = ["scarfacedeb@gmail.com"]
+
+  spec.summary       = %q{Plugin for semantic_logger gem providing systemd-journal appender}
+  spec.description   = %q{Plugin for semantic_logger that adds appender to send logs into journald. It depends on journald-native gem that provides the C-bindings}
+  spec.homepage      = "https://rubygems.org/gems/semantic_logger_journald"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/scarfacedeb/semantic_logger_journald/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "semantic_logger", "~> 4.7"
+  spec.add_dependency "journald-logger", "~> 3.0"
+end

data/test/appender_test.rb

@@ -0,0 +1,49 @@
+require "test_helper"
+require_relative "./journald_mock_logger"
+
+module SemanticLoggerJournald
+  describe Appender do
+    before do
+      @logger = JournaldMockLogger.new
+      @appender = Appender.new(logger: @logger)
+    end
+
+    it "sends messages to journald logger" do
+      @appender.info("EVENT")
+
+      assert_equal 1, @logger.logs.count
+      log = @logger.logs.first
+      assert_equal "EVENT", log[:message]
+    end
+
+    it "sends payload to journald as fields" do
+      @appender.info("Signed In", user: { id: 1, name: "Snowden" })
+
+      log = @logger.logs.first
+      assert_equal "Signed In", log[:message]
+      assert_equal 1, log[:user__id]
+      assert_equal "Snowden", log[:user__name]
+    end
+
+    it "sends tags to journald as fields" do
+      @appender.tagged(ctx: "admin") do
+        @appender.tagged(:authorized) do
+          @appender.fatal("Server unavailable")
+        end
+      end
+
+      log = @logger.logs.first
+      assert_equal "Server unavailable", log[:message]
+      assert_equal "admin", log[:ctx]
+      assert_equal 1, log["authorized"]
+    end
+
+    it "sets correct priority based on level" do
+      @appender.error("Low capacity!")
+
+      log = @logger.logs.first
+      assert_equal "Low capacity!", log[:message]
+      assert_equal 3, log[:priority]
+    end
+  end
+end

data/test/journald_mock_logger.rb

@@ -0,0 +1,11 @@
+class JournaldMockLogger
+  attr_reader :logs
+
+  def initialize
+    @logs = []
+  end
+
+  def send_message(msg)
+    @logs << msg
+  end
+end

data/test/semantic_logger_journald_test.rb

@@ -0,0 +1,4 @@
+require "test_helper"
+
+describe SemanticLoggerJournald do
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "semantic_logger_journald"
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: semantic_logger_journald
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Andrew Volozhanin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: journald-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Plugin for semantic_logger that adds appender to send logs into journald.
+  It depends on journald-native gem that provides the C-bindings
+email:
+- scarfacedeb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rerun
+- lib/semantic_logger_journald.rb
+- lib/semantic_logger_journald/appender.rb
+- lib/semantic_logger_journald/formatter.rb
+- lib/semantic_logger_journald/version.rb
+- semantic_logger_journald.gemspec
+- test/appender_test.rb
+- test/journald_mock_logger.rb
+- test/semantic_logger_journald_test.rb
+- test/test_helper.rb
+homepage: https://rubygems.org/gems/semantic_logger_journald
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/semantic_logger_journald
+  source_code_uri: https://github.com/scarfacedeb/semantic_logger_journald/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Plugin for semantic_logger gem providing systemd-journal appender
+test_files:
+- test/appender_test.rb
+- test/journald_mock_logger.rb
+- test/semantic_logger_journald_test.rb
+- test/test_helper.rb