echo_cli 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6765580be1168de3d0f48cb50be74e722e5c1b4e
-  data.tar.gz: 02910ebe7b7f6c34fc0102b1ce5d539c6479d8b9
+  metadata.gz: 095ca160f431f4387213366ef4666d663070ba0b
+  data.tar.gz: 5957c858d0157d75dfdb3f2ddb0f544b318c8c2e
 SHA512:
-  metadata.gz: f493862592be4db91dd6d140dfb0fe10b655bfb331afe1918a6de9ccba6981c26e550a7ec261defd86a0f2db0f581ed82afcbddb89810ef6cb1d2906a03697e3
-  data.tar.gz: 8b38330c4661bba0f71c21c0223f721c49403d56fad567eb2c417dab319d6d1fa3814bb78ebff11cd2b26970b767e4d896c0844d05173a5c9f247c46f46a30ea
+  metadata.gz: 2e58c1ce6e849abe3d81e3861de59408963141394f9d73540dcfef9814eec1b8bfd36a630f11cfdf6f0bbac01229da8cd243108a780eec8b953103539b41b440
+  data.tar.gz: cfb233798dd020ca0509a80c488b6d478e018d45ac1c2b0b96425b37932cacb354504c0a4c502703ad0f74cb58faaaf47ae241dc1e2673a9701878e4b9703c4d

data/README.md

@@ -1,9 +1,5 @@
 # Echo_cli
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/echo_cli`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Ensure git and rbenv (or rvm) are installed on your machine:
@@ -11,9 +7,9 @@ Ensure git and rbenv (or rvm) are installed on your machine:
 Install rbenv:
 
 ```bash
-git clone https://github.com/rbenv/rbenv.git ~/.rbenv
-echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile
-~/.rbenv/bin/rbenv init
+$ git clone https://github.com/rbenv/rbenv.git ~/.rbenv
+$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile
+$ ~/.rbenv/bin/rbenv init
 ```
 
 See more about rbenv here: https://github.com/rbenv/rbenv
@@ -21,13 +17,13 @@ See more about rbenv here: https://github.com/rbenv/rbenv
 Install 'echo_cli':
 
 ```bash
-gem install echo_cli
+$ gem install echo_cli
 ```
 
 Test the installation to ensure it is working properly (no errors should occur if the installation was successful):
 
 ```bash
-echo_cli
+$ echo_cli
 ```
 
 ## Usage
@@ -35,16 +31,60 @@ echo_cli
 View available echo_cli commands and their short descriptions:
 
 ```bash
-echo_cli
+$ echo_cli
 ```
 
 View a command's long description and an example of its use:
 
 ```bash
-echo_cli help [COMMAND]
+$ echo_cli help [COMMAND]
 ```
 
+### Commands
+
+#### post
+```bash
+$ echo_cli post <IP> '<metric>' {number} {-q}
+```
+Parameters:
+
+`<IP>`: (required) specifies the StatsD endpoint you are attempting to post a metric to
+
+`'<metric>'`: (required) the metric name, as well as any tags, and data value and data type to be posted to StatsD
+
+
+`{number}`: (optional) the number of posts to occur, e.g. a number value of '10' would post the metric 10 times to the StatsD server
+
+
+`{-q}`: (optional) does an automatic query of OpenTSDB immediately following the successful post of the metric to ensure the data transfer between StatsD and OpenTSDB. This option requires approx. 15 seconds to complete, as data flush and HA require ~15 seconds
+
+####query
+```bash
+$ echo_cli query <IP> '<metric>' <time_start> <time_end> {-v}
+```
+Parameters:
 
+`<IP>`: (required) specifies the OpenTSDB endpoint you are attempting to query
+
+`'<metric>'`: (required) the metric name, including any tags, with which the query for OpenTSDB will be constructed
+
+`<time_start>`: (required) the start of the range you are attempting to query in seconds from January 1, 1970 (epoch time)
+
+`<time_end>`: (required) the end of the range you are attempting to query in seconds from January 1, 1970 (epoch time)
+
+`{-v}`: (optional) verbosely prints the status code and response body of the query
+
+####quick_query
+```bash
+$ echo_cli quick_query <IP> '<metric>' <range>
+```
+Parameters:
+
+`<IP>`: (required) specifies the OpenTSDB endpoint you are attempting to query
+
+`'<metric>'`: (required) the metric name, including any tags, with which the query for OpenTSDB will be constructed
+
+`<range>`: (required) the time, in seconds from the current time (epoch time) that you would like to query, e.g. a 'range' value of 300 would query OpenTSDB for the specified metric in the last 5 minutes of time-series data
 
 ## Development
 
@@ -53,17 +93,23 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ```bash
-git add .
-git commit -m
-git push
+$ git add .
+$ git commit -m
+$ git push
 
-gem install gem-release
-gem bump minor/major
-rake build
-rake install
-rake release
+$ gem install gem-release
+$ gem bump minor/major
+$ rake build
+$ rake install
+$ rake release
 
-gem install echo_cli
+$ gem install echo_cli
+```
+
+#### Testing
+```bash
+$ gem install webmock
+$ ruby test/echo_cli_test.rb
 ```
 
 ## Contributing

data/lib/echo_cli/cli.rb

@@ -6,7 +6,7 @@ require 'net/https'
 
 module Echo_cli
   class Echo < Thor
-    desc "post", "Post metrics to Echo. Use \"echo_cli post <IP> '<metric>' {number} {-v}\""
+    desc "post", "Post metrics to Echo. Use \"echo_cli post <IP> '<metric>' {number} {-q}\""
 
     option :q
 

data/lib/echo_cli/version.rb

@@ -1,3 +1,3 @@
 module Echo_cli
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: echo_cli
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors:
 - Brandon Raphael