rails_riemann_middleware 0.5.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/

data/Gemfile

@@ -0,0 +1,14 @@
+# -*- mode: Ruby; tab-width: 2; -*-
+source 'https://rubygems.org'
+
+group :test do
+  gem "minitest", "~> 4.6.2"
+  gem 'minitest-reporters', "~> 0.14.7"
+  gem 'minitest-metadata', "~> 0.2.0"
+end
+
+gem "rake"
+gem "awesome_print"
+
+# Specify your gem's dependencies in rails_riemann_middleware.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Richard Outten
+
+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,40 @@
+# RailsRiemannMiddleware
+
+A middleware to add to your rails application that sends request
+duration metrics and exception notifications to
+[Riemann](http://riemann.io/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_riemann_middleware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_riemann_middleware
+
+## Usage
+
+Add the following to your specific rails enviroment.
+
+    config.middleware.use(RailsRiemannMiddleware::Notifier, 
+                          :riemann_host => "riemann_host_name")
+
+## Running Tests
+
+To run the tests use:
+
+    $ bundle exec rake test
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "specs"
+  t.test_files = FileList['specs/**/*_spec.rb']
+  t.verbose = true
+end

data/lib/rails_riemann_middleware.rb

@@ -0,0 +1,30 @@
+require "rails_riemann_middleware/version"
+require "rails_riemann_middleware/event"
+require "rails_riemann_middleware/duration"
+require "rails_riemann_middleware/exception_notification"
+
+module RailsRiemannMiddleware
+
+  class Notifier
+    attr_reader :event, :send_durations, :send_exceptions
+    
+    def initialize(app, options = {})
+      @app, @options = app, options
+      @send_durations  = options.fetch(:send_durations, true)
+      @send_exceptions = options.fetch(:send_exceptions, true)
+      @event = Event.new(options)
+    end
+
+    def call(env)
+      start_time = Time.now
+      @app.call(env)
+    rescue Exception => exception
+      ExceptionNotification.new(event, env, exception).send if send_exceptions
+      raise exception
+    ensure
+      Duration.new(event, env, start_time).send if send_durations
+    end
+
+  end
+
+end

data/lib/rails_riemann_middleware/duration.rb

@@ -0,0 +1,32 @@
+require 'riemann/client'
+
+module RailsRiemannMiddleware
+
+  class Duration
+    attr_reader :event, :env, :start_time
+    
+    def initialize(event, env, start_time)
+      @event, @env, @start_time = event, env, start_time
+    end
+
+    def send
+      event << message
+    end
+    
+    def message
+      end_time = Time.new
+      duration = (end_time - start_time)
+      msg = {
+        :host        => env['HTTP_HOST'],
+        :service     => "#{event.app_prefix} request duration".strip,
+        :state       => 'info',
+        :metric      => duration,
+        :tags        => ["duration"]
+      }
+      # ap msg
+      msg
+    end
+
+  end
+  
+end

data/lib/rails_riemann_middleware/event.rb

@@ -0,0 +1,40 @@
+require 'riemann/client'
+
+module RailsRiemannMiddleware
+
+  class Event
+    attr_reader :client, :options, :reporting_host, :tags
+    
+    def initialize(options)
+      @options         = options
+      @client          = create_riemann_client
+      @reporting_host  = options[:reporting_host]
+      @tags            = options.fetch(:tags, [])
+      @attributes      = options.fetch(:attributes, {})
+    end
+
+    def <<(msg)
+      msg[:tags] += Array(tags)
+      client << {:time => time_for_client, :host => reporting_host}.merge(@attributes).merge(msg)
+    end
+
+    def app_prefix
+      options.fetch(:app_prefix, "")
+    end
+
+    private
+
+    def time_for_client
+      Time.now.to_i - 10
+    end
+
+    def create_riemann_client
+      riemann_host    = options.fetch(:riemann_host, "127.0.0.1")
+      riemann_port    = options.fetch(:riemann_port, "5555")
+
+      Riemann::Client.new(:host => riemann_host, :port => riemann_port)
+    end
+    
+  end
+  
+end

data/lib/rails_riemann_middleware/exception_notification.rb

@@ -0,0 +1,36 @@
+module RailsRiemannMiddleware
+  
+  class ExceptionNotification
+    attr_reader :event, :env, :exception
+    
+    def initialize(event, env, exception)
+      @event, @env, @exception = event, env, exception
+    end
+
+    def send
+      event << message
+    end
+    
+    def message
+      msg = {
+        :host        => env['HTTP_HOST'],
+        :service     => "#{event.app_prefix} exception".strip,
+        :state       => 'error',
+        :description => backtrace,
+        :tags        => ["exception"]
+      }
+      # ap msg
+      msg
+    end
+
+    private
+
+    def backtrace
+      e = "#{exception.to_s}\n"
+      e << exception.backtrace.join("\n")
+      e[0..8000]
+    end
+    
+  end
+  
+end

data/lib/rails_riemann_middleware/version.rb

@@ -0,0 +1,3 @@
+module RailsRiemannMiddleware
+  VERSION = "0.5.0"
+end

data/rails_riemann_middleware.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails_riemann_middleware/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Richard Outten"]
+  gem.email         = ["outtenr@gmail.com"]
+  gem.description   = %q{Rack middleware for sending data to riemann}
+  gem.summary       = %q{Rack middleware for sending data to riemann}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rails_riemann_middleware"
+  gem.require_paths = ["lib"]
+  gem.version       = RailsRiemannMiddleware::VERSION
+
+  gem.add_dependency("riemann-client", "~> 0.2.0")
+
+end

data/specs/duraction_spec.rb

@@ -0,0 +1,44 @@
+require_relative 'spec_helper'
+require 'minitest/mock'
+require 'awesome_print'
+require 'rails_riemann_middleware/duration'
+
+describe RailsRiemannMiddleware::Duration do
+
+  before do
+    @start_time = Time.at(0)
+    @env = {}
+    @event = MiniTest::Mock.new
+    @event.expect :app_prefix, "TEST APP"
+  end
+
+  it "should set the duration to 100 second" do
+    d = RailsRiemannMiddleware::Duration.new(@event, @env, @start_time)
+    Time.stub :new, Time.at(100) do
+      d.message[:metric].must_equal 100
+    end
+  end
+
+  it "should set the host to the value of HTTP_HOST" do
+    @env["HTTP_HOST"] = "my.test.host"
+    d = RailsRiemannMiddleware::Duration.new(@event, @env, @start_time)
+    d.message[:host].must_equal "my.test.host"
+  end
+
+  it "should add the hash to the message array" do
+    to_send = []
+    def to_send.app_prefix
+      "TEST APP"
+    end
+    d = RailsRiemannMiddleware::Duration.new(to_send, @env, @start_time)
+    result = d.send
+    result.size.must_equal 1
+    result.first[:service].must_match /^TEST APP/
+  end
+
+  it "should have a state of 'info'" do
+    d = RailsRiemannMiddleware::Duration.new(@event, @env, @start_time)
+    d.message[:state].must_equal "info"
+  end
+
+end

data/specs/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.push File.expand_path("../../lib", __FILE__)
+require 'minitest/autorun'
+
+if ENV['USE_SPECS']
+  require 'minitest/reporters'
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rails_riemann_middleware
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Outten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riemann-client
+  requirement: &70318980766960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70318980766960
+description: Rack middleware for sending data to riemann
+email:
+- outtenr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails_riemann_middleware.rb
+- lib/rails_riemann_middleware/duration.rb
+- lib/rails_riemann_middleware/event.rb
+- lib/rails_riemann_middleware/exception_notification.rb
+- lib/rails_riemann_middleware/version.rb
+- rails_riemann_middleware.gemspec
+- specs/duraction_spec.rb
+- specs/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rack middleware for sending data to riemann
+test_files: []
+has_rdoc: