lograge 0.3.0 → 0.3.1

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/.rspec

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

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-script: bundle exec rspec

data/CHANGES.md

@@ -1,11 +0,0 @@
-### 0.3.0
-
-* #47: Add formatter for l2met (<https://github.com/BRMatt>)
-
-* #55: Update Logstash formatter for Logstash 1.2 format (<https://github.com/msaffitz>)
-
-* #56: Add JSON formatter (<https://github.com/i0rek>)
-
-* #59: Add `before_format` hook (<https://github.com/i0rek>)
-
-* #60: Add Ruby 2.1.0 for testing on Travis CI (<https://github.com/salimane>)

data/Gemfile

@@ -1,9 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in lograge.gemspec
-gemspec
-
-group :test do
-  gem 'actionpack'
-  gem 'logstash-event', '1.1.5'
-end

data/Guardfile

@@ -1,9 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', :version => 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-

data/README.md

@@ -1,235 +0,0 @@
-Lograge - Taming Rails' Default Request Logging
-=======
-
-Lograge is an attempt to bring sanity to Rails' noisy and unusable, unparsable
-and, in the context of running multiple processes and servers, unreadable
-default logging output. Rails' default approach to log everything is great
-during development, it's terrible when running it in production. It pretty much
-renders Rails logs useless to me.
-
-Lograge is a work in progress. I appreciate constructive feedback and criticism.
-My main goal is to improve Rails' logging and to show people that they don't
-need to stick with its defaults anymore if they don't want to.
-
-Instead of trying solving the problem of having multiple lines per request by
-switching Rails' logger for something that outputs syslog lines or adds a
-request token, Lograge replaces Rails' request logging entirely, reducing the
-output per request to a single line with all the important information, removing
-all that clutter Rails likes to include and that gets mingled up so nicely when
-multiple processes dump their output into a single file.
-
-Instead of having an unparsable amount of logging output like this:
-
-```
-Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
-Processing by HomeController#index as HTML
-  Rendered text template within layouts/application (0.0ms)
-  Rendered layouts/_assets.html.erb (2.0ms)
-  Rendered layouts/_top.html.erb (2.6ms)
-  Rendered layouts/_about.html.erb (0.3ms)
-  Rendered layouts/_google_analytics.html.erb (0.4ms)
-Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
-```
-
-you get a single line with all the important information, like this:
-
-```
-method=GET path=/jobs/833552.json format=json controller=jobs action=show status=200 duration=58.33 view=40.43 db=15.26
-```
-
-The second line is easy to grasp with a single glance and still includes all the
-relevant information as simple key-value pairs. The syntax is heavily inspired
-by the log output of the Heroku router. It doesn't include any timestamp by
-default, instead it assumes you use a proper log formatter instead.
-
-**Installation**
-
-In your Gemfile
-
-```ruby
-gem "lograge"
-```
-
-Enable it for the relevant environments, e.g. production:
-
-```ruby
-# config/environments/production.rb
-MyApp::Application.configure do
-  config.lograge.enabled = true
-end
-```
-
-You can also add a hook for own custom data
-
-```ruby
-# config/environments/staging.rb
-MyApp::Application.configure do
-  config.lograge.enabled = true
-
-  # custom_options can be a lambda or hash
-  # if it's a lambda then it must return a hash
-  config.lograge.custom_options = lambda do |event|
-    # capture some specific timing values you are interested in
-    {:name => "value", :timing => some_float.round(2), :host => event.payload[:host]}
-  end
-end
-```
-
-Or you can add a timestamp:
-
-```ruby
-MyApp::Application.configure do
-  config.lograge.enabled = true
-
-  # add time to lograge
-  config.lograge.custom_options = lambda do |event|
-    {:time => event.time}
-  end
-end
-```
-
-You can then add custom variables to the event to be used in custom_options
-
-```ruby
-# app/controllers/application_controller.rb
-class ApplicationController < ActionController::Base
-  def append_info_to_payload(payload)
-    super
-    payload[:host] = request.host
-  end
-end
-```
-
-To further clean up your logging, you can also tell Lograge to skip log messages 
-meeting given criteria.  You can skip log messages generated from certain controller
-actions, or you can write a custom handler to skip messages based on data in the log event:
-
-```ruby
-# config/environments/production.rb
-MyApp::Application.configure do
-  config.lograge.enabled = true
-
-  config.lograge.ignore_actions = ['home#index', 'aController#anAction']
-  config.lograge.ignore_custom = lambda do |event|
-    # return true here if you want to ignore based on the event
-  end
-end
-```
-
-Lograge supports multiple output formats. The most common is the default
-lograge key-value format described above. Alternatively, you can also generate
-JSON logs in the json_event format used by [Logstash](http://logstash.net/).
-
-```ruby
-# config/environments/production.rb
-MyApp::Application.configure do
-  config.lograge.formatter = Lograge::Formatters::Logstash.new
-end
-```
-
-*Note:* When using the logstash output, you need to add the additional gem
-`logstash-event`. You can simply add it to your Gemfile like this
-
-```ruby
-gem "logstash-event"
-```
-
-Done.
-
-The available formatters are:
-
-```ruby
-  Lograge::Formatters::Cee.new
-  Lograge::Formatters::Graylog2.new
-  Lograge::Formatters::KeyValue.new  # default lograge format
-  Lograge::Formatters::Logstash.new
-  Lograge::Formatters::Raw.new       # Returns a ruby hash object
-```
-
-In addition to the formatters, you can manipulate the data your self by passing
-an object which responds to #call:
-
-```ruby
-# config/environments/production.rb
-MyApp::Application.configure do
-  config.lograge.formatter = ->(data) { "Called #{data[:controller]}" } # data is a ruby hash
-end
-```
-
-**Internals**
-
-Thanks to the notification system that was introduced in Rails 3, replacing the
-logging is easy. Lograge unhooks all subscriptions from
-`ActionController::LogSubscriber` and `ActionView::LogSubscriber`, and hooks in
-its own log subscription, but only listening for two events: `process_action`
-and `redirect_to`. It makes sure that only subscriptions from those two classes
-are removed. If you happened to hook in your own, they'll be safe.
-
-Unfortunately, when a redirect is triggered by your application's code,
-ActionController fires two events. One for the redirect itself, and another one
-when the request is finished. Unfortunately the final event doesn't include the
-redirect, so Lograge stores the redirect URL as a thread-local attribute and
-refers to it in `process_action`.
-
-The event itself contains most of the relevant information to build up the log
-line, including view processing and database access times.
-
-While the LogSubscribers encapsulate most logging pretty nicely, there are still
-two lines that show up no matter what. The first line that's output for every
-Rails request, you know, this one:
-
-```
-Started GET "/" for 127.0.0.1 at 2012-03-12 17:10:10 +0100
-```
-
-And the verbose output coming from rack-cache:
-
-```
-cache: [GET /] miss
-```
-
-Both are independent of the LogSubscribers, and both need to be shut up using
-different means.
-
-For the first one, the starting line of every Rails request log, Lograge
-replaces code in `Rails::Rack::Logger` to remove that particular log line. It's
-not great, but it's just another unnecessary output and would still clutter the
-log files. Maybe a future version of Rails will make this log line an event as
-well.
-
-To remove rack-cache's output (which is only enabled if caching in Rails is
-enabled), Lograge disables verbosity for rack-cache, which is unfortunately
-enabled by default.
-
-There, a single line per request. Beautiful.
-
-**What it doesn't do**
-
-Lograge is opinionated, very opinionated. If the stuff below doesn't suit your
-needs, it may not be for you.
-
-Lograge removes ActionView logging, which also includes rendering times for
-partials. If you're into those, Lograge is probably not for you. In my honest
-opinion, those rendering times don't belong in the log file, they should be
-collected in a system like New Relic, Librato Metrics or some other metrics
-service that allows graphing rendering percentiles. I assume this for everything
-that represents a moving target. That kind of data is better off being
-visualized in graphs than dumped (and ignored) in a log file.
-
-Lograge doesn't yet log the request parameters. This is something I'm actively
-contemplating, mainly because I want to find a good way to include them, a way
-that fits in with the general spirit of the log output generated by Lograge.
-
-**Changes**
-
-* Add support for Graylog2 events (Lennart Koopmann, http://github.com/lennartkoopmann)
-* Add support for Logstash events (Holger Just, http://github.com/meineerde)
-* Fix for Rails 3.2.9
-* Use keys everywhere (Curt Michols, http://github.com/asenchi)
-* Add `custom_options` to allow adding custom key-value pairs at runtime (Adam
-  Cooper, https://github.com/adamcooper)
-
-**License**
-
-MIT. Code extracted from [Travis CI](http://travis-ci.org).
-(c) 2012 Mathias Meyer

data/Rakefile

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

data/lograge.gemspec

@@ -1,27 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "lograge/version"
-
-Gem::Specification.new do |s|
-  s.name        = "lograge"
-  s.version     = Lograge::VERSION
-  s.authors     = ["Mathias Meyer"]
-  s.email       = ["meyer@paperplanes.de"]
-  s.homepage    = "https://github.com/roidrage/lograge"
-  s.summary     = %q{Tame Rails' multi-line logging into a single line per request}
-  s.description = %q{Tame Rails' multi-line logging into a single line per request}
-
-  s.rubyforge_project = "lograge"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "guard-rspec"
-  s.add_runtime_dependency "activesupport", '>= 3'
-  s.add_runtime_dependency "actionpack", '>= 3'
-  s.add_runtime_dependency "railties", '>= 3'
-end

data/spec/formatters/cee_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::Cee do
-  it { expect( subject.call({})).to match(/^@cee/) }
-  it { expect(subject.call({ custom: 'data'})).to match('{"custom":"data"}') }
-end

data/spec/formatters/graylog2_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::Graylog2 do
-  let(:payload) do
-    {
-      custom: 'data',
-      status: 200,
-      method: 'GET',
-      path: '/',
-      controller: 'welcome',
-      action: 'index'
-    }
-  end
-  subject { described_class.new.call(payload) }
-  it { expect(subject[:_custom]).to eq('data') }
-  it { expect(subject[:short_message]).to eq('[200] GET / (welcome#index)') }
-end

data/spec/formatters/json_spec.rb

@@ -1,6 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::Json do
-  it { expect( subject.call({ custom: 'data' })).to eq('{"custom":"data"}') }
-end

data/spec/formatters/key_value_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::KeyValue do
-  let(:payload) do
-    {
-      custom: 'data',
-      status: 200,
-      method: 'GET',
-      path: '/',
-      controller: 'welcome',
-      action: 'index'
-    }
-  end
-
-  subject { described_class.new.call(payload) }
-
-  it { should include('controller=welcome') }
-  it { should include('action=index') }
-
-  it_behaves_like "a key value formatter"
-end

data/spec/formatters/l2met_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::L2met do
-  let(:payload) do
-    {
-      custom: 'data',
-      status: 200,
-      method: 'GET',
-      path: '/',
-      controller: 'admin/welcome',
-      action: 'index',
-      db: 20.00,
-      view: 10.00, 
-      duration: 30.00,
-      cache: 40.00
-    }
-  end
-
-  it_behaves_like "a key value formatter"
-
-  subject { described_class.new.call(payload) }
-
-  it { should include('source=admin-welcome:index') }
-  it { should_not include('controller=admin/welcome') }
-  it { should_not include('action=index') }
-  it { should include('measure#page.duration=30.00') }
-  it { should include('measure#page.view=10.00') }
-  it { should include('measure#page.db=20.00') }
-  it { should include('measure#page.cache=40.00') }
-end

data/spec/formatters/logstash_spec.rb

@@ -1,22 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::Logstash do
-  let(:payload) do
-    {
-      custom: 'data',
-      status: 200,
-      method: 'GET',
-      path: '/',
-      controller: 'welcome',
-      action: 'index'
-    }
-  end
-  subject { described_class.new.call(payload) }
-  it { should match(/"custom":"data"/) }
-  it { should match(/"status":200/) }
-  it { should match(/"method":"GET"/) }
-  it { should match(/"path":"\/"/) }
-  it { should match(/"controller":"welcome"/) }
-  it { should match(/"action":"index"/) }
-end

data/spec/formatters/raw_spec.rb

@@ -1,6 +0,0 @@
-require 'spec_helper'
-require 'lograge'
-
-describe Lograge::Formatters::Raw do
-  it { expect( subject.call({ custom: 'data' })).to eq({ custom: 'data' }) }
-end