Permalink
Browse files

cleaned up readme

  • Loading branch information...
1 parent 0cf6673 commit 493be07e01187f8dd78d1ec2153a86a830a55a39 @jamster committed Mar 23, 2011
Showing with 4 additions and 6 deletions.
  1. +4 −6 README.rdoc
View
@@ -1,10 +1,10 @@
= resque-statsd
-Resque Statsd is a Resque plugin that will wrap the enqueueing, performing, failing, as well as timeing job run times withing Graphite monitoring.
+Resque Statsd is a Resque plugin that will collect and send data samples from your Resque Jobs. It samples 4 statistics for any Job for which the plugin extends, enqueue count, completion count, failure count, and the time to process. It will monitor for each specific job, in addition to the totals for all jobs (not including timing stats)
== CURRENT STATUS
-No tests but in production
+Tests on the way, but being used in production already
== Usage
@@ -22,11 +22,9 @@ in an initializer, set up the Statsd
in file add code
ENV['GRAPHITE_HOST'] = 'graphite.YOURHOST.com'
- ENV['APP_NAME'] = 'yourappname_resque' # I add the _resque to separate against web
- require 'resque-statsd'
+ ENV['APP_NAME'] = 'YOURAPPNAME_resque' # I add the _resque to separate against web stats
+ require 'resque-statsd' # Needs to come after the ENV variable setting
-
-
== Background Reading
=== Graphite

0 comments on commit 493be07

Please sign in to comment.