whoops 0.1.3 → 0.1.4

data/README.asciidoc

@@ -5,107 +5,12 @@ Daniel Higginbotham <daniel@flyingmachinestudios.com>
 
 == What is Whoops?
 
-Whoops is a logging system. It consists of a Rails engine (which records logs and provides an interface to them) and a logger. Both are described below, along with how they compare to Hoptoad. Note that the comparisons aren't meant to disparage Hoptoad - it's a great product. They're only meant to help describe Whoops and help people decide whether it would be useful to them.
-
-== Whoops Server
-
-The Whoops server is a Rails engine which records logs and provides an interface to filter, search, and view them. Below is a listing of its features and how it compares to Hoptoad:
-
-=== Log Arbitrary Events
-
-With Hoptoad, you only log exceptions. With Whoops, it's up to you to tell the Whoops server what you're logging, be it an exception, notification, warning, or whatever. Internally, Whoops EventGroups use the event_type field to store the event type. You can filter on this field when viewing a listing of all events.
-
-image::https://github.com/flyingmachine/whoops/raw/master/doc/images/dash-filters.png[Filters]
-
-=== Log Arbitrary Details
-
-With Hoptoad, the fields which you can log are pre-defined. They also reflect an assumption that your error happened within the context of handling an HTTP request. Whoops uses mongodb as its database and this allows you to log whatever details you want. For example, you could log the following:
-
-----
-{
-  :start_time => 1310748754,
-  :end_time   => 1310949834,
-  :users_imported => [
-    { :id => 413, :succeeded => false },
-    { :id => 835, :succeeded => true },
-    { :id => 894, :succeeded => true },
-    { :id => 124, :succeeded => true },
-  ],
-}
-----
-
-This gets stored as-is in Whoops. You can also search these details, as explained below:
-
-=== Search Event Details
-
-As far I know, you can't search Hoptoad. Whoops let's you search all Events within an EventGroup. Eventually, keyword search over all events will be implemented.
-
-Below is example text you would write, and below that is essentially the ruby code that ends up getting run by the server.
-
-----
-details.current_user_id#in [3, 54, 532]      <1>
-details.num_failures#gt 3                    <2>
-details.current_user.first_name Voldemort    <3>
-message#in !r/(yesterday|today)/             <4>
-----
-
-<1> `Event.where( {:"details.current_user_id".in => [3, 54, 532]} )`
-<2> `Event.where( {:"details.num_failure".gt => 3} )`
-<3> `Event.where( {:"details.current_user.first_name" => "Voldemort"} )`
-<4> `Event.where( {:message.in /(yesterday|today/)} )` Note that regular expressions must start with !r.
-  
-The general format is +key[#mongoid_method] query+ . As you can see, +query+ can be a string, number, regex, or array of these values. Hashes are allowed too. If you're not familiar with querying mongo, you can http://www.mongodb.org/display/DOCS/Querying[read more in the mongodb docs]. The http://mongoid.org/docs/querying/criteria.html#where[Mongoid] docs are useful as well.
-
-=== Extend the App
-
-Since Whoops is a Rails engine, you can make changes to your base rails app without worrying about merge difficulties when you upgrade Whoops.
-
-=== No Users or Projects
-
-In Hoptoad, errors are assigned to projects, and access to projects is given to users. In Whoops, there are no users, so it's not necessary to manage access rights or even to log in. Additionally, there is no Project model within the code or database. Instead, each EventGroup has a +service+ field which you can filter on. Services can be namespaced, so that if you have the services "godzilla.web" and "godzilla.background", you can set a filter to show events related to either service or to their common name, "godzilla".
-
-Note that you can add users and/or login to the base rails app if you really want to. 
-
-=== Notifications
-
-Since Whoops doesn't have users, email notification of events is handled by entering an email address along with a newline-separated list of services to receive notifications for. This isn't 100% implemented yet.
-
-=== You Manage the Rails App
-
-If you use Whoops you'll have to manage the Rails app yourself. You'll have to set up mongodb and all that. Heroku has a http://addons.heroku.com/mongolab[great mongodb addon] that gives you 240mb of space for free. Hoptoad doesn't require you to host or manage anything.
-
-== Demos
-
-* http://whoops-example.heroku.com[Example of the Whoops Rails engine]
-* http://whoops-rails-notifier-example.heroku.com/[Example site which sends logs to whoops]
-
-== Usage
-
-=== Installation
-
-. create a new rails app
-. add +gem "whoops"+ to your Gemfile
-. run +bundle+
-. add http://mongoid.org/docs/installation/configuration.html[+config/mongoid.yml+]
-. run +bundle exec rails g whoops:assets+ - this copies assets to your public directory (whoops isn't 3.1 compatible yet)
-. _optional_ add `root :to => "event_groups#index"` to your routes file to make the event group listing your home page
-. add https://github.com/flyingmachine/whoops_logger[loggers] to the code you want to monitor
-
-=== Filtering
-
-.Filters
-image::https://github.com/flyingmachine/whoops/raw/master/doc/images/dash-filters.png[Filters]
-
-When viewing the Event Group list, you can filter by service, environment, and event type.
-
-When you set a filter, its value is stored in a session and won't be changed until you click "reset". This is so that you won't lose your filter after, for example, viewing a specific event.
+Whoops is a logging system. It consists of a Rails engine (which records logs and provides an interface to them) and a logger. Full documentation can be found at http://www.whoopsapp.com[the Whoops web site].
 
 == TODO
 
 * finish email notification of events
-* site-wide search
 * graphing
-* logger documentation
 
 == Alternatives
 

data/app/controllers/event_groups_controller.rb

@@ -7,7 +7,7 @@ class EventGroupsController < ApplicationController
     finder = if params[:query].blank?
       Whoops::EventGroup.where(event_group_filter.to_query_document)
     else
-      Whoops::EventGroup.where(:_id.in => Whoops::Event.where(:keywords => /#{params[:query]}/).collect{|e| e.event_group_id}.uniq)
+      Whoops::EventGroup.where(:_id.in => Whoops::Event.where(:keywords => /#{params[:query]}/i).collect{|e| e.event_group_id}.uniq)
     end
     
     @event_groups = finder.desc(:last_recorded_at).paginate(

data/app/views/event_groups/_list.html.haml

@@ -11,7 +11,7 @@
   - @event_groups.each do |event_group|
     %tr
       %td= event_group_scoped_link(event_group, :service)
-      %td= link_to event_group.message, whoops_event_group_events_path(event_group)
+      %td= link_to event_group.message.truncate(50), whoops_event_group_events_path(event_group)
       %td= event_group_scoped_link(event_group, :event_type)
       %td= event_group_scoped_link(event_group, :environment)
       %td= event_group.last_recorded_at.to_s(:whoops_default)

data/app/views/events/index.html.haml

@@ -38,5 +38,4 @@
     - if @events.empty?
       %p Your search returned no results.
     - else 
-      = render :partial => "events/details", :object => @events.first, :as => :event
-
+      = render :partial => "events/details", :object => @events.first, :as => :event

data/lib/generators/whoops/templates/assets/stylesheets/sass/screen.scss

@@ -971,4 +971,8 @@ font-size: 14px;}
   a {
     text-decoration:underline;
   }
+}
+
+#event-details {
+  overflow-x:auto;
 }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whoops
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Daniel Higginbotham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-23 00:00:00 -04:00
+date: 2011-07-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency