logstasher 0.5.0 → 0.5.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGM0Y2IzY2FhZmU1OGI4ZGY3NmRhMWI4ZjBlMjY0ZGI4YTdjNDYzOA==
+    NDFjMDY1Nzc2ODM1NzA2NjlmNzZlMjIyZmVhNmVjNjZkMWZjZmUzZQ==
   data.tar.gz: !binary |-
-    Y2NjYTljN2IwMGJhYjYwYjQ0ZDExMWU5OWYzNDcyZTRkOWI5YjViOA==
+    OWJmOWU3ODQzMjU2OWM5ZTk4ZmMxYjkxZjM0ZDJhZjkzNTg0MmE5Mw==
 SHA512:
   metadata.gz: !binary |-
-    NjE1NmIxYzcwZDU4ODc4MGM3NmVlNjE4NzlhMzFiMjZjMTk3OTY4N2E3NDk1
-    Yjk0YzAyZjU5NDY4ZjY1YzE4MzljYjU3MTM1YzJiMTE4ZjgyNmQzMzBjZDVj
-    NTA5NzlmNWNmMjczYmM4YjdhYTQyMDVhMDFkNWU4MjVhMmY2N2E=
+    ODQ0NWM2NmMxMTRmNGIzOTdlMzlhOTZjYzE0ZjVhZGZiYjZhZDc5NmE1NWJm
+    OGFiYWRhNWI5ZjJjOWEzZjhjMmIxMGQ2N2ZlYWY0MTE1NjI0YmQzN2MxMTM1
+    ZGJiMDY5ZDg5Nzg0YmFkZWUxNzIxMTRhYTY3ZjUyMTQzZDI2N2Q=
   data.tar.gz: !binary |-
-    MDI0NDAwMGI4ZmYxNjJmMGRjYzRhMTM2NzhkOTgwOTFkOTg1MzQ1OWRlNTAw
-    YThiNWM0YzA5NjQ2NDZiYzAyMmU2NmRhYTdjNDQwNzEzYzc3YThmNjZlYjBj
-    NDU3NTFjZjkxYzg1MGM5NTIyODlhYjkwNDlkZGFkNjE2YWU2NDM=
+    YjhiZDMzM2Q4NGE0MmZhODM2YWU3NjNmNjU5OWU1NDQyNTdlNTEwNjUzNmFk
+    YzUzZTc5YjIxMTFlNTYwNjQyYmI2YWMzYjI2NDY3OTZlOGEzOTQ2MDE4OTVh
+    MDQyZjk0Mzk0YmM5YzRkZGU4MGRiNjg5MDBmZmJiODQzMzllYzc=

data/README.md

@@ -3,7 +3,7 @@
 
 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 Logs](http://i.imgur.com/zZXWQNp.png)](http://i.imgur.com/zZXWQNp.png)
+[![Awesome Logs](https://f.cloud.github.com/assets/830679/2407078/dcde03e8-aa82-11e3-85ac-8c5b3a86676e.png)](https://f.cloud.github.com/assets/830679/2407078/dcde03e8-aa82-11e3-85ac-8c5b3a86676e.png)
 
 How it's done ?
 
@@ -11,7 +11,9 @@ 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
 
-To know how to setup these tools - visit my [blog](http://shadabahmed.com/blog/2013/04/30/logstasher-for-awesome-rails-logging)
+Update: Logstash now includes Kibana build in, so no need to separately install. Logstasher has been test with **logstash version 1.3.3**
+
+See [quickstart](#quick-setup-for-logstash) for quickly setting up logstash
 
 ## About logstasher
 
@@ -92,6 +94,49 @@ Since some fields are very specific to your application for e.g. *user_name*, so
       end
     end
 
+## Listening to `ActiveSupport::Notifications` events
+
+It is possible to listen to any `ActiveSupport::Notifications` events and store arbitrary data to be included in the final JSON log entry:
+
+    # In config/initializers/logstasher.rb
+
+    # Watch calls the block with the same arguments than any ActiveSupport::Notification, plus a store
+    LogStasher.watch('some.activesupport.notification') do |name, start, finish, id, payload, store|
+      # Do something
+      store[:count] = 42
+    end
+
+Would change the log entry to:
+
+```
+{"@source":"unknown","@tags":["request"],"@fields":{"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","some.activesupport.notification":{"count":42}},"@timestamp":"2013-04-30T13:00:46.354500+00:00"}
+```
+
+The store exposed to the blocked passed to `watch` is thread-safe, and reset after each request.
+By default, the store is only shared between occurences of the same event.
+You can easily share the same store between different types of notifications, by assigning them to the same event group:
+
+    # In config/initializers/logstasher.rb
+
+    LogStasher.watch('foo.notification', event_group: 'notification') do |*args, store|
+      # Shared store with 'bar.notification'
+    end
+
+    LogStasher.watch('bar.notification', event_group: 'notification') do |*args, store|
+      # Shared store with 'foo.notification'
+    end
+
+## Quick Setup for Logstash
+
+* Download logstash from [logstash.net](http://www.logstash.net/)
+* Use this sample config file: [quickstart.conf](https://github.com/shadabahmed/logstasher/raw/master/sample_logstash_configurations/quickstart.conf)
+* Start logstash with the following command:
+```
+java -jar logstash-1.3.3-flatjar.jar agent -f quickstart.conf -- web
+```
+* Visit http://localhost:9292/ to see the Kibana interface and your parsed logs
+* For advanced options see the latest logstash documentation at [logstash.net](http://www.logstash.net/) or visit my blog at (shadabahmed.com)[http://shadabahmed.com/blog/2013/04/30/logstasher-for-awesome-rails-logging] (slightly outdated but will sure give you ideas for distributed setup etc.)
+
 ## Versions
 All versions require Rails 3.0.x and higher and Ruby 1.9.2+. Tested on Rails 4 and Ruby 2.0
 
@@ -102,3 +147,7 @@ All versions require Rails 3.0.x and higher and Ruby 1.9.2+. Tested on Rails 4 a
 ## Copyright
 
 Copyright (c) 2013 Shadab Ahmed, released under the MIT license
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/shadabahmed/logstasher/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/logstasher.rb

@@ -1,11 +1,14 @@
 require 'logstasher/version'
 require 'logstasher/log_subscriber'
+require 'request_store'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/ordered_options'
 
 module LogStasher
   extend self
+  STORE_KEY = :logstasher_data
+
   attr_accessor :logger, :enabled, :log_controller_parameters, :source
   # Setting the default to 'unknown' to define the default behaviour
   @source = 'unknown'
@@ -43,8 +46,12 @@ module LogStasher
   end
 
   def add_custom_fields(&block)
-    ActionController::Metal.send(:define_method, :logtasher_add_custom_fields_to_payload, &block)
-    ActionController::Base.send(:define_method, :logtasher_add_custom_fields_to_payload, &block)
+    wrapped_block = lambda do |fields|
+      LogStasher.custom_fields.concat(LogStasher.store.keys)
+      block.call(fields)
+    end
+    ActionController::Metal.send(:define_method, :logtasher_add_custom_fields_to_payload, &wrapped_block)
+    ActionController::Base.send(:define_method, :logtasher_add_custom_fields_to_payload, &wrapped_block)
   end
 
   def setup(app)
@@ -88,6 +95,22 @@ module LogStasher
     end
   end
 
+  def store
+    if RequestStore.store[STORE_KEY].nil?
+      # Get each store it's own private Hash instance.
+      RequestStore.store[STORE_KEY] = Hash.new { |hash, key| hash[key] = {} }
+    end
+    RequestStore.store[STORE_KEY]
+  end
+
+  def watch(event, opts = {}, &block)
+    event_group = opts[:event_group] || event
+    ActiveSupport::Notifications.subscribe(event) do |*args|
+      # Calling the processing block with the Notification args and the store
+      block.call(*args, store[event_group])
+    end
+  end
+
   %w( fatal error warn info debug unknown ).each do |severity|
     eval <<-EOM, nil, __FILE__, __LINE__ + 1
       def #{severity}(msg)

data/lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb

@@ -16,7 +16,7 @@ module ActionController
 
       ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
         result = super
-        
+
         if self.respond_to?(:logtasher_add_custom_fields_to_payload)
           before_keys = raw_payload.keys.clone
           logtasher_add_custom_fields_to_payload(raw_payload)
@@ -24,9 +24,12 @@ module ActionController
           # Store all extra keys added to payload hash in payload itself. This is a thread safe way
           LogStasher.custom_fields += after_keys - before_keys
         end
-        
+
         payload[:status] = response.status
         append_info_to_payload(payload)
+        LogStasher.store.each do |key, value|
+          payload[key] = value
+        end
         result
       end
     end

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

data/logstasher.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.add_runtime_dependency "logstash-event", ["~> 1.1.0"]
+  s.add_runtime_dependency "request_store"
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"

data/sample_logstash_configurations/quickstart.conf

@@ -0,0 +1,23 @@
+input {
+  file { 
+    type => "rails logs"
+    path => "/Users/shadab/test_project/logstash_development.log"
+    codec =>   json {
+      charset => "UTF-8"
+    }
+  } 
+}
+
+output {
+  # Print each event to stdout.
+  stdout {
+    codec => rubydebug
+  }
+  
+  elasticsearch {
+    # Setting 'embedded' will run  a real elasticsearch server inside logstash.
+    # This option below saves you from having to run a separate process just
+    # for ElasticSearch, so you can get started quicker!
+    embedded => true
+  }
+}

data/spec/lib/logstasher_spec.rb

@@ -176,4 +176,40 @@ describe LogStasher do
       end
     end
   end
+
+  describe '.store' do
+    it "returns a new Hash for each key" do
+      expect(LogStasher.store['a'].object_id).to_not be(LogStasher.store['b'].object_id)
+    end
+
+    it "returns the same store if called several time with the same key" do
+      expect(LogStasher.store['a'].object_id).to be(LogStasher.store['a'].object_id)
+    end
+
+  end
+
+  describe ".watch" do
+    before(:each) { LogStasher.custom_fields = [] }
+
+    it "subscribes to the required event" do
+      ActiveSupport::Notifications.should_receive(:subscribe).with('event_name')
+      LogStasher.watch('event_name')
+    end
+
+    it 'executes the block when receiving an event' do
+      probe = lambda {}
+      LogStasher.watch('custom.event.foo', &probe)
+      expect(probe).to receive(:call)
+      ActiveSupport::Notifications.instrument('custom.event.foo', {})
+    end
+
+    describe "store" do
+      it 'stores the events in a store with the event\'s name' do
+        probe = lambda { |*args, store| store[:foo] = :bar }
+        LogStasher.watch('custom.event.bar', &probe)
+        ActiveSupport::Notifications.instrument('custom.event.bar', {})
+        LogStasher.store['custom.event.bar'].should == {:foo => :bar}
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Shadab Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ files:
 - lib/logstasher/railtie.rb
 - lib/logstasher/version.rb
 - logstasher.gemspec
+- sample_logstash_configurations/quickstart.conf
 - spec/lib/logstasher/device/redis_spec.rb
 - spec/lib/logstasher/log_subscriber_spec.rb
 - spec/lib/logstasher_spec.rb