whoops 0.0.5 → 0.1.0

data/README.asciidoc

@@ -3,37 +3,81 @@ Whoops
 Daniel Higginbotham <daniel@flyingmachinestudios.com>
 2011-07-09
 
-== Overview
+== What is Whoops?
 
-=== Purpose
+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 was originally conceived as an alternative to Hoptoad. Its allows you to:
+== Whoops Server
 
-* *Log arbitrary events.* Whoops events use an event_type field which can be any string - exception, notification, warning, etc.
-* *Log arbitrary details.* Events are stored in http://www.mongodb.org[mongodb], giving you the flexibility of a document database.
-* *Search event details.* The search parser maps text to mongoid conditions, allowing you to do queries like +details.current_user_id#in [123, 423]+
-* *Extend the app.* Since it's a rails engine, you can make changes to your base rails app without worrying about merge difficulties when you upgrade whoops.
+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:
 
-If you find yourself bumping up against limitations in Hoptoad, whoops might be right for you.
+=== Log Arbitrary Events
 
-=== Design
+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.
 
-whoops consists of two main components: the rails 3 engine and the notifier. Hosting is up to you. The engine provides the following:
+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".
 
-* Controllers and views for viewing, filtering, and searching events.
-* An end point for receiving event notifications
-* A mailer for sending email notifications
-* http://www.mongoid.org[Mongoid] models
+Note that you can add users and/or login to the base rails app if you really want to. 
 
-The notifier is documented separately. Briefly, it allows you to create strategies for building an event notification. It also allows you to modify existing strategies.
+=== Notifications
 
-For example, you could use the https://github.com/flyingmachine/whoops_rails_notifier[rails 3 notifier] , but modify it to include the ID of the currently logged in user. If your app ran background processes, you could create a notification strategy specific to your processes. Both strategies can coexist in the same app.
+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.
 
-=== Terms / Models
+=== You Manage the Rails App
 
-* _Event_ A specific occurrence of an event. The Event model stores details specific to an event.
-* _Event Group_ All Events are associated with an Event Group. Event Groups store details common to all events in the group.
-* _Notification_ The whoops notifier sends Notifications to whoops. A notification contains both Event and Event Group information; whoops sorts it out when it receives a Notification.
+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
 
@@ -42,9 +86,10 @@ For example, you could use the https://github.com/flyingmachine/whoops_rails_not
 . 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_notifier[notifiers] to the code you want to monitor
+. add https://github.com/flyingmachine/whoops_logger[loggers] to the code you want to monitor
 
 === Filtering
 
@@ -55,45 +100,17 @@ When viewing the Event Group list, you can filter by service, environment, and e
 
 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.
 
-=== Searching
-
-.Search
-image::https://github.com/flyingmachine/whoops/raw/master/doc/images/details-search.png[Search]
-
-For now, you need to enter your queries into the textarea shown above. Currently, searches only apply to the events within the current event group.
-
-.Search Syntax
-----
-key[#method] query
-----
-
-* *key* the Event field to search.
-* *method* _(optional)_ a http://mongoid.org/docs/querying/criteria.html#where[Mongoid] where criteria method
-* *query* a YAML string
-
-.Examples
-
-Below is the 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.
-
-This syntax is kind of goofy, but it lets you enter constant numbers, strings, arrays, hashes, and regular expressions, just like you could if you were typing in the code directly.
-
 == TODO
 
-* finish notifications
+* finish email notification of events
 * site-wide search
 * graphing
+* logger documentation
+
+== Alternatives
+
+* http://airbrakeapp.com/pages/home[Airbrake (the app formerly known as Hoptoad)]
+* https://papertrailapp.com/[papertrail]
 
 == License
 

data/app/controllers/event_groups_controller.rb

@@ -4,7 +4,13 @@ class EventGroupsController < ApplicationController
   helper_method :event_group_filter
   
   def index
-    @event_groups = Whoops::EventGroup.where(event_group_filter.to_query_document).desc(:last_recorded_at).paginate(
+    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)
+    end
+    
+    @event_groups = finder.desc(:last_recorded_at).paginate(
       :page => params[:page],
       :per_page => 20
     )

data/app/controllers/events_controller.rb

@@ -6,7 +6,7 @@ class EventsController < ApplicationController
     
     events_base = @event_group.events
     unless params[:query].blank?
-      conditions = Whoops::SearchParser.new(params[:query]).mongoid_conditions
+      conditions = Whoops::MongoidSearchParser.new(params[:query]).conditions
       events_base = events_base.where(conditions)
     end
     

data/app/helpers/events_helper.rb

@@ -1,9 +1,9 @@
 module EventsHelper
   def format_detail(detail)
     case detail
-    when String, Numeric: detail
-    when Array: simple_format(detail.join("\n"), :class => "simple")
-    when Hash: detail_table(detail)
+    when String, Numeric then detail
+    when Array           then simple_format(detail.join("\n"), :class => "simple")
+    when Hash            then detail_table(detail)
     else
       detail.to_s
     end

data/app/models/whoops/event.rb

@@ -5,10 +5,13 @@ class Whoops::Event
   belongs_to :event_group, :class_name => "Whoops::EventGroup"
   
   field :details
+  field :keywords, :type => String
   field :message, :type => String
   field :event_time, :type => DateTime
+    
+  validates_presence_of :message  
   
-  validates_presence_of :message
+  before_save :set_keywords
   
   def self.record(params)
     params = params.with_indifferent_access
@@ -30,8 +33,32 @@ class Whoops::Event
   end 
   
   def self.search(query)
-    conditions = Whoops::SearchParser.new(query).mongoid_conditions
+    conditions = Whoops::MongoidSearchParser.new(query).conditions
     where(conditions)
   end
   
+  def set_keywords
+    keywords_array = []
+    keywords_array << self.message
+    add_details_to_keywords(keywords_array)
+    self.keywords = keywords_array.join(" ")
+  end
+    
+  private
+  
+  def add_details_to_keywords(keywords_array)
+    flattened = details.to_a.flatten
+    flattened -= details.keys if details.respond_to?(:keys)
+    
+    until flattened.empty?
+      non_hash = flattened.select{ |i| !i.is_a?(Hash) }
+      keywords_array.replace(keywords_array | non_hash)
+      flattened -= non_hash
+      
+      flattened.collect! do |i|
+        i.to_a.flatten - i.keys
+      end.flatten!
+    end
+    
+  end
 end

data/app/models/whoops/event_group.rb

@@ -3,7 +3,7 @@ class Whoops::EventGroup
   include Mongoid::Document
   include FieldNames
   
-  [:service, :environment, :event_type, :message, :identifier].each do |string_field|
+  [:service, :environment, :event_type, :message, :identifier, :logging_strategy_name].each do |string_field|
     field string_field, :type => String
   end
   field :last_recorded_at, :type => DateTime

data/app/models/whoops/{search_parser.rb → mongoid_search_parser.rb}

@@ -1,10 +1,12 @@
-class Whoops::SearchParser
+# Parses text to create corresponding mongoid conditions.
+# See README for details on syntax.
+class Whoops::MongoidSearchParser
   attr_accessor :query
   def initialize(query)
     self.query = query
   end
   
-  def mongoid_conditions
+  def conditions
     self.query.split("\n").inject({}) do |conditions, line|
       line.strip!
       next(conditions) if line.empty?

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

@@ -7,6 +7,12 @@
           %li= f.select field_name, options_from_collection_for_select(options, :first, :last, event_group_filter.send(field_name))
         %li
           %button#reset reset
+  .space
+    %h3 Search
+    - form_tag whoops_event_groups_path, :method => "get" do |f|
+      %ul.search
+        %li= text_field_tag :query
+        %li= submit_tag "Submit"
 %article.module.width_full
   %header
     %h3 Events

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whoops
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 5
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Daniel Higginbotham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-09 00:00:00 -04:00
+date: 2011-07-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,24 +104,10 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: mongoid
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -133,11 +119,11 @@ dependencies:
         - 1
         version: 2.0.1
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: will_paginate
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -149,11 +135,11 @@ dependencies:
         - pre2
         version: 3.0.pre2
   type: :runtime
-  version_requirements: *id009
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rspec-rails
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -163,11 +149,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id010
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -177,11 +163,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id011
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: fabrication
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -191,11 +177,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id012
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: ruby-debug
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -205,11 +191,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id013
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: faker
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -219,11 +205,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id014
+  version_requirements: *id013
 - !ruby/object:Gem::Dependency 
   name: capybara
   prerelease: false
-  requirement: &id015 !ruby/object:Gem::Requirement 
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -235,7 +221,7 @@ dependencies:
         - 0
         version: 0.4.0
   type: :development
-  version_requirements: *id015
+  version_requirements: *id014
 description: A logger
 email: 
 executables: []
@@ -255,8 +241,8 @@ files:
 - app/models/whoops/event.rb
 - app/models/whoops/event_group.rb
 - app/models/whoops/filter.rb
+- app/models/whoops/mongoid_search_parser.rb
 - app/models/whoops/notification_rule.rb
-- app/models/whoops/search_parser.rb
 - app/views/event_groups/_list.html.haml
 - app/views/event_groups/index.html.haml
 - app/views/events/_detail.html.haml