stashing 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7d0081607df191265c2e884922516a8a9fcb227
+  data.tar.gz: a128c62947067509b5e39d83f6ee7890cd2b6157
+SHA512:
+  metadata.gz: 7c10eea784bbcde5962ac762370d8a317ed9414209dc0ae3c138840cf231f213da83d4e6a462ebe5c7d3c687183a787e1d388f1daff9b91c313261510590b4ea
+  data.tar.gz: 0b2d8c7414407563ba7e5243a9f33463b5d0c4bd5eda489a1c81c999db0723c84f0016739c61321ef4b1e6cfb9b93a938374b89ec5b404d1ec1cb96493595180

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    stashing (0.1.1)
+      logstasher
+      request_store
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    logstash-event (1.1.5)
+    logstasher (0.3.0)
+      logstash-event (~> 1.1.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    request_store (1.0.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  rails (>= 3.0)
+  rspec
+  stashing!

data/README.md

@@ -0,0 +1,73 @@
+# Stashing
+[![Build Status](https://travis-ci.org/elhu/stashing.png)](https://travis-ci.org/elhu/stashing) [![Code Climate](https://codeclimate.com/github/elhu/stashing.png)](https://codeclimate.com/github/elhu/stashing)
+### Wrapped-up [Logstasher](https://github.com/shadabahmed/logstasher) for easy ActiveSupport::Notifications logging
+
+LogStasher is awesome. It does one thing, and does it well.
+While you can add information to Logstasher very easily, it is harder to add information that changes over time, for example, the number of SQL queries performed during a request.
+
+## Installation
+In your Gemfile:
+
+```ruby
+gem 'stashing'
+```
+
+### Configure your `<environment>.rb` (for example: `production.rb`)
+
+```ruby
+# The options are the same as LogStasher's
+config.stashing.enabled = true
+config.stashing.suppress_app_log = false
+
+# Set this to true if you want to enable caching instrumentation
+config.stashing.enable_cache_instrumentation = true 
+```
+
+## Enter Stashing
+Stashing is a wrapper around LogStasher. It means that any option you set will be forwarded to LogStasher, Stashing takes care of everything!
+
+Stashing is simply here to help you log metrics based on [ActiveSupport::Notifications](http://guides.rubyonrails.org/active_support_instrumentation.html), by tracking them and adding them to the final payload.
+
+For example, if you want to log the number of SQL queries performed during a request, could can do:
+
+```ruby
+# config/initializers/stashing.rb
+Stashing.watch('sql.active_record') do |name, start, finish, id, payload, stash|
+  duration = (finish - start) * 1000
+  stash[:queries] = stash[:queries].to_i.succ
+end
+```
+
+`Stashing.watch` takes the notification's name in argument, and a block, called every time the notification is triggered, with the following arguments:
+
+* `name`: The notification's name
+* `start`: Beginning date for the event
+* `finish`: End date for the event
+* `id`: ID of the event
+* `payload`: Event's payload
+* `stash`: A thread-safe hash where you can store the data you want to log. This is reset after each request.
+
+If you want to share a `stash` between several events, you can assign them to an `event_group`:
+
+``` ruby
+# config/initializers/stashing.rb
+Stashing.watch('cache_fetch_hit.active_support', event_group: 'cache') do |*args, stash|
+  stash[:fetch_hit] = stash[:fetch_hit].to_i.succ
+end
+
+Stashing.watch('cache_generate.active_support', event_group: 'cache') do |*args, stash|
+  stash[:generate] = stash[:generate].to_i.succ
+end
+```
+
+See a complete [example](https://github.com/elhu/stashing/blob/master/examples/initializer.rb).
+
+Whatever you put in your `stash`, you'll get back in your log, with either the `event_group` or the event name as the key:
+
+```json
+{"@source":"unknown","@tags":["request"],"@fields":{"method":"GET","path":"/login","format":"html","controller":"session","action":"credential_requestor","status":200,"duration":1265.1,"view":1087.07,"db":89.96,"sql.active_record":{"queries":35,"slowest_query":14.312999999999999},"ip":"127.0.0.1","route":"session#credential_requestor","parameters":"service=http://example.com/login\n","user_id":null,"cas_id":null,"session_id":"e309097c16d4c4bd2ca1474b316e6406","request_id":"6dffb5ea-8075-4e38-b2ba-bb5f5264421a","cache":{"fetch_hit":3}},"@timestamp":"2013-11-21T14:35:08.210091+00:00"}
+```
+
+## Copyright
+
+Copyright &copy; 2013 Vincent Boisard, released under the MIT license.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+
+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

data/examples/initializer.rb

@@ -0,0 +1,23 @@
+if Stashing.enabled
+  Stashing.add_custom_fields do |fields|
+    fields[:user_id] = current_user.id
+    fields[:session_id] = session[:session_id]
+    fields[:request_id] = request.uuid
+  end
+
+  Stashing.watch('sql.active_record') do |name, start, finish, id, payload, stash|
+    duration = (finish - start) * 1000
+    stash[:queries] = stash[:queries].to_i.succ
+    if stash[:slowest_query].to_i < duration
+      stash[:slowest_query] = duration
+    end
+  end
+
+  Stashing.watch('cache_fetch_hit.active_support', event_group: 'cache') do |*args, stash|
+    stash[:fetch_hit] = stash[:fetch_hit].to_i.succ
+  end
+
+  Stashing.watch('cache_generate.active_support', event_group: 'cache') do |*args, stash|
+    stash[:generate] = stash[:generate].to_i.succ
+  end
+end

data/lib/stashing.rb

@@ -0,0 +1,40 @@
+require 'request_store'
+require 'forwardable'
+
+class Stashing
+  STORE_KEY = :stashing_data
+
+  class << self
+    attr_accessor :enable_cache_instrumentation
+
+    # Send all the dirty work to LogStasher
+    extend Forwardable
+    def_delegators :LogStasher, :enabled, :add_custom_fields, :custom_fields=, :custom_fields
+  end
+
+  def self.stash
+    if RequestStore.store[STORE_KEY].nil?
+      # Get each event_store it's own private Hash instance.
+      RequestStore.store[STORE_KEY] = Hash.new { |hash, key| hash[key] = {} }
+    end
+    RequestStore.store[STORE_KEY]
+  end
+
+  def self.watch(event, opts = {}, &block)
+    event_group = opts[:event_group] || event
+    ActiveSupport::Notifications.subscribe(event) do |*args|
+      # It's necessary to add the custom_fields at runtime, otherwise LogStasher overrides them.
+      Stashing.custom_fields << event_group unless Stashing.custom_fields.include? event_group
+
+      # Calling the processing block with the Notification args, plus the event_stash
+      block.call(*args, stash[event_group])
+    end
+  end
+end
+
+# LogStasher must be loaded AFTER Stashing's Railtie
+if defined?(Rails)
+  require 'stashing/railtie'
+else
+  require 'logstasher'
+end

data/lib/stashing/controller_ext.rb

@@ -0,0 +1,26 @@
+require 'active_support/concern'
+
+class Stashing
+  module ControllerExt
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :enable_cache_instrumentation
+    end
+
+    protected
+    def enable_cache_instrumentation
+      # Cache instrumentation is disabled by default in Rails
+      Rails.cache.class.instrument = true if Stashing.enable_cache_instrumentation
+    end
+
+    def append_info_to_payload(payload)
+      super
+      # At the end of the request (process_action.action_controller), add the store to the payload
+      Stashing.stash.each do |key, value|
+        payload[key] = value
+      end
+    end
+
+  end
+end

data/lib/stashing/railtie.rb

@@ -0,0 +1,23 @@
+require 'rails/railtie'
+require 'stashing/controller_ext'
+
+class Stashing
+  class Railtie < Rails::Railtie
+    config.stashing = ActiveSupport::OrderedOptions.new
+    config.stashing.enabled = false
+    config.stashing.enable_cache_instrumentation = false
+
+    initializer :stashing do |app|
+      # Extending ActionController with the controller extension
+      ActiveSupport.on_load(:action_controller) { include Stashing::ControllerExt }
+
+      # Pass the configuration over to logstasher
+      app.config.logstasher = app.config.stashing
+
+      # Should we enable cache instrumentation?
+      Stashing.enable_cache_instrumentation = app.config.stashing.enable_cache_instrumentation
+    end
+  end
+end
+
+require 'logstasher'

data/lib/stashing/version.rb

@@ -0,0 +1,3 @@
+class Stashing
+  VERSION = "0.1.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'active_support'
+require 'stashing'

data/spec/stashing/stashing_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+
+describe 'Stashing' do
+  describe '#store' do
+    it "returns a new Hash for each key" do
+      expect(Stashing.stash['a'].object_id).to_not be(Stashing.stash['b'].object_id)
+    end
+
+    it "returns the same stash if called several time with the same key" do
+      expect(Stashing.stash['a'].object_id).to be(Stashing.stash['a'].object_id)
+    end
+  end
+
+  describe "#watch" do
+    it "subscribes to the required event" do
+      ActiveSupport::Notifications = double("Notifications")
+      ActiveSupport::Notifications.should_receive(:subscribe).with('event_name')
+      Stashing.watch('event_name')
+    end
+  end
+end

data/stashing.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "stashing/version"
+
+Gem::Specification.new do |s|
+  s.name        = "stashing"
+  s.version     = Stashing::VERSION
+  s.authors     = ["Vincent Boisard"]
+  s.email       = ["boisard.v@gmail.com"]
+  s.homepage    = "https://github.com/elhu/stashing"
+  s.summary     = %q{Logstash wrapper for easy ActiveSupport::Notifications logging}
+  s.description = s.summary
+  s.licenses    = 'MIT'
+
+  s.rubyforge_project = "stashing"
+
+  s.files         = `git ls-files`.split("\n") - [".gitignore"]
+  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"]
+
+  s.add_runtime_dependency "logstasher"
+  s.add_runtime_dependency "request_store"
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency("bundler", [">= 1.0.0"])
+  s.add_development_dependency("rails", [">= 3.0"])
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: stashing
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Vincent Boisard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstasher
+  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: 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Logstash wrapper for easy ActiveSupport::Notifications logging
+email:
+- boisard.v@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- examples/initializer.rb
+- lib/stashing.rb
+- lib/stashing/controller_ext.rb
+- lib/stashing/railtie.rb
+- lib/stashing/version.rb
+- spec/spec_helper.rb
+- spec/stashing/stashing_spec.rb
+- stashing.gemspec
+homepage: https://github.com/elhu/stashing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: stashing
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Logstash wrapper for easy ActiveSupport::Notifications logging
+test_files:
+- spec/spec_helper.rb
+- spec/stashing/stashing_spec.rb
+has_rdoc: