error_stalker 0.0.12 → 0.0.13

data/Gemfile

@@ -7,10 +7,11 @@ group :server do
   gem 'sinatra', '~>1.1.2'
   gem 'vegas', '~>0.1.8'
   gem 'thin', '~>1.2.7'
+  gem 'will_paginate','~>3.0'
 end
 
 group :mongoid_store do
-  gem 'mongoid', '2.0.0.beta.20'
+  gem 'mongoid', '~>2.2.0'
 end
 
 group :test do

data/README.rdoc

@@ -1,3 +1,106 @@
-= Exception Logger
+= ErrorStalker
 
-As the name says, this library allows you to log exceptions to an arbitrary backend.
+ErrorStalker is an extensible exception monitor for Ruby apps. 
+
+== Getting Started
+
+After installing the gem, you should require it:
+
+  require 'error_stalker'
+
+Afterwards, reporting exceptions is simple: 
+
+  ErrorStalker::Client.report(application_name, exception, extra_data)
+
+This will report an exception to ErrorStalker.
+
+In Rails, you should be able to put this code in your
+ApplicationController to report all exceptions:
+
+  rescue_from Exception do |exception|
+    ErrorStalker::Client.report(application_name, exception)
+    raise exception
+  end
+
+== The ErrorStalker Server
+
+ErrorStalker has decent defaults for running in development -- when
+you call ErrorStalker::Client.report, it logs the exception to a
+logfile. If you're inside a Rails app, it will log to
+log/exceptions.log, otherwise it will put the logfile in
+/tmp/exceptions.log. 
+
+This is probably not what you want in production, so ErrorStalker
+supports different backends, and comes stock with an ErrorStalker
+Sinatra server that can persist, aggregate, and show the exceptions
+your app is raising. Switching backends can be done like this:
+
+  require 'error_stalker/backend/server'
+  ErrorStalker::Client.backend = ErrorStalker::Backend::Server.new(:host => "localhost", :port => 8080)
+
+From that point on, all exceptions will be posted to the ErrorStalker server running on localhost:8080.
+
+That server is a standard Sinatra app, but you still need to run
+it. You can do that by pointing your favorite rack-enabled server at a
+config.ru that looks like this:
+
+  require 'error_stalker/server'
+  
+  ErrorStalker::Server.configuration = {
+    ... # server config goes here
+  }
+  
+  run ErrorStalker::Server
+
+== Data Stores
+
+The server takes two main bits of configuration. The most important is
+the data store. Currently, the server supports an in-memory data store
+(which will go away when the server does) and a persistent mongodb store (using
+mongoid). You can configure these with a hash before you start the server:
+
+  ErrorStalker::Server.configuration = {
+    'store' => {
+      'class' => 'ErrorStalker::Store::Mongoid',
+      'parameters' => '/path/to/mongoid.yml'
+    }
+  }
+
+Each data store should call out the parameters it supports in its
+documentation.
+
+== Plugins
+
+The ErrorStalker server also supports a simple plugin
+architecture. Currently, it supports a simple lighthouse reporter and
+an automatic email sender. Documentation for these plugins is in the
+Rdoc for the specific classes. They are configured the same way as the
+data store:
+
+  ErrorStalker::Server.configuration = {
+    'store' => {
+      'class' => 'ErrorStalker::Store::Mongoid',
+      'parameters' => '/path/to/mongoid.yml'
+    },
+    'plugin' => [
+      {
+        'class' => 'ErrorStalker::Plugin::EmailSender',
+        'parameters' => {
+          'to' => 'to_address@example.com',
+          'from' => 'from_address@example.com'
+        }
+      },
+      ...
+    ]
+  }
+
+== Extending ExceptionStalker
+
+Feel free to write your own backends, stores, or plugins as you need
+them. As long as you follow the documentation in the ::Base classes,
+your code should fit right in. Let me know what you come up with!
+
+== License
+
+Regardless of what any other file may say about it, this code is
+licensed under the MIT license.

data/lib/error_stalker/exception_report.rb

@@ -7,8 +7,8 @@ require 'digest/md5'
 # class, but they should be able to be treated as instances of this
 # class regardless.
 class ErrorStalker::ExceptionReport
-  
-  # The name of the application that caused this exception. 
+
+  # The name of the application that caused this exception.
   attr_reader :application
 
   # The name of the machine that raised this exception.
@@ -23,9 +23,6 @@ class ErrorStalker::ExceptionReport
   # The exception object (or string message) this report represents
   attr_reader :exception
 
-  # A hash of extra data logged along with this exception.
-  attr_reader :data
-
   # The backtrace corresponding to this exception. Should be an array
   # of strings, each referring to a single stack frame.
   attr_reader :backtrace
@@ -46,15 +43,15 @@ class ErrorStalker::ExceptionReport
     @machine = params[:machine] || machine_name
     @timestamp = params[:timestamp] || Time.now
     @type = params[:type] || params[:exception].class.name
-    
+
     if params[:exception].is_a?(Exception)
       @exception = params[:exception].to_s
     else
       @exception = params[:exception]
     end
-    
+
     @data = params[:data]
-    
+
     if params[:backtrace]
       @backtrace = params[:backtrace]
     else
@@ -78,6 +75,17 @@ class ErrorStalker::ExceptionReport
     @digest ||= Digest::MD5.hexdigest((backtrace ? backtrace.to_s[0,STACK_DIGEST_LENGTH] : exception.to_s) + type.to_s)
   end
 
+  # A hash of extra data logged along with this exception.
+  def data
+    @data_with_fixed_encoding ||= JSON.parse(raw_data.to_json.encode('utf-8', 'ascii-8bit', :invalid => :replace, :undef => :replace))
+  end
+
+  # The extra data associated with this object, without fixing any
+  # broken encodings.
+  def raw_data
+    @data
+  end
+
   # Serialize this object to json, so we can send it over the wire.
   def to_json
     {
@@ -86,7 +94,7 @@ class ErrorStalker::ExceptionReport
       :timestamp => timestamp,
       :type => type,
       :exception => exception,
-      :data => data,
+      :data => raw_data,
       :backtrace => backtrace
     }.to_json
   end

data/lib/error_stalker/server/public/exception_logger.css

@@ -122,6 +122,10 @@ code {
   font-family: Inconsolata, Consolas, 'Lucida Console', monospace;
 }
 
+dl.group_details {
+  overflow: auto;
+}
+
 dl.group_details dt {
   clear: left;
   float: left;

data/lib/error_stalker/server/views/_exception_table.erb

@@ -1,4 +1,4 @@
-<%= will_paginate @rows, :params => params %>
+<%= will_paginate @rows %>
 <table id="exceptions" cellpadding="0">
   <tr>
     <th class="count">&nbsp;</th>

data/lib/error_stalker/server/views/search.erb

@@ -26,10 +26,10 @@
     <input id="type" type="text" name="type" value="<%= params[:type] %>" />
 
     <% if store.supports_extended_searches? %>
-      <label for="data">Extra data (key:"value")</label>
-      <input id="data" type="text" name="data" value="<%= params[:data] %>" />
+      <label for="data">Extra data</label>
+      <input id="data" type="text" name="data" value="<%= params[:data] %>" placeholder="REMOTE_ADDR:127.0.0.1 PATH:/test" />
     <% end %>
-    
+
     <input type="submit" name="Search" value="Search" />
   </form>
 </div>

data/lib/error_stalker/server/views/show.erb

@@ -7,7 +7,7 @@
   <dt>First occurred</dt><dd><%= h(@group.first_timestamp) %></dd>
   <dt>Most recently occurred</dt><dd><%= h(@group.most_recent_timestamp) %></dd>
   <dt>On machines</dt><dd><%= h(@group.machines.join(', ')) %></dd>
-  <dt>Exception class</dt><dd><%= h(@group.type) %></dd>
+  <dt>Exception class</dt><dd><%= h(@report.type) %></dd>
 </dl>
 <p><a href="/similar/<%= @report.digest%>.html">See all</a></p>
 <% plugins.each do |plugin| %>
@@ -28,5 +28,5 @@
 
 <% if @report.data && !@report.data.empty? %>
 <h3>Additional information</h3>
-<pre><code><%= h @report.data.to_yaml %></code></pre>
+<pre><code><%= h JSON.pretty_generate(@report.data) %></code></pre>
 <% end %>

data/lib/error_stalker/server.rb

@@ -6,8 +6,6 @@ require 'error_stalker/store'
 require 'error_stalker/plugin'
 require 'erb'
 require 'will_paginate'
-require 'will_paginate/view_helpers/base'
-require 'error_stalker/sinatra_link_renderer'
 require 'error_stalker/version'
 
 module ErrorStalker
@@ -24,21 +22,21 @@ module ErrorStalker
 
     # The data store (ErrorStalker::Store instance) to use to store
     # exception data
-    attr_accessor :store 
-    
+    attr_accessor :store
+
     # A list of plugins the server will use.
     attr_accessor :plugins
-    
+
     set :root, File.dirname(__FILE__)
     set :public, Proc.new { File.join(root, "server/public") }
     set :views, Proc.new { File.join(root, "server/views") }
 
+    register WillPaginate::Sinatra
+
     helpers do
       include Rack::Utils
       alias_method :h, :escape_html
 
-      include WillPaginate::ViewHelpers::Base
-
       # Generates a url from an array of strings representing the
       # parts of the path.
       def url(*path_parts)
@@ -62,7 +60,7 @@ module ErrorStalker
     class << self
       # A hash of configuration options, usually read from a
       # configuration file.
-      attr_accessor :configuration 
+      attr_accessor :configuration
     end
     self.configuration = {}
 
@@ -99,7 +97,7 @@ module ErrorStalker
       end
       self.store = self.class.store
     end
-    
+
     get '/' do
       @records = store.recent.paginate(:page => params[:page], :per_page => PER_PAGE)
       erb :index
@@ -109,7 +107,7 @@ module ErrorStalker
       @results = store.search(params).paginate(:page => params[:page], :per_page => PER_PAGE) if params["Search"]
       erb :search
     end
-    
+
     get '/similar/:digest.html' do
       @group = store.reports_in_group(params[:digest]).paginate(:page => params[:page], :per_page => PER_PAGE)
       if @group
@@ -118,7 +116,7 @@ module ErrorStalker
         404
       end
     end
-    
+
     get '/exceptions/:id.html' do
       @report = store.find(params[:id])
       if @report
@@ -128,7 +126,7 @@ module ErrorStalker
         404
       end
     end
-    
+
     get '/stats.json' do
       timestamp = Time.at(params[:timestamp].to_i) if params[:timestamp]
       # default to 1 hour ago
@@ -147,6 +145,6 @@ module ErrorStalker
       plugins.each {|p| p.after_create(self, report)}
       200
     end
-    
+
   end
 end

data/lib/error_stalker/store/mongoid.rb

@@ -1,13 +1,15 @@
 require 'mongoid'
 require 'error_stalker/store/base'
+require 'error_stalker/will_paginate/mongoid'
+require 'will_paginate/array'
 
 # Store exceptions using MongoDB. This store provides fast storage and
 # querying of exceptions, and long-term persistence. It also allows
 # querying based on arbitrary data stored in the +data+ hash of the
 # exception report, which allows for crazy things like searching
-# reports by URL or IP address. 
+# reports by URL or IP address.
 class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
-  
+
   # Configure mongoid from the mongoid config file found in
   # +config_file+. This mongoid config file should be similar to the
   # one on http://mongoid.org/docs/installation/, and must be indexed
@@ -69,7 +71,7 @@ class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
   def reports_in_group(digest)
     ExceptionReport.where(:digest => digest).order_by(:timestamp.desc)
   end
-  
+
   # returns the ExceptionGroup object corresponding to a particular
   # digest
   def group(digest)
@@ -80,11 +82,11 @@ class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
   def supports_extended_searches?
     true
   end
-  
+
   def total
     ExceptionReport.count()
   end
-  
+
   def total_since(timestamp)
     ExceptionReport.where(:timestamp.gte => timestamp).count()
   end
@@ -98,23 +100,24 @@ class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
 
     [:application, :machine].each do |param|
       if params[param] && !params[param].empty?
-        scope.where(param => params[param])
+        puts "HERE: #{params.inspect}"
+        scope = scope.where(param => params[param])
       end
     end
 
     [:exception, :type].each do |param|
       if params[param] && !params[param].empty?
-        scope.where(param => /#{params[param]}/)
+        scope = scope.where(param => /#{params[param]}/)
       end
     end
 
     if params[:data] && !params[:data].empty?
       params[:data].split.each do |keyvalue|
         key, value = keyvalue.split(':')
-        scope.where("data" => {"#{key}" => "#{value}"})
+        scope = scope.where("data" => {"#{key}" => "#{value}"})
       end
     end
-    
+
     scope.order_by(:timestamp.desc)
   end
 
@@ -130,7 +133,7 @@ class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
   # should eventually be more robust, like the Rails version, but for
   # now this should be fine.
   def migrate_data
-    if SchemaMigrations.where(:version => 1).empty?
+    if SchemaMigrations.where(:version => "1").empty?
       ExceptionGroup.all.order_by(:timestamp).desc.each do |group|
         exceptions = ExceptionReport.where(:digest => group.digest).order_by(:timestamp)
         unless exceptions.empty?
@@ -142,7 +145,7 @@ class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
           group.save
         end
       end
-      SchemaMigrations.create(:version => 1)
+      SchemaMigrations.create(:version => "1")
     end
   end
 
@@ -173,12 +176,12 @@ class ErrorStalker::Store::Mongoid < ErrorStalker::Store::Base
       {:name => report.machine},
       {:name => report.machine},
       :upsert => true)
-    
+
     Application.collection.update(
       {:name => report.application},
       {:name => report.application},
       :upsert => true)
-    
+
     report.id
   end
 end
@@ -239,6 +242,8 @@ class ErrorStalker::Store::Mongoid::ExceptionGroup < ErrorStalker::ExceptionGrou
     # associated exception reports.
     def paginate(pagination_opts = {})
       recent = @criteria.paginate(pagination_opts)
+      total_entries = recent.total_entries
+
       exceptions = ErrorStalker::Store::Mongoid::ExceptionReport.where(:_id.in => recent.map(&:most_recent_report_id))
       # Fake association preloading
       id_map = {}.tap do |h|
@@ -246,12 +251,20 @@ class ErrorStalker::Store::Mongoid::ExceptionGroup < ErrorStalker::ExceptionGrou
           h[ex.id] = ex
         end
       end
-      
+
+      # Because all the +recent+ stuff is still a scope at this point,
+      # we somehow lose the most_recent_report information that we try
+      # to assign below the next time we iterate over the
+      # scope. Forcing the scope to turn into an array solves that
+      # problem, although it means we have to 'fake-paginate' the
+      # array before we return it.
+      recent = recent.to_a
+
       recent.each do |r|
         r.most_recent_report = id_map[r.most_recent_report_id]
       end
-      
-      recent
+
+      recent.paginate(:per_page => pagination_opts[:per_page], :total_entries => total_entries)
     end
   end
 end
@@ -284,16 +297,16 @@ class ErrorStalker::Store::Mongoid::ExceptionReport
     [:id, :application, :machine, :timestamp, :type, :exception, :digest, :backtrace].each do |field|
       params[field] = send(field)
     end
-    
+
     if data
       params[:data] = {}.tap do |h|
         data.map { |hash| h[hash.keys.first] = hash[hash.keys.first] }
       end
     end
-    
+
     ErrorStalker::ExceptionReport.new(params)
   end
-  
+
   # Create a new mongoid exception report from +exception_report+.
   def self.create_from_exception_report(exception_report)
     object = new do |o|
@@ -307,7 +320,7 @@ class ErrorStalker::Store::Mongoid::ExceptionReport
           exception_report.data.map {|key, value| array << {key => value}}
         end
       end
-      
+
       if exception_report.backtrace
         o.backtrace = exception_report.backtrace
       end

data/lib/error_stalker/version.rb

@@ -1,4 +1,4 @@
 module ErrorStalker
   # ErrorStalker's current version.
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/lib/error_stalker/will_paginate/mongoid.rb

@@ -0,0 +1,45 @@
+# Borrowed from
+# https://raw.github.com/dbackeus/will_paginate/master/lib/will_paginate/mongoid.rb
+# until it makes it into will_paginate
+require 'mongoid'
+require 'will_paginate/collection'
+
+module WillPaginate
+  module Mongoid
+    module CriteriaMethods
+      def paginate(options = {})
+        extend CollectionMethods
+        @current_page = WillPaginate::PageNumber(options[:page] || @current_page || 1)
+        @page_multiplier = current_page - 1
+        pp = (options[:per_page] || per_page || WillPaginate.per_page).to_i
+        limit(pp).skip(@page_multiplier * pp)
+      end
+
+      def per_page(value = :non_given)
+        value == :non_given ? options[:limit] : limit(value)
+      end
+
+      def page(page)
+        paginate(:page => page)
+      end
+    end
+
+    module CollectionMethods
+      attr_reader :current_page
+
+      def total_entries
+        @total_entries ||= count
+      end
+
+      def total_pages
+        (total_entries / per_page.to_f).ceil
+      end
+
+      def offset
+        @page_multiplier * per_page
+      end
+    end
+
+    ::Mongoid::Criteria.send(:include, CriteriaMethods)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_stalker
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000 -07:00
-default_executable: 
+date: 2011-12-23 00:00:00.000000000Z
 dependencies: []
 description: Logs exceptions to a pluggable backend. Also provides a server for centralized
   exception logging using a pluggable data store.
@@ -57,12 +56,12 @@ files:
 - lib/error_stalker/server/views/search.erb
 - lib/error_stalker/server/views/show.erb
 - lib/error_stalker/server/views/similar.erb
-- lib/error_stalker/sinatra_link_renderer.rb
 - lib/error_stalker/store.rb
 - lib/error_stalker/store/base.rb
 - lib/error_stalker/store/in_memory.rb
 - lib/error_stalker/store/mongoid.rb
 - lib/error_stalker/version.rb
+- lib/error_stalker/will_paginate/mongoid.rb
 - test/test_helper.rb
 - test/unit/backend/base_test.rb
 - test/unit/backend/in_memory_test.rb
@@ -72,7 +71,6 @@ files:
 - test/unit/plugins/email_sender_test.rb
 - test/unit/server_test.rb
 - test/unit/stores/in_memory_test.rb
-has_rdoc: true
 homepage: ''
 licenses: []
 post_install_message: 
@@ -93,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: error_stalker
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Logs exceptions to a pluggable backend and/or a pluggable store

data/lib/error_stalker/sinatra_link_renderer.rb

@@ -1,25 +0,0 @@
-require 'will_paginate/view_helpers/link_renderer'
-
-module ErrorStalker
-  # +will_paginate+ doesn't have built-in sinatra support, so this
-  # LinkRenderer subclass implements the +url+ method to work with
-  # sinatra-style request hashes.
-  class SinatraLinkRenderer < WillPaginate::ViewHelpers::LinkRenderer
-    protected
-
-    # Returns the URL for the given +page+
-    def url(page)
-      url = @template.request.url
-      params = @template.request.params.dup
-      if page == 1
-        params.delete("page")
-      else
-        params["page"] = page
-      end
-      
-      @template.request.path + "?" + params.map {|k, v| "#{Rack::Utils.escape(k)}=#{Rack::Utils.escape(v)}"}.join("&")
-    end
-  end
-end
-
-WillPaginate::ViewHelpers.pagination_options[:renderer] = ErrorStalker::SinatraLinkRenderer