Browse files

added graphic to readme. moved to markdown for readme

  • Loading branch information...
1 parent 493be07 commit 3a9a10ae596f8e1dc1d09e853aad0bb17775047a @jamster committed Mar 23, 2011
Showing with 18 additions and 12 deletions.
  1. +18 −12 README.rdoc → README.mdown
@@ -1,19 +1,25 @@
-= resque-statsd
+# resque-statsd
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)
Tests on the way, but being used in production already
-== Usage
+## Final Outcome
+![Graph of a Job]( "Report Running Job Stats")
+## Usage
-=== Install
+### Install
gem install resque-statsd
gem install jamster-statsd # really jnunemaker's version of the statsd rubygem
-=== Rails Setup
+### Rails Setup
in an initializer, set up the Statsd
@@ -25,29 +31,29 @@ in file add code
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
+## Background Reading
-=== Graphite
+### Graphite
-=== StatsD Comes From Etsy
+### StatsD Comes From Etsy
The folks at Etsy (kastner) have come up with a neat node.js app to listen for Graphite stats.
-=== Ruby StatsD Client
+### Ruby StatsD Client
I've required a particular version (jnunemaker's) of the ruby StatsD client
Read the post here
* A Ruby statsd client (
-== Contributing to resque-statsd
+## Contributing to resque-statsd
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -57,7 +63,7 @@ Read the post here
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-== Copyright
+## Copyright
Copyright (c) 2011 Jason Amster. See LICENSE.txt for
further details.

0 comments on commit 3a9a10a

Please sign in to comment.