sw-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 281f87d8270bf0e0fd23fa654ac1efec5c0c2214698b852eed450a67062f0d51
+  data.tar.gz: 2e47d4c7beeab382fdbf9b5e7e4103f07f7a48b7e327a3d4b14c0875e0974df7
+SHA512:
+  metadata.gz: 1772953120523bc0cf0392065fbd1619ed5b70efc416bc427bf6494ef491349a19c3057bd809b7143ddbd3e4203482e2dad717b2db13852d73f21d1df39eb2c8
+  data.tar.gz: 39fe02021d4d5878c0b298d082adb93dc66545ced9f1ab6353387052040528c0873fa5ec803dab789b9f8ff01e88e54f7874bdebf542127da192bb980db04d09

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/LineLength:
+  Enabled: true
+  Max: 80
+Style/Documentation:
+  Enabled: false
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    sw-logger (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  sw-logger!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kai Kuchenbecker
+
+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,65 @@
+# Sw::Logger
+
+This Logger is used in SayWay's applications for context rich logging. That way we can easily extract metrics and analyze our JSON logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sw-logger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sw-logger
+
+## Usage
+
+```ruby
+# get an instance of the logger that logs to standard output
+logger = Sw.logger(STDOUT)
+
+# it follows the normal logger interface
+logger.info("Hello World")
+# => I, [2020-01-31T11:00:08.577103 #29982]  INFO -- : Hello World
+
+# it can be tagged
+logger.tagged("MyApp") { |l| l.debug("is bug free!") }
+# => D, [2020-01-31T11:00:35.585755 #29982] DEBUG -- : [MyApp] is bug free!
+
+# you can provide context as a hash
+context = {
+  tenant: "FooCorp",
+  revision: "4e0b166"
+}
+logger.with_context(context) { |l| l.info("Where am I?") }
+# => I, [2020-01-31T11:00:58.063731 #29982]  INFO -- : [tenant=FooCorp] [revision=4e0b166] Where am I?
+
+# nested context is just dumped as is for non-json formatters
+logger.with_context(foo: { bar: 42 }) { |l| l.info("Use JSON instead!") }
+# => I, [2020-01-31T11:01:57.894093 #29982]  INFO -- : [bar={:foo=>42}] Use JSON instead!
+
+# you can go batshit crazy when using a json logger, anything that can be dumped to json is fair game
+Sw.json_logger(STDOUT).with_context(foo: { bar: 42 }) { |l| l.info("Oooh, yeah!") }
+# => {"bar":{"foo":42},"severity":"INFO","timestamp":"2020-01-31T11:27:34.848643","message":"Oooh, yeah!"}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/say-way/sw-logger.
+
+
+## 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 "sw/logger"
+
+# 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/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sw/log_formatter/contextual_formatter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Sw
+  module LogFormatter
+    class ContextualFormatter < ::Logger::Formatter
+      attr_accessor :tags, :context
+
+      def initialize(context: {}, tags: [])
+        super()
+        self.context = context
+        self.tags = tags
+      end
+
+      def with_context(context)
+        previous_context = self.context
+        self.context = context
+
+        yield self
+      ensure
+        self.context = previous_context
+      end
+
+      def with_tags(tags)
+        previous_tags = self.tags
+        self.tags = tags
+
+        yield self
+      ensure
+        self.tags = previous_tags
+      end
+
+      def current_tags
+        tags
+      end
+    end
+  end
+end

data/lib/sw/log_formatter/default_formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "sw/log_formatter/contextual_formatter"
+
+module Sw
+  module LogFormatter
+    class DefaultFormatter < ContextualFormatter
+      def call(severity, time, progname, msg)
+        tag_string = tags.map { |tag| "[#{tag}] " }.join
+        context_string = context.map { |k, v| "[#{k}=#{v}] " }.join
+        message = tag_string + context_string + msg2str(msg)
+        super(severity, time, progname, message)
+      end
+    end
+  end
+end

data/lib/sw/log_formatter/json_formatter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "json"
+require "sw/log_formatter/contextual_formatter"
+
+module Sw
+  module LogFormatter
+    class JsonFormatter < ContextualFormatter
+      def initialize(*)
+        super
+        self.datetime_format ||= "%Y-%m-%dT%H:%M:%S.%6N"
+      end
+
+      def call(severity, time, progname, msg)
+        payload = context.merge(
+          severity: severity,
+          timestamp: format_datetime(time),
+          progName: progname,
+          tags: tags,
+          message: msg2str(msg)
+        )
+
+        JSON.dump(remove_blank_values(payload)) + "\n"
+      end
+
+      private
+
+      def remove_blank_values(payload)
+        payload.select do |_, value|
+          next if value.nil?
+
+          value = value.strip if value.respond_to?(:strip)
+          next if value.respond_to?(:empty?) && value.empty?
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/sw/log_formatter/simple_formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "sw/log_formatter/contextual_formatter"
+
+module Sw
+  module LogFormatter
+    class SimpleFormatter < ContextualFormatter
+      def call(_severity, _time, _progname, msg)
+        tag_string = tags.map { |tag| "[#{tag}] " }.join
+        context_string = context.map { |k, v| "[#{k}=#{v}] " }.join
+
+        tag_string + context_string + msg2str(msg) + "\n"
+      end
+    end
+  end
+end

data/lib/sw/logger/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Sw
+  class Logger < ::Logger
+    VERSION = "0.1.0"
+  end
+end

data/lib/sw/logger.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "logger"
+require "sw/logger/version"
+require "sw/log_formatter/simple_formatter"
+require "sw/log_formatter/json_formatter"
+require "sw/log_formatter/default_formatter"
+
+module Sw
+  def self.logger(*args)
+    Sw::Logger.new(*args)
+  end
+
+  def self.json_logger(*args)
+    Sw::Logger.new(*args).tap do |logger|
+      logger.formatter = Sw::LogFormatter::JsonFormatter.new
+    end
+  end
+
+  def self.simple_logger(*args)
+    Sw::Logger.new(*args).tap do |logger|
+      logger.formatter = Sw::LogFormatter::SimpleFormatter.new
+    end
+  end
+
+  class Logger < ::Logger
+    def initialize(*)
+      super
+      self.formatter ||= Sw::LogFormatter::DefaultFormatter.new
+    end
+
+    def with_context(context = {})
+      return dup.tap { |it| it.formatter.context = context } unless block_given?
+
+      formatter.with_context(context.to_h) { yield self }
+    end
+
+    def tagged(*tags)
+      tags = Array(tags).flatten
+      return dup.tap { |it| it.formatter.tags = tags } unless block_given?
+
+      formatter.with_tags(tags) { yield self }
+    end
+
+    private
+
+    def initialize_copy(original)
+      self.formatter = original.formatter.dup
+    end
+  end
+end

data/sw-logger.gemspec

@@ -0,0 +1,24 @@
+require_relative "lib/sw/logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sw-logger"
+  spec.version       = Sw::Logger::VERSION
+  spec.authors       = ["Kai Kuchenbecker"]
+  spec.email         = ["dev@sayway.com"]
+
+  spec.summary       = "Context enriched logging with plain and json format."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/say-way/sw-logger"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: sw-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kai Kuchenbecker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-31 00:00:00.000000000 Z
+dependencies: []
+description: Context enriched logging with plain and json format.
+email:
+- dev@sayway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sw/log_formatter/contextual_formatter.rb
+- lib/sw/log_formatter/default_formatter.rb
+- lib/sw/log_formatter/json_formatter.rb
+- lib/sw/log_formatter/simple_formatter.rb
+- lib/sw/logger.rb
+- lib/sw/logger/version.rb
+- sw-logger.gemspec
+homepage: https://github.com/say-way/sw-logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/say-way/sw-logger
+  source_code_uri: https://github.com/say-way/sw-logger
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Context enriched logging with plain and json format.
+test_files: []