friendlyfashion-graylog2_exceptions 1.3.1

data/README

@@ -0,0 +1,5 @@
+Log all the Exceptions of your Rack application to a Graylog2 server.
+
+Installation and configuration instructions in the Wiki.
+
+More information about Graylog2: [[http://www.graylog2.org/]]

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "graylog2_exceptions"
+    gem.summary = 'Graylog2 exception notifier'
+    gem.description = 'A Rack middleware that sends every Exception as GELF message to your Graylog2 server'
+    gem.email = "lennart@socketfeed.com"
+    gem.homepage = "http://www.graylog2.org/"
+    gem.authors = "Lennart Koopmann"
+    gem.add_dependency "gelf", "= 1.1.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.rcov_opts << '--exclude gem'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: gem install rcov"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.3.0

data/graylog2_exceptions.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{friendlyfashion-graylog2_exceptions}
+  s.version = "1.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors       = ["Laurynas Butkus", "Tomas Didziokas", "Justas Janauskas", "Edvinas Bartkus"]
+  s.email         = ["laurynas.butkus@gmail.com", "tomas.did@gmail.com", "jjanauskas@gmail.com", "edvinas.bartkus@gmail.com"]
+  s.date          = %q{2012-08-21}
+  s.description   = %q{A Rack middleware that sends every Exception as GELF message to your Graylog2 server}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "README",
+    "Rakefile",
+    "VERSION",
+    "graylog2_exceptions.gemspec",
+    "lib/graylog2_exceptions.rb",
+    "test/helper.rb",
+    "test/test_graylog2_exceptions.rb"
+  ]
+  s.homepage = %q{http://www.graylog2.org/}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Graylog2 exception notifier}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_graylog2_exceptions.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<gelf>, ["~> 1.3"])
+    else
+      s.add_dependency(%q<gelf>, ["~> 1.3"])
+    end
+  else
+    s.add_dependency(%q<gelf>, ["~> 1.3"])
+  end
+end

data/lib/graylog2_exceptions.rb

@@ -0,0 +1,89 @@
+require 'rubygems'
+require 'gelf'
+require 'socket'
+
+class Graylog2Exceptions
+  attr_reader :args
+
+  def initialize(app, args = {})
+    standard_args = {
+      :hostname => "localhost",
+      :port => 12201,
+      :local_app_name => Socket::gethostname,
+      :facility => 'graylog2_exceptions',
+      :max_chunk_size => 'LAN',
+      :level => 3,
+      :host => nil,
+      :short_message => nil,
+      :full_message => nil,
+      :file => nil,
+      :line => nil
+    }
+
+    @args = standard_args.merge(args).reject {|k, v| v.nil? }
+    @extra_args = @args.reject {|k, v| standard_args.has_key?(k) }
+    @app = app
+  end
+
+  def call(env)
+    # Make thread safe
+    dup._call(env)
+  end
+
+  def _call(env)
+    begin
+      # Call the app we are monitoring
+      response = @app.call(env)
+    rescue => err
+      # An exception has been raised. Send to Graylog2!
+      send_to_graylog2(err, env)
+
+      # Raise the exception again to pass back to app.
+      raise
+    end
+
+    if env['rack.exception']
+      send_to_graylog2(env['rack.exception'], env)
+    end
+
+    response
+  end
+
+  def send_to_graylog2(err, env=nil)
+    begin
+      notifier = GELF::Notifier.new(@args[:hostname], @args[:port], @args[:max_chunk_size])
+      notifier.collect_file_and_line = false
+      
+      opts = {
+          :short_message => err.message,
+          :facility => @args[:facility],
+          :level => @args[:level],
+          :host => @args[:local_app_name]
+      }
+
+      if err.backtrace && err.backtrace.size > 0
+        opts[:full_message] = "Backtrace:\n" + err.backtrace.join("\n")
+        opts[:file] = err.backtrace[0].split(":")[0]
+        opts[:line] = err.backtrace[0].split(":")[1]
+      end
+
+      if env and env.size > 0
+        opts[:full_message] ||= ""
+        opts[:full_message] << "\n\nEnvironment:\n"
+
+        env.each do |k, v|
+          begin
+            opts[:full_message] << "#{k}: #{v}\n"
+            #opts[:full_message] << "#{k}: #{v.inspect}\n"
+          rescue
+          end
+        end
+      end
+      
+      notifier.notify!(opts.merge(@extra_args))
+    rescue Exception => i_err
+      puts "Graylog2 Exception logger. Could not send message: " + i_err.message
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require 'zlib'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'graylog2_exceptions.rb'

data/test/test_graylog2_exceptions.rb

@@ -0,0 +1,172 @@
+require 'helper'
+require 'logger'
+
+class TestGraylog2Exceptions < Test::Unit::TestCase
+
+  # Exceptions raised in the app should be thrown back
+  # to the app after handling. Simulating this by giving
+  # a nil app and expecting the caused exceptions.
+  def test_should_rethrow_exception
+    c = Graylog2Exceptions.new(nil, {})
+    assert_raise NoMethodError do
+      c.call nil
+    end
+  end
+
+  def test_correct_parameters_when_custom_set
+    c = Graylog2Exceptions.new(nil, {:host => "localhost", :port => 1337, :max_chunk_size => 'WAN', :local_app_name => "yomama", :level => 1})
+    
+    assert_equal "yomama", c.args[:local_app_name]
+    assert_equal "localhost", c.args[:hostname]
+    assert_equal 1337, c.args[:port]
+    assert_equal 'WAN', c.args[:max_chunk_size]
+    assert_equal 1, c.args[:level]
+  end
+  
+  def test_add_custom_attributes_to_parameters
+    c = Graylog2Exceptions.new(nil, {:_app => "my_awesome_app", :_rails_env => "staging"})
+    
+		assert_equal "my_awesome_app", c.args[:_app]
+		assert_equal "staging", c.args[:_rails_env]
+  end
+
+  def test_custom_attributes_dont_override_standard
+    ex = build_exception
+    c = Graylog2Exceptions.new(nil, {:line => 9999})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert 9999 != json["line"]
+  end
+
+  def test_correct_parameters_when_not_custom_set
+    c = Graylog2Exceptions.new(nil, {})
+    
+    assert_equal Socket.gethostname, c.args[:local_app_name]
+    assert_equal "localhost", c.args[:hostname]
+    assert_equal 12201, c.args[:port]
+    assert_equal 'LAN', c.args[:max_chunk_size]
+    assert_equal 3, c.args[:level]
+  end
+
+  def test_send_exception_to_graylog2_without_custom_parameters
+    ex = build_exception
+    c = Graylog2Exceptions.new(nil, {})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert json["short_message"].include?('undefined method `klopfer!')
+    assert json["full_message"].include?('in `build_exception')
+    assert_equal 'graylog2_exceptions', json["facility"]
+    assert_equal 4, json["level"]
+    assert_equal Socket.gethostname, json["host"]
+    assert_equal ex.backtrace[0].split(":")[1], json["line"]
+    assert_equal ex.backtrace[0].split(":")[0], json["file"]
+  end
+  
+  def test_send_exception_to_graylog2_with_custom_parameters
+    ex = build_exception
+
+    c = Graylog2Exceptions.new(nil, {:local_app_name => "machinexx", :level => 4, :facility => 'myfacility'})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert json["short_message"].include?('undefined method `klopfer!')
+    assert json["full_message"].include?('in `build_exception')
+    assert_equal 'myfacility', json["facility"]
+    assert_equal 3, json["level"]
+    assert_equal "machinexx", json["host"]
+    assert_equal ex.backtrace[0].split(":")[1], json["line"]
+    assert_equal ex.backtrace[0].split(":")[0], json["file"]
+  end
+
+  def test_send_exception_to_graylog2_with_custom_attributes
+    ex = build_exception
+
+    c = Graylog2Exceptions.new(nil, {
+			:local_app_name => "machinexx", :level => 4, :facility => 'myfacility',
+			:_app => "my_awesome_app", :_rails_env => "staging"
+		})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert json["short_message"].include?('undefined method `klopfer!')
+    assert json["full_message"].include?('in `build_exception')
+    assert_equal 'myfacility', json["facility"]
+    assert_equal 3, json["level"]
+    assert_equal "machinexx", json["host"]
+    assert_equal ex.backtrace[0].split(":")[1], json["line"]
+    assert_equal ex.backtrace[0].split(":")[0], json["file"]
+    assert_equal 'my_awesome_app', json["_app"]
+    assert_equal 'staging', json["_rails_env"]
+  end
+
+  def test_send_backtraceless_exception_to_graylog2
+    ex = Exception.new("bad")
+    c = Graylog2Exceptions.new(nil, {})
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+
+    assert json["short_message"].include?('bad')
+    assert json["full_message"].nil?
+  end
+
+  def test_send_rack_environment_to_graylog2
+    ex = build_exception
+    c = Graylog2Exceptions.new(nil, {})
+
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex).join)
+    json = JSON.parse(sent)
+    assert json.keys.none? {|k| k =~/^_env_/ }
+
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex, {}).join)
+    json = JSON.parse(sent)
+    assert json.keys.none? {|k| k =~/^_env_/ }
+
+    bad = Object.new
+    def bad.inspect; raise "bad"; end
+    data = {
+        "nil" => nil,
+        "str" => "bar",
+        "int" => 123,
+        "arr" => ["a", 2],
+        "hash" => {"a" => 1},
+        "obj" => Object.new,
+        "bad" => bad
+    }
+    
+    sent = Zlib::Inflate.inflate(c.send_to_graylog2(ex, data).join)
+    json = JSON.parse(sent)
+    assert_equal('nil', json["_env_nil"])
+    assert_equal('"bar"', json["_env_str"])
+    assert_equal('123', json["_env_int"])
+    assert_equal('["a", 2]', json["_env_arr"])
+    assert_equal('{"a"=>1}', json["_env_hash"])
+    assert_match(/#<Object:.*>/, json["_env_obj"])
+    assert ! json.has_key?("_env_bad")
+  end
+
+  def test_invalid_port_detection
+    ex = build_exception
+
+    c = Graylog2Exceptions.new(nil, {:port => 0})
+
+    # send_to_graylog2 returns nil when nothing was sent
+    # the test is fine when the message is just not sent
+    # and there are no exceptions. the method informs
+    # the user via puts
+    assert_nil c.send_to_graylog2(ex)
+  end
+
+  private
+
+  # Returns a self-caused exception we can send.
+  def build_exception
+    begin
+      klopfer!
+    rescue => e
+      return e
+    end
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: friendlyfashion-graylog2_exceptions
+version: !ruby/object:Gem::Version
+  version: 1.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Laurynas Butkus
+- Tomas Didziokas
+- Justas Janauskas
+- Edvinas Bartkus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gelf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A Rack middleware that sends every Exception as GELF message to your
+  Graylog2 server
+email:
+- laurynas.butkus@gmail.com
+- tomas.did@gmail.com
+- jjanauskas@gmail.com
+- edvinas.bartkus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- README
+- Rakefile
+- VERSION
+- graylog2_exceptions.gemspec
+- lib/graylog2_exceptions.rb
+- test/helper.rb
+- test/test_graylog2_exceptions.rb
+homepage: http://www.graylog2.org/
+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.24
+signing_key: 
+specification_version: 3
+summary: Graylog2 exception notifier
+test_files:
+- test/helper.rb
+- test/test_graylog2_exceptions.rb
+has_rdoc: