key_value_logging 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Maximilian Schulz
+
+MIT License
+
+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,60 @@
+# KeyValueLogging
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'key_value_logging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install key_value_logging
+
+## Environment specific configuration
+
+Add tag to all requests:
+
+    # By referencing a request object method
+    config.key_value_logging.tags = { uuid: :uuid }
+
+    # By providing a proc
+    config.key_value_logging.tags = { params: ->(request){ request.filtered_params } }
+
+    # By providing flat data
+    config.key_value_logging.tags = { mydata: 'Fixed string' }
+
+By default the key value tags are rendered like ```key=value```. But you may
+need to preprocess them. In order to make your life easier, you can access all
+data as a hash by setting the raw format option. The log message itself will be
+available at the ```:message``` key:
+
+    config.key_value_logging.format = :raw
+
+Especially in combination with the raw format option, it makes sense to set your
+own formatter. This could post-process the raw tags and data. As we extend the
+logger and formatter, we provide an easy way to set yout own formatter while
+taking advantage of the custom key-value behaviour:
+
+    config.key_value_logging.formatter = YourCustomLogFormatter.new
+
+## In-app usage
+
+Like the default rails TaggedLogging logger, you can tag log messages with this
+logger. The syntax is almost the same. But instead of providing flat strings, you
+now provide a hash with key and value:
+
+    logger.tagged(city: 'Cologne', country: 'Cologne') { logger.info 'made with love' }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/key_value_logging.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'key_value_logging/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "key_value_logging"
+  gem.version       = KeyValueLogging::VERSION
+  gem.authors       = ["Maximilian Schulz"]
+  gem.email         = ["m.schulz@kulturfluss.de"]
+  gem.description   = %q{KeyValue based replacement for rails TaggedLogging}
+  gem.summary       = %q{Rails TaggedLogging only support simple tags.
+                      When using logging solutions with automatic data detection,
+                      key-value pairs are more useful. This gem allows you to
+                      log tags as key-value paris and format them as you like.}
+  gem.homepage      = "https://github.com/railslove/key_value_logging"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'activesupport', '>= 3'
+  gem.add_runtime_dependency 'rack', '>=1.0.0'
+  gem.add_runtime_dependency 'railties', '>= 3'
+  gem.add_runtime_dependency 'formatted_rails_logger'
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/key_value_logging/logger_middleware.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+module KeyValueLogging
+  class LoggerMiddleware < Rails::Rack::Logger
+    def compute_tags(request)
+      tag_value_pairs = @taggers.map do |tag, key_or_proc|
+        value = case key_or_proc
+        when Proc
+          key_or_proc.call(request)
+        when Symbol
+          request.send(key_or_proc)
+        else
+          key_or_proc
+        end
+        [tag, value]
+      end
+      Hash[*tag_value_pairs.flatten]
+    end
+  end
+end

data/lib/key_value_logging/railtie.rb

@@ -0,0 +1,31 @@
+module KeyValueLogging
+  class KeyValueLoggingRailtie < Rails::Railtie
+
+    # Default options for the key value logger
+    config.key_value_logging = ActiveSupport::OrderedOptions.new
+    config.key_value_logging.tags = {}
+    config.key_value_logging.format = :default
+    config.key_value_logging.formatter = nil
+
+    # Add custom logging middleware, after the logger is initialized
+    initializer "key_value_logging_railtie.configure_rails_initialization", after: :initialize_logger do |app|
+      # Apply monkey patch to BufferedLogger to allow to set a formatter
+      require 'formatted_rails_logger'
+      FormattedRailsLogger.patch_rails
+
+      logger = Rails.logger
+
+      # If provided, set the custom formatter
+      if config.key_value_logging.formatter.present?
+        logger.formatter = config.key_value_logging.formatter
+      end
+
+      # Extend the logger with key value logging
+      Rails.logger = KeyValueLogging::TaggedLogging.new(logger, config.key_value_logging.format)
+
+      # Replace the default rails with thw key value logger middleware
+      app.middleware.delete(Rails::Rack::Logger)
+      app.middleware.use KeyValueLogging::LoggerMiddleware, config.key_value_logging.tags
+    end
+  end
+end

data/lib/key_value_logging/tagged_logging.rb

@@ -0,0 +1,82 @@
+require 'logger'
+require 'active_support/all'
+
+# Wraps any standard Logger object to provide tagging capabilities.
+#
+#   logger = KeyValueTaggedLogging.new(Logger.new(STDOUT))
+#   logger.tagged('location' => 'Cologne') { logger.info 'Stuff' } # Logs "Stuff location=Cologne"
+module KeyValueLogging
+  module TaggedLogging
+    module Formatter # :nodoc:
+      attr_accessor :key_value_format
+
+      # This method is invoked when a log event occurs.
+      def call(severity, timestamp, progname, msg)
+        formatted_msg = self.send("process_#{key_value_format}", msg)
+        super(severity, timestamp, progname, formatted_msg)
+      end
+
+      def tagged(tags)
+        # Add temporary tags to current tags
+        new_tags = push_tags(tags)
+        yield self
+      ensure
+        # Remove the temporary tags from current tags
+        pop_tags(tags.keys)
+      end
+
+      def push_tags(tags)
+        tags.tap do |new_tags|
+          current_tags.merge! new_tags
+        end
+      end
+
+      def pop_tags(keys)
+        keys.each { |key| current_tags.delete(key) }
+      end
+
+      def clear_tags!
+        current_tags.clear
+      end
+
+      def current_tags
+        Thread.current[:key_value_tagged_logging_tags] ||= {}
+      end
+
+      private
+
+      def process_default(msg)
+        tags = current_tags.map { |key, value| "#{key}=#{value}" }
+        [msg, tags].flatten.compact.join(' ')
+      end
+
+      def process_raw(msg)
+        if msg.kind_of?(Hash)
+          current_tags.merge(msg)
+        else
+          current_tags.merge(message: msg)
+        end
+      end
+    end
+
+    def self.new(logger, key_value_format = 'default')
+      yield(logger) if block_given?
+      # Ensure we set a default formatter so we aren't extending nil!
+      logger.formatter ||= ActiveSupport::Logger::SimpleFormatter.new
+      logger.formatter.extend Formatter
+      logger.formatter.key_value_format = key_value_format
+      logger.extend(self)
+    end
+
+    delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter
+
+    def tagged(tags = {})
+      formatter.tagged(tags) { yield self }
+    end
+
+    def flush
+      clear_tags!
+      super if defined?(super)
+    end
+  end
+end

data/lib/key_value_logging/version.rb

@@ -0,0 +1,3 @@
+module KeyValueLogging
+  VERSION = "0.0.1"
+end

data/lib/key_value_logging.rb

@@ -0,0 +1,9 @@
+require "key_value_logging/version"
+require "key_value_logging/tagged_logging"
+require "key_value_logging/logger_middleware"
+
+require 'key_value_logging/railtie' if defined?(Rails)
+
+module KeyValueLogging
+  # init namespace
+end

data/spec/logger_middleware_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'rack/test'
+
+describe KeyValueLogging::LoggerMiddleware do
+  include Rack::Test::Methods
+
+  let(:output) { StringIO.new }
+  let(:config) { nil }
+
+  let(:app) do
+    Rails.logger = KeyValueLogging::TaggedLogging.new(Logger.new(output))
+    middleware_config = config
+    Rack::Builder.new do
+      use KeyValueLogging::LoggerMiddleware, middleware_config
+      run lambda { |env|
+        [200, { 'Content-Type' => 'text/plain' }, ['Hello World!']]
+      }
+    end
+  end
+
+  context 'config by request attribute' do
+    let(:config) { { params: :params } }
+    before { get '/test?hello=world' }
+    it { expect(output.string).to include('params={"hello"=>"world"}') }
+  end
+
+  context 'config by proc' do
+    let(:config) { { params: ->(request) { request.params } } }
+    before { get '/test?hello=world' }
+    it { expect(output.string).to include('params={"hello"=>"world"}') }
+  end
+
+  context 'config with invalid configuration' do
+    let(:config) { { invalid: ['test'] } }
+    before { get '/test?hello=world' }
+    it { expect(output.string).to include('invalid=test') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'key_value_logging'
+ENV['RAILS_ENV'] = 'test'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/tagged_logging_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe KeyValueLogging::TaggedLogging do
+  let(:output) { StringIO.new }
+  before { logger.tagged(location: 'Cologne'){ logger.info('My Message') } }
+
+  context 'default message style' do
+    let(:logger) { KeyValueLogging::TaggedLogging.new(Logger.new(output)) }
+    it { expect(output.string).to include('My Message') }
+    it { expect(output.string).to include('location=Cologne') }
+  end
+
+  context 'raw message style' do
+    let(:logger) { KeyValueLogging::TaggedLogging.new(Logger.new(output), :raw) }
+    it { expect(output.string).to include(':message=>"My Message"') }
+    it { expect(output.string).to include(':location=>"Cologne"') }
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: key_value_logging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maximilian Schulz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: formatted_rails_logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: KeyValue based replacement for rails TaggedLogging
+email:
+- m.schulz@kulturfluss.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- key_value_logging.gemspec
+- lib/key_value_logging.rb
+- lib/key_value_logging/logger_middleware.rb
+- lib/key_value_logging/railtie.rb
+- lib/key_value_logging/tagged_logging.rb
+- lib/key_value_logging/version.rb
+- spec/logger_middleware_spec.rb
+- spec/spec_helper.rb
+- spec/tagged_logging_spec.rb
+homepage: https://github.com/railslove/key_value_logging
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails TaggedLogging only support simple tags. When using logging solutions
+  with automatic data detection, key-value pairs are more useful. This gem allows
+  you to log tags as key-value paris and format them as you like.
+test_files:
+- spec/logger_middleware_spec.rb
+- spec/spec_helper.rb
+- spec/tagged_logging_spec.rb
+has_rdoc: