Permalink
Browse files

Made the example script have a more sensible name

  • Loading branch information...
Philip (flip) Kromer
Philip (flip) Kromer committed Mar 2, 2010
1 parent 5206b14 commit 91613bae16977e9fa4a5b860b1551794ad1c0c16
Showing with 37 additions and 19 deletions.
  1. +0 −17 README.rdoc
  2. +35 −0 README.textile
  3. +1 −1 bin/{example-client.rb → loadavg_graphite_sender.rb}
  4. +1 −1 lib/graphiterb/graphite_sender.rb
View
@@ -1,17 +0,0 @@
-= graphiterb
-
-Description goes here.
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
- future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
- (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Philip (flip) Kromer (@mrflip). See LICENSE for details.
View
@@ -0,0 +1,35 @@
+= graphiterb
+
+Fast, Ubiquitous dashboard logging with Graphite.
+
+<pre>
+ # in initialize, perhaps
+ self.sender = Graphiterb::GraphiteSender
+
+ # ... somewhere else ...
+ sender.send( ['webserver.pages', pages_this_hour], ['webserver.errors', errors_this_hour] )
+</pre>
+
+... and also see the examples, like bin/loadavg_graphite_sender.rb
+
+Uses:
+* "Graphite":http://graphite.wikidot.com
+
+Depends on:
+* "Configliere":http://github.com/mrflip/configliere
+
+h2. Other
+
+h3. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+ future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h3. Copyright
+
+Copyright (c) 2010 Infochimps (@infochimps). See LICENSE for details.
@@ -8,7 +8,7 @@
Settings.resolve!
Log = Logger.new($stderr) unless defined?(Log)
-class LoadavgGraphiteSender < GraphiteRb::GraphiteSender
+class LoadavgGraphiteSender < Graphiterb::GraphiteSender
def loadavgs
File.open('/proc/loadavg').read.strip.split[0..2]
end
@@ -1,4 +1,4 @@
-module GraphiteRb
+module Graphiterb
#
# @example:
# # in initialize, perhaps

0 comments on commit 91613ba

Please sign in to comment.