pingdom-to-graphite 0.0.4 → 0.0.5

data/README.md

@@ -6,42 +6,56 @@ place to prevent abuse. This tool tries to be mindful of that, although does
 provide a "backfill" option if you care to burn up your daily api limit in one
 fell swoop.
 
+## Installation
+
+pingdom-to-graphite is available as a gem package:
+
+    % gem install pingdom-to-graphite
+    % pingdom-to-graphite
+
+Or, you could grab the source and call the executable directly:
+
+    % git clone git://github.com/lewg/pingdom-to-graphite.git
+    % cd pingdom-to-graphite
+    % bundle install
+    % bin/pingdom-to-graphite
+
 ## Usage
 
 The utility itself will provide detailed help for all the commands if you just
 invoke it by itself:
 
-    pingdom-to-graphite
+    % pingdom-to-graphite
 
 ### For the Impatient
 
 Ok, so you don't like reading command line help. Here's how to get up and
 running quickly:
 
-    pingdom-to-graphite init
+    % pingdom-to-graphite init
 
 Will place a sample config file into the default location `~/.p2g/config.json`.
 Don't worry scripters, this location can be overriden with the `-c` switch. Drop
 your pingdom credentials and graphite settings into there to enable the script
 to do any actual work.
 
-    pingdom-to-graphite init_checks
+    % pingdom-to-graphite init_checks
 
 This will pre-fill the pingdom->checks setting in your config file with a list
 of all your available check ids. Since you're curious:
 
-    pingdom-to-graphite list
+    % pingdom-to-graphite list
 
 Will list them all, as well as their current status. Ok, back to business:
 
-    pingdom-to-graphite update
+    % pingdom-to-graphite update
 
 Will pull the 100 most recent checks for each check specified in your config
 file and create a  `~/.p2g/state.json` file storing a few key timestamps about
 what data you've successfully send to graphite. Similar to the config file, this
 location can be overridden with the `-s` switch.
 
-    pingdom-to-graphite update
+    % pingdom-to-graphite update
 
 *"Hey, that's the same command!"* you say. Indeed it is, and will run through your
 checks picking up where we left of from the last update. If you stopped to check
@@ -53,7 +67,7 @@ limiting factor is that updating each metric is a separate API call, so the more
 checks you want to pipe to graphite the less frequently you'll be able to run
 the script. Want some numbers?
 
-    pingdom-to-graphite advice
+    % pingdom-to-graphite advice
 
 Will give you the rough API numbers you'd consume a day given your number of
 monitored checks in five minute increments until it finds something that works.
@@ -64,7 +78,7 @@ necessarily the best approach! Speaking of the API, how about some more historic
 data because, you know, charts and stuff! Got that covered, but you're going to have
 to pick the specific check you'd like some more data for.
 
-    pingdom-to-graphite backfull CHECK_ID
+    % pingdom-to-graphite backfill CHECK_ID
 
 Will use up a number of your existing API calls to get historical data for that specific
 check. How many? Well, it will ask, and you can tell it. You can also specify with the 

data/lib/pingdom-to-graphite/version.rb

@@ -1,3 +1,3 @@
 module PingdomToGraphite
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/pingdom-to-graphite.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = PingdomToGraphite::VERSION
   s.authors     = ["Lew Goettner"]
   s.email       = ["lew@goettner.net"]
-  s.homepage    = "http://lewg.github.com/pingdom-to-graphite"
+  s.homepage    = "https://github.com/lewg/pingdom-to-graphite"
   s.summary     = %q{A command line tool for pulling stats from pingdom and shipping them to graphite.}
   s.description = %q{A tool for copying metrics from Pingdom to graphite. Pingdom, although 
     allowing access to effectively all your metrics through the API, does have some limits 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pingdom-to-graphite
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -117,7 +117,7 @@ files:
 - lib/pingdom-to-graphite/data-push.rb
 - lib/pingdom-to-graphite/version.rb
 - pingdom-to-graphite.gemspec
-homepage: http://lewg.github.com/pingdom-to-graphite
+homepage: https://github.com/lewg/pingdom-to-graphite
 licenses: []
 post_install_message: 
 rdoc_options: []