logger-metadata 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bafba39702b54356d10b49d0effc9aaa057da8a9
+  data.tar.gz: 1ed2b47c177016b22518716ba570bd88146dfeb8
+SHA512:
+  metadata.gz: ad681ece92428f041c63ae6aae79edb003c462c649f2b00fbbb5506b7546d79aab5947b9c5e5b51716568083308b58b593a2c0ead49e9b27ce8874b99e68b372
+  data.tar.gz: ed5bbda922bf0300565e8c1535aa8a15554e70b8dd5f13e6ff03a6584148bf231580f162dad486abe7174799d586b48eff5f4311e62306f53a46ea327a8f2032

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - jruby-9.1.6.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Smartly.io Solutions Oy
+
+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,39 @@
+# Logger::Metadata
+
+Enhance Ruby logger with support for key-value metadata.
+
+[![Build Status](https://travis-ci.org/smartlyio/logger-metadata.svg?branch=master)](https://travis-ci.org/smartlyio/logger-metadata)
+
+## Installation
+
+Logger::Metadata is available as a ruby gem.
+
+    $ gem install logger-metadata
+
+## Usage
+
+```ruby
+require 'logger-metadata'
+
+logger = Logger.new
+Logger::Metadata.inject(logger)
+
+logger.metadata(key: 'value') do
+  logger.info('message')
+end
+```
+
+All log messages within the metadata block will contain the metadata. Nested
+metadata blocks can be used.
+
+Logger::Metadata will augment the default the default formatter to include
+metadata and timestamp. For example
+
+```
+[2016-11-30 14:27:19 +0200] Message (key=value)
+```
+
+## Rails integration
+
+If you include `logger-metadata` in a Rails application Gemfile, metadata
+logging will be automatically set up.

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 "logger/metadata"
+
+# 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

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/logger/metadata.rb

@@ -0,0 +1,44 @@
+require 'logger'
+require 'logger/metadata/version'
+require 'logger/metadata/formatter'
+require 'logger/metadata/railtie' if defined?(Rails)
+
+class Logger
+  # Metadata mixin for Ruby Logger
+  module Metadata
+    def flush
+      clear_metadata!
+      super if defined?(super)
+    end
+
+    def metadata(attributes)
+      formatter.metadata(attributes) { yield self }
+    end
+
+    def push_metadata(*args, &block)
+      formatter.push_metadata(*args, &block)
+    end
+
+    def pop_metadata(*args, &block)
+      formatter.pop_metadata(*args, &block)
+    end
+
+    def clear_metadata!(*args, &block)
+      formatter.clear_metadata!(*args, &block)
+    end
+
+    def self.inject(logger)
+      logger.formatter ||= default_formatter
+      logger.formatter.extend Formatter
+      logger.extend(self)
+    end
+
+    def self.default_formatter
+      if defined?(ActiveSupport::Logger::SimpleFormatter)
+        ActiveSupport::Logger::SimpleFormatter
+      else
+        Logger::Formatter
+      end.new
+    end
+  end
+end

data/lib/logger/metadata/formatter.rb

@@ -0,0 +1,55 @@
+require 'thread'
+
+class Logger
+  module Metadata
+    module Formatter
+      def call(severity, timestamp, program_name, message)
+        timestamp_string = '[' + timestamp.to_s + ']'
+        formatted_message = "#{faint(timestamp_string)} #{message}#{faint(metadata_text)}"
+        super(severity, timestamp, program_name, formatted_message)
+      end
+
+      def metadata_stack
+        thread_key = @metadata_thread_key ||= "metadata_logging:#{object_id}".freeze
+        Thread.current[thread_key] ||= []
+      end
+
+      def current_metadata
+        metadata_stack.inject({}, &:merge)
+      end
+
+      def metadata(attributes)
+        push_metadata(attributes)
+        yield self
+      ensure
+        pop_metadata
+      end
+
+      def push_metadata(attributes)
+        metadata_stack.push attributes
+      end
+
+      def pop_metadata(size = 1)
+        metadata_stack.pop size
+      end
+
+      def clear_metadata!
+        metadata_stack.clear
+      end
+
+      def metadata_text
+        current_metadata.map do |(key, value)|
+          " (#{key}=#{value})"
+        end.join('')
+      end
+
+      def faint(string)
+        if string.empty?
+          string
+        else
+          "\e[2m#{string}\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/logger/metadata/middleware.rb

@@ -0,0 +1,19 @@
+require 'action_dispatch'
+
+class Logger
+  module Metadata
+    # Add request_id as metadata to all Rails requests
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new env
+        ::Rails.logger.metadata(request_id: request.request_id) do
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/logger/metadata/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails/railtie'
+require 'logger/metadata/middleware'
+
+class Logger
+  module Metadata
+    # Rails integration. Inject metadata-awareness to current Rails logger.
+    class Railtie < Rails::Railtie
+      initializer after: :initialize_logger do |app|
+        Metadata.inject ::Rails.logger
+        app.middleware.insert_before(::Rails::Rack::Logger, Middleware)
+      end
+    end
+  end
+end

data/lib/logger/metadata/version.rb

@@ -0,0 +1,5 @@
+class Logger
+  module Metadata
+    VERSION = '0.1.1'.freeze
+  end
+end

data/logger-metadata.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logger/metadata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logger-metadata"
+  spec.version       = Logger::Metadata::VERSION
+  spec.authors       = ["Ville Lautanala"]
+  spec.email         = ["lautis@gmail.com"]
+
+  spec.summary       = %q{Metadata-aware Ruby Logger}
+  spec.description   = %q{Enhance Ruby logger with support for key-value metadata.}
+  spec.homepage      = "https://github.com/smartlyio/logger-metadata"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "activesupport"
+  spec.add_dependency "actionpack"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: logger-metadata
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: actionpack
+  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: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Enhance Ruby logger with support for key-value metadata.
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logger/metadata.rb
+- lib/logger/metadata/formatter.rb
+- lib/logger/metadata/middleware.rb
+- lib/logger/metadata/railtie.rb
+- lib/logger/metadata/version.rb
+- logger-metadata.gemspec
+homepage: https://github.com/smartlyio/logger-metadata
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Metadata-aware Ruby Logger
+test_files: []