Fix specs kwargs

Gemfile

@@ -4,12 +4,9 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'growl'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'rails', "~> #{ENV["RAILS_VERSION"] || "3.2.0"}"
-  gem 'rb-fsevent', '~> 0.9'
-  gem 'rcov', :platforms => :mri_18
-  gem 'redis', :require => false
-  gem 'simplecov', :platforms => :mri_19, :require => false
+  gem 'pry-nav'
+  gem 'rails'
+  gem 'timecop'
+
+  gem 'syslog'
 end

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Shadab Ahmed
+
+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.

README.md

@@ -1,28 +1,22 @@
-# Logstasher [![Gem Version](https://badge.fury.io/rb/logstasher.png)](http://badge.fury.io/rb/logstasher) [![Build Status](https://secure.travis-ci.org/shadabahmed/logstasher.png)](https://secure.travis-ci.org/shadabahmed/logstasher)
-### Awesome Logging for Rails !!
+# Logstasher
 
-This gem is heavily inspired from [lograge](https://github.com/roidrage/lograge), but it's focused on one thing and one thing only. That's making your logs awesome like this:
+**Awesome Logging for Rails**
 
-[![Awesome Logs](http://i.imgur.com/zZXWQNp.png)](http://i.imgur.com/zZXWQNp.png)
+## History
 
-How it's done ?
+This is a fork of
+[shadabahmed/logstasher](https://github.com/shadabahmed/logstasher). It has
+been updated to use the [latest event
+schema](https://logstash.jira.com/browse/LOGSTASH-675) and customized to better
+fit the needs of MoneyDesktop--though it is still generally useful. It is not
+backward compatible with its progenitor.
 
-By, using these awesome tools:
-* [Logstash](http://logstash.net) - Store and index your logs
-* [Kibana](http://kibana.org/) - for awesome visualization. This is optional though, and you can use any other visualizer
+## Purpose
 
-To know how to setup these tools - visit my [blog](http://shadabahmed.com/blog/2013/04/30/logstasher-for-awesome-rails-logging)
+This gem makes it easy to generate logstash compatible logs for your rails app.
 
-## About logstasher
-
-This gem purely focuses on how to generate logstash compatible logs i.e. *logstash json event format*,  without any overhead. Infact, logstasher logs to a separate log file named `logstash_<environment>.log`.
-The reason for this separation:
- * To have a pure json log file
- * Prevent any logger messages(e.g. info) getting into our pure json logs
-
-Before **logstasher** :
-
-```
+A request that looks like this in your `production.log`:
+```text
 Started GET "/login" for 10.109.10.135 at 2013-04-30 08:59:01 -0400
 Processing by SessionsController#new as HTML
   Rendered sessions/new.html.haml within layouts/application (4.3ms)
@@ -34,68 +28,70 @@ Processing by SessionsController#new as HTML
 Completed 200 OK in 532ms (Views: 62.4ms | ActiveRecord: 0.0ms | ND API: 0.0ms)
 ```
 
-After **logstasher**:
-
-```
-{"@source":"unknown","@tags":["request"],"@fields":{"method":"GET","path":"/","format":"html","controller":"file_servers"
+Will look like this in your `logstash_production.log`:
+```json
+{"tags":["request"],"method":"GET","path":"/","format":"html","controller":"file_servers"
 ,"action":"index","status":200,"duration":28.34,"view":25.96,"db":0.88,"ip":"127.0.0.1","route":"file_servers#index",
 "parameters":"","ndapi_time":null,"uuid":"e81ecd178ed3b591099f4d489760dfb6","user":"shadab_ahmed@abc.com",
-"site":"internal"},"@timestamp":"2013-04-30T13:00:46.354500+00:00"}
+"site":"internal","@timestamp":"2013-04-30T13:00:46.354500+00:00","@version":"1"}
 ```
 
-By default, the older format rails request logs are disabled, though you can enable them.
+From there, it's trivial to forward them to your logstash indexer. You can even
+use the included redis log device to send the logs directly to a redis broker
+instead.
 
 ## Installation
 
 In your Gemfile:
 
-    gem 'logstasher'
+    gem 'md-logstasher'
 
 ### Configure your `<environment>.rb` e.g. `development.rb`
 
     # Enable the logstasher logs for the current environment
     config.logstasher.enabled = true
 
-    # This line is optional if you do not want to suppress app logs in your <environment>.log
-    config.logstasher.suppress_app_log = false
+    # Optionally silience the standard logging to <environment>.log
+    config.logstasher.silence_standard_logging = true
+
+## Logging params
 
-## Logging params hash
+By default, Logstasher will add params as a JSON encoded string. To disable,
+add the following to your `<environment>.rb`
 
-Logstasher can be configured to log the contents of the params hash.  When enabled, the contents of the params hash (minus the ActionController internal params)
-will be added to the log as a deep hash.  This can cause conflicts within the Elasticsearch mappings though, so should be enabled with care.  Conflicts will occur
-if different actions (or even different applications logging to the same Elasticsearch cluster) use the same params key, but with a different data type (e.g. a
-string vs. a hash).  This can lead to lost log entries.  Enabling this can also significantly increase the size of the Elasticsearch indexes.
+    # Disable logging of request parameters
+    config.logstasher.include_parameters = false
 
-To enable this, add the following to your `<environment>.rb`
+If you want the parameters to be sent unserialized, so they are indexed and
+searchable individually in elasticsearch, skip the serialization step.
+
+    # Log parameters individually
+    config.logstasher.serialize_parameters = false
 
-    # Enable logging of controller params
-    config.logstasher.log_controller_parameters = true
 
 ## Adding custom fields to the log
 
-Since some fields are very specific to your application for e.g. *user_name*, so it is left upto you, to add them. Here's how to add those fields to the logs:
+Since some fields are very specific to your application, e.g., *user_name*,
+it is left upto you to add them. Here's how to do it:
 
     # Create a file - config/initializers/logstasher.rb
 
     if LogStasher.enabled
-      LogStasher.add_custom_fields do |fields|
-        # This block is run in application_controller context, 
-        # so you have access to all controller methods
+      LogStasher.append_fields do |fields|
+        # This block is run within the context of the controller handling the
+        # request, so you have access to all its methods and instance variables
         fields[:user] = current_user && current_user.mail
         fields[:site] = request.path =~ /^\/api/ ? 'api' : 'user'
-
-        # If you are using custom instrumentation, just add it to logstasher custom fields
-        LogStasher.custom_fields << :myapi_runtime
       end
     end
 
 ## Versions
-All versions require Rails 3.0.x and higher and Ruby 1.9.2+. Tested on Rails 4 and Ruby 2.0
+All versions require Rails 3.0.x and higher and Ruby 1.9.2+. Tested on Rails 4
+and Ruby 2.0
 
 ## Development
  - Run tests - `rake`
- - Generate test coverage report - `rake coverage`. Coverage report path - coverage/index.html
 
 ## Copyright
 
-Copyright (c) 2013 Shadab Ahmed, released under the MIT license
+Copyright (c) 2014 Shadab Ahmed, released under the MIT license

Rakefile

@@ -1,42 +1,21 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-# Add default task. When you type just rake command this would run. Travis CI runs this. Making this run spec
 desc 'Default: run specs.'
 task :default => :spec
 
-# Defining spec task for running spec
 desc "Run specs"
 RSpec::Core::RakeTask.new('spec') do |spec|
-  # Pattern filr for spec files to run. This is default btw.
   spec.pattern = "./spec/**/*_spec.rb"
 end
 
-# Run the rdoc task to generate rdocs for this gem
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|
-  require "logstasher/version"
+  require 'logstasher/version'
   version = LogStasher::VERSION
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "logstasher #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-# Code coverage tasks. Different for Ruby 1.8 vs 1.9
-if RUBY_VERSION =~ /^1\.8/
-  # Ruby 1.8 uses rcov for code coverage
-  RSpec::Core::RakeTask.new(:coverage) do |spec|
-    spec.pattern = 'spec/**/*_spec.rb'
-    spec.rcov = true
-    spec.rcov_opts = %w{--exclude pkg\/,spec\/,features\/}
-  end
-else
-  # Ruby 1.9+ using simplecov. Note: Simplecov config defined in spec_helper
-  desc "Code coverage detail"
-  task :coverage do
-    ENV['COVERAGE'] = "true"
-    Rake::Task['spec'].execute
-  end
-end