ezlog 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94596a090c0744c6edb767e0bec261a515c5954a853f061984c5b094d9cf7cf2
+  data.tar.gz: 303cb838d233797f903d74f6d20a38bcae91b43c23b20c544b64930529df4253
+SHA512:
+  metadata.gz: 7317b40e4ab676771a660e1bdd24003ba488e5cb7cfcca4b6ff2c9fd8c3360e98fc2cb3398af344cbabb8304bdf00f42c8fe3a852cb13155ec2f6eaf9f1277d6
+  data.tar.gz: 67218232ac200cc27322b83198f9d4bded0d660ada98fffc9f43205a26388a7cd9f47abc9d50d6757b6e9272675283f6213f6d19d1592b0059237cc21924bbfa

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ezlog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2019 Emarsys
+
+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,101 @@
+# Ezlog
+
+Ezlog is intended to be a zero-configuration logging setup for pure Ruby or Rails projects using 
+[Sidekiq](https://github.com/mperham/sidekiq), [Rack::Timeout](https://github.com/heroku/rack-timeout),
+[Sequel](https://sequel.jeremyevans.net/), etc. It uses Tim Pease's wonderful [Logging](https://github.com/TwP/logging)
+gem for an all-purpose logging solution.
+
+Ezlog's purpose is threefold:
+1. Make sure that our applications are logging in a sensible manner; emitting no unnecessary "noise" but containing all 
+relevant and necessary information (like timing).
+2. Make sure that all log messages are written to STDOUT in a machine-processable format (JSON) across all of our projects.
+3. Achieving the above goal should require no configuration in the projects where the library is used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ezlog'
+```
+
+## What it does
+
+* Initializes the [Logging](https://github.com/TwP/logging) library
+* Configures Rails logging
+* Configures Sidekiq logging
+* Configures Rack::Timeout logging
+
+#### Initializes the Logging library
+
+Ezlog sets up [Logging](https://github.com/TwP/logging)'s root logger to have an appender that writes to STDOUT.
+Any loggers created by the application will inherit this appender and will thus write their logs to STDOUT.
+Ezlog also comes with its own log layout, which it uses to output messages sent to the STDOUT appender. This layout
+does several very useful things to make our lives easier:
+
+* It can handle log messages in several formats:
+  * String (obviously)
+  * Hash
+  * Exception
+  * any object that can be coerced into a String
+* It automatically adds basic information to all log messages, such as:
+  * name of the logger
+  * timestamp
+  * log level (as string)
+  * hostname
+  * PID
+
+Examples:
+```ruby
+logger.info 'Log message'
+#=> {"logger":"App","timestamp":"2019-05-11T16:08:38+02:00","level":"INFO","hostname":"MacbookPro.local","pid":71674,"message":"Log message"}
+
+logger.info message: 'Job finished', duration: 2
+#=> {"logger":"App","timestamp":"2019-05-11T16:08:38+02:00","level":"INFO","hostname":"MacbookPro.local","pid":71674,"message":"Job finished","duration":2}
+
+logger.error ex
+#=> {"logger":"App","timestamp":"2019-05-11T16:08:38+02:00","level":"INFO","hostname":"MacbookPro.local","pid":71674,"message":"Error message","error":{"class":"StandardError","message":"Error message","backtrace":[...]}}
+```
+
+#### Configures Rails logging
+
+Ezlog configures the `Rails.logger` to be an instance of a [Logging](https://github.com/TwP/logging) logger by the name 
+of `Application`, behaving as described above. The logger uses the log level set in `application.rb` (if present) or 
+uses INFO as a default log level. It also adds the environment (`Rails.env`) to the logger's initial context, meaning
+it will automatically be appended to all log messages emitted by the application.
+
+#### Configures Sidekiq logging
+
+Ezlog comes with its own job logger for [Sidekiq](https://github.com/mperham/sidekiq) which does several things that 
+come in very handy when working with background jobs.
+ 
+* It emits two log messages per job run; one when the job is started and another one when the job is finished (successfully or unsuccessfuly).
+* It measures the time it took to execute the job and appends the benchmark information to the final log message.
+* It adds all basic information about the job (worker, queue, JID, created_at, enqueued_at) to the log context so
+all log messages emitted during the execution of the job will contain this information.
+* It also adds all of the job's parameters to the log context, which means that all log messages emitted during the execution
+of the job will contain this information as well.
+
+```ruby
+class TestWorker
+  def perform(customer_id, name)
+  end
+end
+
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:10+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"job id","queue":"job queue","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":1,"name":"name param","message":"TestWorker started"}
+#=> {"logger":"Sidekiq","timestamp":"2019-05-12T10:38:12+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75538,"jid":"job id","queue":"job queue","worker":"TestWorker","created_at":"2019-05-12 10:38:10 +0200","enqueued_at":"2019-05-12 10:38:10 +0200","customer_id":1,"name":"name param","duration_sec":2.667,"message":"TestWorker finished"}
+```
+
+#### Configures Rack::Timeout logging
+
+[Rack::Timeout](https://github.com/heroku/rack-timeout) is a very useful tool for people running services on Heroku
+but it is way too verbose by default. What Ezlog does is simply reconfigure its logging to use Ezlog's logging
+mechanism and to only output messages at or above WARN level. 
+
+## Disclaimer
+
+Ezlog is highly opinionated software and does in no way aim or claim to be useful for everyone. Use at your own discretion.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ezlog"
+
+# 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/ezlog.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ezlog/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ezlog"
+  spec.version       = Ezlog::VERSION
+  spec.authors       = ["Zoltan Ormandi"]
+  spec.email         = ["zoltan.ormandi@emarsys.com"]
+
+  spec.summary       = "A zero-configuration logging solution for projects using Sidekiq, Rails, Sequel, etc."
+  spec.homepage      = "https://github.com/emartech/ezlog"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "logging", "~> 2.0"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sidekiq", "~> 5.0"
+end

data/lib/ezlog.rb

@@ -0,0 +1,4 @@
+require 'ezlog/version'
+require 'ezlog/logging_layout'
+
+require 'ezlog/railtie' if defined? Rails

data/lib/ezlog/logging_layout.rb

@@ -0,0 +1,65 @@
+require 'time'
+require 'multi_json'
+require 'logging'
+
+module Ezlog
+  class LoggingLayout < ::Logging::Layout
+    def initialize(context = {})
+      @initial_context = context
+    end
+
+    def format(event)
+      log_entry = basic_information_for event
+      add_initial_context_to log_entry
+      add_logging_context_to log_entry
+      add_event_information_to log_entry, event
+      ::MultiJson.dump(log_entry) + "\n"
+    end
+
+    private
+
+    def basic_information_for(event)
+      {
+        'logger' => event.logger,
+        'timestamp' => event.time.iso8601,
+        'level' => ::Logging::LNAMES[event.level],
+        'hostname' => Socket.gethostname,
+        'pid' => Process.pid
+      }
+    end
+
+    def add_initial_context_to(log_entry)
+      log_entry.merge! @initial_context
+    end
+
+    def add_logging_context_to(log_entry)
+      log_entry.merge! ::Logging.mdc.context
+    end
+
+    def add_event_information_to(log_entry, event)
+      log_entry.merge! hash_from(event.data)
+    end
+
+    def hash_from(obj)
+      case obj
+      when Exception
+        exception_message_by(obj)
+      when Hash
+        obj
+      else
+        {message: obj}
+      end
+    end
+
+    def exception_message_by(exception)
+      {
+        message: exception.message,
+        error: {
+          class: exception.class.name,
+          message: exception.message,
+          backtrace: exception.backtrace.first(20)
+        }
+      }
+    end
+  end
+end

data/lib/ezlog/railtie.rb

@@ -0,0 +1,37 @@
+module Ezlog
+  class Railtie < Rails::Railtie
+    initializer 'ezlog.configure_logging' do |app|
+      ::Logging.logger.root.appenders = ::Logging.appenders.stdout 'stdout',
+                                                                   layout: Ezlog::LoggingLayout.new(environment: Rails.env),
+                                                                   level: app.config.log_level || :info
+    end
+
+    initializer 'ezlog.configure_sidekiq_logging' do
+      initialize_sidekiq_logging if defined? ::Sidekiq
+    end
+
+    initializer 'ezlog.configure_rack_timeout_logging' do
+      initialize_rack_timeout_logging if defined? ::Rack::Timeout
+    end
+
+    config.before_configuration do |app|
+      app.config.logger = ::Logging.logger['Application']
+    end
+
+    private
+
+    def initialize_sidekiq_logging
+      ::Sidekiq.logger = Logging.logger['Sidekiq']
+      ::Sidekiq.logger.level = :info
+      ::Sidekiq.configure_server do |config|
+        require 'ezlog/sidekiq/job_logger'
+        config.options[:job_logger] = Ezlog::Sidekiq::JobLogger
+      end
+    end
+
+    def initialize_rack_timeout_logging
+      ::Rack::Timeout::Logger.logger = ::Logging.logger['rack-timeout']
+      ::Rack::Timeout::Logger.logger.level = :warn
+    end
+  end
+end

data/lib/ezlog/rspec.rb

@@ -0,0 +1,11 @@
+require 'rspec/logging_helper'
+require_relative 'rspec/helpers'
+require_relative 'rspec/matchers'
+
+RSpec.configure do |config|
+  config.include Ezlog::RSpec::Helpers
+  config.before(:suite) do
+    Logging.appenders.string_io('__ezlog_stringio__', layout: Ezlog::LoggingLayout.new)
+    config.capture_log_messages to: '__ezlog_stringio__'
+  end
+end

data/lib/ezlog/rspec/helpers.rb

@@ -0,0 +1,13 @@
+module Ezlog
+  module RSpec
+    module Helpers
+      def log_output_is_expected
+        expect(log_output)
+      end
+
+      def log_output
+        @log_output.clone.readlines
+      end
+    end
+  end
+end

data/lib/ezlog/rspec/matchers.rb

@@ -0,0 +1,57 @@
+RSpec::Matchers.define :include_log_message do |expected|
+  chain :at_level, :log_level
+
+  match do |actual|
+    actual.any? { |log_line| includes? log_line, expected_messages_from(expected) }
+  end
+
+  def includes?(log_line, messages)
+    return false unless includes_log_level? log_line
+    messages.all? { |message| log_line.include? message }
+  end
+
+  def includes_log_level?(log_line)
+    return true if log_level.nil?
+    log_line.include? log_level_string(log_level)
+  end
+
+  def log_level_string(log_level)
+    return 'WARN' if log_level == :warning
+    log_level.to_s.upcase
+  end
+
+  def expected_messages_from(object)
+    @expected_messages ||= case object
+                           when Hash
+                             object.map { |k, v| MultiJson.dump(k => v)[1...-1] }
+                           when String
+                             [object]
+                           else
+                             raise NotImplementedError, 'log expectation must be Hash or String'
+                           end
+  end
+
+  failure_message do |actual|
+    error_message = "expected log output\n\t'#{actual.join('')}'\nto include log message\n\t'#{expected}'"
+    error_message += " at #{log_level} level" if log_level
+    error_message
+  end
+end
+
+RSpec::Matchers.define :log do
+  supports_block_expectations
+  chain :at_level, :log_level
+
+  failure_message do
+    error_message = "expected operation to log '#{expected}'"
+    error_message += " at #{log_level} level" if log_level
+    "#{error_message}\n\nactual log output:\n#{log_output.join('')}"
+  end
+
+  match do |operation|
+    raise 'log matcher only supports block expectations' unless operation.is_a? Proc
+    log_output_is_expected.not_to include_log_message(expected)
+    operation.call
+    log_output_is_expected.to include_log_message(expected).at_level(log_level)
+  end
+end

data/lib/ezlog/sidekiq/job_logger.rb

@@ -0,0 +1,65 @@
+require 'sidekiq'
+
+module Ezlog
+  module Sidekiq
+    class JobLogger
+      def call(item, queue)
+        within_log_context_of(item) do
+          logger.info "#{item['class']} started"
+          benchmark { yield }
+          logger.info message: "#{item['class']} finished"
+        rescue Exception
+          logger.info message: "#{item['class']} failed"
+          raise
+        end
+      end
+
+      private
+
+      def within_log_context_of(item)
+        Logging.mdc.push log_context(item)
+        yield
+      ensure
+        Logging.mdc.pop
+      end
+
+      def log_context(job)
+        basic_info_for(job).merge arguments_of(job)
+      end
+
+      def basic_info_for(job)
+        {
+          'jid' => job['jid'],
+          'queue' => job['queue'],
+          'worker' => job['class'],
+          'created_at' => job['created_at'],
+          'enqueued_at' => job['enqueued_at']
+        }
+      end
+
+      def arguments_of(job)
+        {}.tap do |arguments|
+          method_parameters_of(job).each_with_index do |(_, param_name), index|
+            arguments[param_name] = job['args'][index]
+          end
+        end
+      end
+
+      def method_parameters_of(job)
+        Kernel.const_get(job['class'].to_sym).instance_method(:perform).parameters
+      end
+
+      def logger
+        ::Sidekiq.logger
+      end
+
+      def benchmark
+        start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        yield
+      ensure
+        end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        Logging.mdc[:duration_sec] = (end_time - start_time).round(3)
+      end
+    end
+  end
+end

data/lib/ezlog/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: ezlog
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Zoltan Ormandi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- zoltan.ormandi@emarsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ezlog.gemspec
+- lib/ezlog.rb
+- lib/ezlog/logging_layout.rb
+- lib/ezlog/railtie.rb
+- lib/ezlog/rspec.rb
+- lib/ezlog/rspec/helpers.rb
+- lib/ezlog/rspec/matchers.rb
+- lib/ezlog/sidekiq/job_logger.rb
+- lib/ezlog/version.rb
+homepage: https://github.com/emartech/ezlog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A zero-configuration logging solution for projects using Sidekiq, Rails,
+  Sequel, etc.
+test_files: []