error_log 0.0.1 → 0.0.2

data/README.txt

@@ -3,11 +3,69 @@ error_log
 
 == DESCRIPTION:
 
-Easy way to track exceptions and warning in your rails app
+Easy way to track exceptions and warnings in your rails app
 
 It's still just a skeleton.
 More description and documentation will come.. one day.. I guess.
 
+THIS IS DEVELOPMENT VERSION, DO NOT EVEN TOUCH PRODUCTION SERVER WITH IT.
+Actually, it is so unmature that even playing with it can make you sad.
+And no one likes to be sad.
+
+dev screenshot: http://tesuji.pl/error_logs.png
+
+== REQUIREMENTS
+
+I hope it to work with rails 2.x and 3, currently I'm testing it only on rails 3.
+
+== INSTALATION AND USAGE
+
+Just put
+
+  gem 'error_log'
+
+in your Gemfile. By default it will use your database to store error logs.
+Automagically table error_logs is going to be created, and all unhandled
+controller exceptions will end up there by default (displaying your 500 page
+as normal).
+
+Generate yourself some empty controller (say error_logs) and put this line 
+inside:
+
+  error_logs
+
+You can use it now to browse exceptions. It is your responsibility to make this
+controller secure and unaccessible by others.
+
+There's also one global method catch_error that you can use to.. catch errors.
+
+  catch_error do
+     # some stuff that may cause problems
+  end
+
+or
+  
+  catch_error('page parsing', :level => :fatal) do
+    raise "tangled cables"
+  end
+
+To be continued.
+
+== TODOS
+
+* setting error level threshold while browsing
+* nicer browsing (themes would be good, but I really do not like css so help needed)
+* adding errors to ignore list
+* alternative errors storage (for database failures, maybe just some sqlite?)
+* clickable backtraces? we could show some code
+* rails 2.x compatibility
+* marking single errors as read, browsing archive
+* bugfixes, lots of
+
+== STUFF
+
+Ideas, opinions and contributions are extrememly welcome.
+
 == LICENSE:
 
 (The MIT License)

data/lib/error_log/controller.rb

@@ -1,16 +1,29 @@
 
-#TODO :would be nice to check first if ApplicationController is defined and if not use ActionController::Base
 module ErrorLog
-   class Controller < ActionController::Base
+   module Controller# < ActionController::Base
 
-      prepend_view_path File.join(ErrorLog.path,'views')
+      def index
 
-      # FIXME: this layout declaration should not be needed here for default layout
-      # however without it, it does not load default layout for some reason
-      layout 'application'
+         # Rails 2.x compatible finder
+         scope = ErrorLog::Model
+
+         unless params[:errors_category].to_s.empty?
+            @errors_category = params[:errors_category]
+            scope = scope.where(:category => @errors_category)
+         end
+         
+         @error_logs = scope.all(
+            :order => 'created_at DESC', 
+            :conditions => {
+               :viewed => false
+            }
+         ).group_by(&:error_hash)
+
+         @category_counts = ErrorLog::Model.count(
+            :conditions => {:viewed => false},
+            :group => :category 
+         )
 
-      def index
-         @error_logs = ErrorLog::Model.all(:order => 'created_at DESC', :conditions => {:viewed => false}).group_by(&:hash)
          render :template => '/index'
       end
 
@@ -18,6 +31,27 @@ module ErrorLog
          ErrorLog::Model.update_all(:viewed => true)
          redirect_to :back
       end
+
    end
 end
 
+class ActionController::Base
+
+   rescue_from Exception, :with => :error_log_rescue
+
+   def self.error_logs
+      append_view_path File.join(ErrorLog.path,'views')
+      self.send(:include,ErrorLog::Controller) 
+   end
+
+   def error_log_rescue(e)
+      err = ErrorLog::Model.new(
+        :error => e.to_str,
+        :backtrace => e.backtrace,
+        :category => 'rails'
+      )
+      err.save
+      raise e 
+   end
+
+end

data/lib/error_log/core_ext.rb

@@ -1,4 +1,7 @@
 class Object
+   
+
+   # Handy way to catch exceptions 
    def catch_error(category='catch_error', options={})
       raise "no block given!" unless block_given?
       begin
@@ -8,9 +11,10 @@ class Object
          ErrorLog::Model.create(
            :error => e.to_str,
            :backtrace => e.backtrace,
+           :level => (options[:level] || :error),
            :category => category
          )
       end
-
    end
+
 end

data/lib/error_log/model.rb

@@ -9,7 +9,8 @@ module ErrorLog
                t.text :error
                t.text :backtrace
                t.string :category
-               t.string :hash
+               # note to future me: "hash" is a really bad name for the column
+               t.string :error_hash
                t.integer :level_id
                t.timestamp :created_at
                t.boolean :viewed, :default => false
@@ -22,14 +23,35 @@ module ErrorLog
          Migration.up
       end
 
+      LEVELS = {
+         :debug => 0,
+         :info  => 1,
+         :warn  => 2,
+         :warning  => 2,
+         :error => 3,
+         :fatal => 4,
+         :wtf   => 5
+      }
+
+      def level
+         LEVELS.invert[self.level_id]
+      end
+
+      def level=(name)
+         self.level_id = LEVELS[name]
+      end
+
       before_save do |obj|
+         obj.level ||= :error
+
          if obj.backtrace.kind_of? Array
             obj.backtrace = obj.backtrace.join("\n")
          end
 
-         obj.hash = Digest::MD5.hexdigest(obj.backtrace.to_s + obj.error.to_s + obj.category.to_s)
+         obj.error_hash = Digest::MD5.hexdigest(obj.backtrace.to_s + obj.error.to_s + obj.category.to_s)
 
          true
       end
+
    end
 end

data/lib/error_log/version.rb

@@ -1,3 +1,3 @@
 module ErrorLog
-   VERSION = "0.0.1" unless defined?(::ErrorLog::VERSION)
+   VERSION = "0.0.2" unless defined?(::ErrorLog::VERSION)
 end

data/lib/error_log.rb

@@ -62,7 +62,6 @@ module ErrorLog
 end  # module ErrorLog
 
 
-# Hook into rails
-ActiveSupport.on_load(:after_initialize) do
+ActiveSupport.on_load(:before_initialize) do
    ErrorLog.require_all_libs_relative_to(__FILE__)
 end

data/views/index.html.erb

@@ -0,0 +1,119 @@
+
+<%# I'm sorry but view ain't beautiful quite yet. It will probably be totally rewritten %>
+
+<style type="text/css">
+   #error_logs tr.odd {
+      background-color: #fefefe;
+   }
+
+   #error_logs tr.even {
+      background-color: #f5f5f5;
+   }
+
+   table#error_logs {
+      border: 1px solid #333;
+      width: 100%;
+      border-collapse: collapse;
+   }
+
+   table#error_logs td {
+      border: 1px solid #999;
+      padding: 10px;
+      font-family: Verdana;
+   }
+
+   table#error_logs .level_error {
+      background-color: #ffa;
+   }
+
+   table#error_logs .level_fatal {
+      background-color: #f99;
+   }
+
+   table#error_logs .level_warn {
+      background-color: #9c9;
+   }
+   
+   table#error_logs .level_box {
+      border: 1px solid #333;
+      padding: 10px;
+      font-weight: bold;
+      float: right;
+      margin: 20px;
+   }
+
+   table#error_logs .backtrace {
+      overflow: auto;
+      font-family: Monospace;
+      font-size: 0.9em;
+      color: #999;
+   }
+
+   table#error_logs .time {
+      font-size: 0.7em;
+      font-style: italic;
+   }
+
+
+</style>
+
+<h1>Error logs</h1>
+
+<div align="right">
+   <%= button_to "Mark all as read", :action => 'set_all_viewed' %>
+</div>
+<br />
+
+<!-- Hell I love table layouts -->
+<table style="width: 100%" cellpadding="10">
+   <tr><td valign="top">
+     <ul>
+           <li>
+             <%= link_to_if @errors_category, 'all', :action => :index %> (<%= @category_counts.values.sum %>)
+           </li>
+        <% @category_counts.each_pair do |category,count| %>
+           <li>
+             <%= link_to_if (@errors_category != category), category, :action => :index, :errors_category => category %>&nbsp;(<%= count %>)
+           </li>
+        <% end %>
+     </ul>
+   </td><td>
+
+<table id="error_logs">
+   <% @error_logs.each_pair do |hash,logs| %>
+      <% error_log = logs.first %>
+      <tr class="<%= cycle('odd','even') %>">
+         <td>
+            <div class="level_box level_<%= error_log.level %>">
+               <%= error_log.level %>
+            </div>
+
+            <span class="time"><%= error_log.created_at %></span>
+            <br />
+            [<%= error_log.category %>]
+            <b><%= error_log.error %></b> 
+            <br />
+
+            <% if logs.count > 1 %>
+               <div style="text-align: center">
+                  Repeated <b><span style="font-size: <%= [12 + logs.count,100].min %>px;"><%= logs.count %></span></b> times.<br />
+               </div>
+            <% end %>
+            
+            <br />
+            <% bt = error_log.backtrace.split("\n") %>
+            <div class="backtrace">
+                  <%= bt[0...3].join("\n") %>                  
+                  <% bid = "error_log_bt_#{error_log.id}" %>
+                  <%= link_to_function '...', "$('#{bid}').show();" %>
+                  <span style="display: none" id="<%= bid %>">
+                     <%= bt[4...-1].join("\n") %>                  
+                  </span>
+            </div>
+         </tr>
+      </tr>
+   <% end %>
+</table>
+
+</td></tr>
+</table>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: error_log
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kacper Ciesla
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2010-08-07 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,12 +29,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- bin/error_log
 - lib/error_log.rb
 - lib/error_log/version.rb
 - lib/error_log/model.rb
 - lib/error_log/controller.rb
 - lib/error_log/core_ext.rb
+- views/index.html.erb
 - README.txt
 has_rdoc: true
 homepage: 

data/bin/error_log

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib error_log]))
-
-# Put your code here
-