logged 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b46976fe22a5a244a609bdaf510609c99c28285
+  data.tar.gz: 1d26549594e07f0330e6f075f32d8bee8a713182
+SHA512:
+  metadata.gz: 5646a200c4ccae0f0a73850a0af06ad4f144f62e91e77fec50ae5fcee7f9eee32eee52f9f59b56d895d9e909c18030e8bb64dcca0fe5dd98368220f74837c0e6
+  data.tar.gz: 252309919f1082f7513d66ff10deeb6a68b11c657f56991f804c9c3f360983908a2ef3085e125a4a4941215a160383097bd99f821622d5380888b65e9d12ee37

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'lib/logged/version.rb'
+
+LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 16

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Florian Schwab
+
+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,104 @@
+# logged: configurable Rails logging
+
+Logged tries to make managing logging with Rails easier.
+
+Heavily inspired by [lograge](https://github.com/roidrage/lograge) logged allows you to log to multiple destinations
+in different formats e.g. one log for view rendering times, one for requests and one for slow queries.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logged'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logged
+
+## Usage
+
+### Overview
+
+```ruby
+# config/environments/*.rb or config/application.rb
+Rails.application.configure do
+
+  # Enabling it
+  config.logged.enabled = true
+
+  # Adding a logger
+  config.logged.loggers.my.logger = Logger.new(Rails.root.join('log/my.log'))
+  config.logged.loggers.rails.logger = :rails
+
+  # Enabling a component
+  config.logged.action_controller.enabled = true
+
+  # Disable Rails logging for a component
+  config.logged.action_controller.disable_rails_logging = true
+
+  # Setting log level
+  config.logged.level = :debug
+
+  # Setting the formatter
+  config.logged.formatter = Logged::Formatter::JSON.new
+  config.logged.formatter = ->(data) {
+      JSON.dump(data)
+    }
+
+  # Setting tags
+  config.logged.tags = [ :uuid, 'my-tag' ]
+
+  # Ignore events
+  config.logged.ignore << 'process_action.action_controller'
+
+  # Custom ignore callback
+  config.logged.custom_ignore = ->(event) {
+      event.duration.to_f < 0.25
+    }
+
+  # Modifying the data
+  config.logged.custom_data = ->(event, data) {
+      data.merge({ foo: :bar })
+    }
+end
+```
+
+### Lograge
+
+You can replicate the output of lograge by using the following configuration:
+
+```ruby
+# config/environments/*.rb or config/application.rb
+Rails.application.configure do
+  config.logged.enabled = true
+  config.logged.action_controller.enabled = true
+  config.logged.action_controller.loggers.lograge.logger = Logger.new(Rails.root.join('log/request.log'))
+  config.logged.action_controller.custom_data = ->(event, data) {
+    data.reject { |k, _v| %i( event filter ).include?(k) }
+  }
+
+  config.logger = Logger.new('/dev/null') # optionally discard other logging
+
+  # to increase performance you can also add the following:
+  config.log_level = :unknown
+  config.logged.action_controller.disable_rails_logging = true
+  config.logged.action_view.disable_rails_logging = true
+  config.logged.action_mailer.disable_rails_logging = true
+  config.logged.active_record.disable_rails_logging = true
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ydkn/logged/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/logged/configuration.rb

@@ -0,0 +1,56 @@
+require 'active_support/ordered_options'
+
+module Logged
+  # logged configuration
+  class Configuration < ::ActiveSupport::OrderedOptions
+    # Default values for configuration options
+    DEFAULT_VALUES = {
+      enabled:       false,
+      level:         nil,
+      formatter:     nil,
+      ignore:        -> { [] },
+      tags:          -> { [] },
+      custom_ignore: nil,
+      custom_data:   nil
+    }
+
+    def self.init_default_options(config, ignore_defaults = [])
+      DEFAULT_VALUES.each do |key, value|
+        next if ignore_defaults.include?(key)
+
+        if value.is_a?(Proc)
+          config[key] = value.call
+        else
+          config[key] = value
+        end
+      end
+    end
+
+    # Configuration for loggers
+    class LoggerOptions < ::ActiveSupport::OrderedOptions
+      def initialize
+        Configuration.init_default_options(self, [:tags])
+
+        self.enabled = true
+      end
+    end
+
+    # Configuration for components
+    class ComponentOptions < ::ActiveSupport::OrderedOptions
+      def initialize
+        Configuration.init_default_options(self)
+
+        self.disable_rails_logging = false
+        self.loggers = ::ActiveSupport::OrderedOptions.new { |hash, key| hash[key] = LoggerOptions.new }
+      end
+    end
+
+    def initialize
+      super { |hash, key| hash[key] = ComponentOptions.new }
+
+      Configuration.init_default_options(self)
+
+      self.loggers = ::ActiveSupport::OrderedOptions.new { |hash, key| hash[key] = LoggerOptions.new }
+    end
+  end
+end

data/lib/logged/formatter/base.rb

@@ -0,0 +1,8 @@
+module Logged
+  module Formatter
+    # Definiation of a logged formatter
+    class Base
+      def call(_data); end
+    end
+  end
+end

data/lib/logged/formatter/json.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'logged/formatter/base'
+
+module Logged
+  module Formatter
+    # JSON formatter for logged
+    class JSON < Base
+      def call(data)
+        ::JSON.dump(data)
+      end
+    end
+  end
+end

data/lib/logged/formatter/key_value.rb

@@ -0,0 +1,25 @@
+require 'logged/formatter/base'
+
+module Logged
+  module Formatter
+    # Key-Value formatter for logged
+    class KeyValue < Base
+      def call(data)
+        data
+          .reject { |_k, v| v.nil? || (v.is_a?(String) && v.blank?) }
+          .map { |k, v| format_key(k, v) }
+          .join(' ')
+      end
+
+      def format_key(key, value)
+        # encapsulate in single quotes if value is a string
+        value = "'#{value}'" if value.is_a?(String)
+
+        # ensure only two decimals
+        value = Kernel.format('%.2f', value) if value.is_a?(Float)
+
+        "#{key}=#{value}"
+      end
+    end
+  end
+end

data/lib/logged/formatter/logstash.rb

@@ -0,0 +1,31 @@
+require 'logged/formatter/base'
+require 'logged/formatter/key_value'
+
+module Logged
+  module Formatter
+    # Logstash formatter for logged
+    class Logstash < Base
+      def initialize(message_formatter = nil)
+        @message_formatter = message_formatter || KeyValue.new
+      end
+
+      def call(data)
+        load_dependencies
+
+        event = LogStash::Event.new(data)
+        event[:message] ||= @message_formatter.call(data)
+
+        event.to_json
+      end
+
+      private
+
+      def load_dependencies
+        require 'logstash-event'
+      rescue LoadError
+        STDERR.puts 'You need to install the logstash-event gem to use the logstash formatter.'
+        raise
+      end
+    end
+  end
+end

data/lib/logged/formatter/raw.rb

@@ -0,0 +1,12 @@
+require 'logged/formatter/base'
+
+module Logged
+  module Formatter
+    # Raw formatter for logged
+    class Raw < Base
+      def call(data)
+        data
+      end
+    end
+  end
+end

data/lib/logged/formatter/single_key.rb

@@ -0,0 +1,16 @@
+require 'logged/formatter/base'
+
+module Logged
+  module Formatter
+    # Single-Key formatter for logged
+    class SingleKey < Base
+      def initialize(key)
+        @key = key
+      end
+
+      def call(data)
+        data[@key]
+      end
+    end
+  end
+end

data/lib/logged/level_conversion.rb

@@ -0,0 +1,19 @@
+module Logged
+  # Conversion between log level symbols and integers
+  module LevelConversion
+    def level_to_const(level)
+      ::Logger.const_get(level.to_s.upcase)
+    end
+
+    def level_to_sym(level)
+      case level
+      when ::Logger::FATAL then :fatal
+      when ::Logger::ERROR then :error
+      when ::Logger::WARN  then :warn
+      when ::Logger::INFO  then :info
+      when ::Logger::DEBUG then :debug
+      else                      :unknown
+      end
+    end
+  end
+end

data/lib/logged/log_subscriber/action_controller.rb

@@ -0,0 +1,96 @@
+require 'uri'
+require 'logged/log_subscriber/base'
+
+module Logged
+  module LogSubscriber
+    # Log subscriber for ActionController events
+    class ActionController < Base
+      component :action_controller
+
+      def process_action(event)
+        return if ignore?(event, :info)
+
+        payload = event.payload
+
+        data = {
+          event: event.name
+        }
+
+        data.merge!(extract_request(payload))
+        data.merge!(cached_event_data)
+        data.merge!(extract_path(payload))
+        data.merge!(extract_status(payload))
+        data.merge!(extract_runtimes(payload))
+
+        data[:duration] = event.duration.to_f.round(2)
+
+        info(event, data)
+      end
+
+      def redirect_to(event)
+        Thread.current[:logged_action_controller_location] = event.payload[:location]
+      end
+
+      def halted_callback(event)
+        Thread.current[:logged_action_controller_filter] = event.payload[:filter]
+      end
+
+      private
+
+      def extract_request(payload)
+        {
+          method:     payload[:method].to_sym,
+          format:     payload[:format],
+          controller: payload[:params]['controller'],
+          action:     payload[:params]['action']
+        }.reject { |_k, v| v.blank? }
+      end
+
+      def extract_path(payload)
+        uri = URI.parse(payload[:path])
+
+        { path: uri.path }
+      end
+
+      def extract_status(payload)
+        status = payload[:status]
+        error  = payload[:exception]
+
+        if status
+          { status: status.to_i }
+        elsif error
+          exception, message = error
+
+          { status: 500, error: "#{exception}:#{message}" }
+        else
+          { status: 0 }
+        end
+      end
+
+      def extract_runtimes(payload)
+        view_runtime, db_runtime = nil
+
+        view_runtime = payload[:view_runtime].to_f.round(2) if payload.key?(:view_runtime)
+        db_runtime   = payload[:db_runtime].to_f.round(2)   if payload.key?(:db_runtime)
+
+        {
+          view_runtime: view_runtime,
+          db_runtime: db_runtime
+        }.reject { |_k, v| v.blank? }
+      end
+
+      def cached_event_data
+        location = Thread.current[:logged_action_controller_location]
+        Thread.current[:logged_action_controller_location] = nil
+
+        filter = Thread.current[:logged_action_controller_filter]
+        Thread.current[:logged_action_controller_filter] = nil
+
+        {
+          location: location,
+          filter:   filter
+        }.reject { |_k, v| v.blank? }
+      end
+    end
+  end
+end

data/lib/logged/log_subscriber/action_mailer.rb

@@ -0,0 +1,67 @@
+require 'logged/log_subscriber/base'
+
+module Logged
+  module LogSubscriber
+    # Log subscriber for ActionMailer events
+    class ActionMailer < Base
+      component :action_mailer
+
+      # An email was delivered.
+      def deliver(event)
+        return if ignore?(event, :debug)
+
+        process_duration = Thread.current[:logged_action_mailer_process_duration] || 0.0
+
+        data = {
+          event:    event.name,
+          duration: (process_duration + event.duration.to_f).round(2)
+        }
+
+        data.merge!(extract_mail_deliver(event.payload))
+
+        Thread.current[:logged_action_mailer_process_duration] = nil
+
+        debug(event, data)
+      end
+
+      # An email was received.
+      def receive(event)
+        return unless logger.debug?
+        return if ignore?(event)
+
+        data = {
+          event:    event.name,
+          duration: event.duration.to_f.round(2)
+        }
+
+        debug(event, data)
+      end
+
+      # An email was generated.
+      def process(event)
+        payload = event.payload
+
+        Thread.current[:logged_action_mailer_process_mailer]   = payload[:mailer]
+        Thread.current[:logged_action_mailer_process_action]   = payload[:action]
+        Thread.current[:logged_action_mailer_process_duration] = event.duration.to_f
+      end
+
+      private
+
+      def extract_mail_deliver(payload)
+        data = {
+          mailer:     (payload[:mailer] || Thread.current[:logged_action_mailer_process_mailer]),
+          action:     (payload[:action] || Thread.current[:logged_action_mailer_process_action]),
+          from:       Array(payload[:from]).join(', '),
+          to:         Array(payload[:to]).join(', '),
+          bcc:        Array(payload[:bcc]).join(', ')
+        }
+
+        Thread.current[:logged_action_mailer_process_mailer] = nil
+        Thread.current[:logged_action_mailer_process_action] = nil
+
+        data
+      end
+    end
+  end
+end

data/lib/logged/log_subscriber/action_view.rb

@@ -0,0 +1,42 @@
+require 'action_view/log_subscriber'
+require 'logged/log_subscriber/base'
+
+module Logged
+  module LogSubscriber
+    # Log subscriber for ActionView events
+    class ActionView < Base
+      component :action_view
+
+      def render_template(event)
+        return if ignore?(event, :debug)
+
+        payload = event.payload
+
+        data = {
+          event:    event.name,
+          view:     from_rails_root(payload[:identifier]),
+          layout:   from_rails_root(payload[:layout]),
+          duration: event.duration.to_f.round(2)
+        }.reject { |_k, v| v.blank? }
+
+        debug(event, data)
+      end
+      alias_method :render_partial, :render_template
+      alias_method :render_collection, :render_template
+
+      protected
+
+      def from_rails_root(string)
+        return nil if string.blank?
+
+        string = string.sub(rails_root, ::ActionView::LogSubscriber::EMPTY)
+        string.sub!(::ActionView::LogSubscriber::VIEWS_PATTERN, ::ActionView::LogSubscriber::EMPTY)
+        string
+      end
+
+      def rails_root
+        @root ||= "#{::Rails.root}/"
+      end
+    end
+  end
+end

data/lib/logged/log_subscriber/active_record.rb

@@ -0,0 +1,31 @@
+require 'active_record/log_subscriber'
+require 'logged/log_subscriber/base'
+
+module Logged
+  module LogSubscriber
+    # Log subscriber for ActiveRecord events
+    class ActiveRecord < Base
+      # This query types will be ignored
+      IGNORE_PAYLOAD_NAMES = %w( SCHEMA EXPLAIN )
+
+      component :active_record
+
+      def sql(event)
+        return if ignore?(event, :debug)
+
+        payload = event.payload
+
+        return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+        data = {
+          event:    event.name,
+          name:     payload[:name].presence,
+          sql:      payload[:sql],
+          duration: event.duration.to_f.round(2)
+        }
+
+        debug(event, data)
+      end
+    end
+  end
+end

data/lib/logged/log_subscriber/base.rb

@@ -0,0 +1,50 @@
+require 'active_support/log_subscriber'
+
+module Logged
+  module LogSubscriber
+    # Shared stuff for logged log subscribers
+    class Base < ::ActiveSupport::LogSubscriber
+      def self.component(component)
+        @component = component
+
+        Logged.register(component, self)
+      end
+
+      def logger
+        @logger ||= Logged.logger_by_component(component)
+      end
+
+      private
+
+      %w(info debug warn error fatal unknown).each do |level|
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{level}(event, progname = nil, &block)
+            return unless logger
+
+            progname = yield if block_given? && progname.nil?
+
+            return unless progname
+
+            progname['@event'] = event
+
+            logger.#{level}(progname)
+          end
+        METHOD
+      end
+
+      def component
+        self.class.instance_variable_get('@component')
+      end
+
+      def ignore?(event, log_level = nil)
+        return true unless logger
+        return true unless !log_level || logger.send("#{log_level}?")
+
+        return true if Logged.ignore?(Logged.config, event)
+        return true if Logged.ignore?(Logged.config[component], event)
+
+        false
+      end
+    end
+  end
+end