echo_cli 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3caffa4269d6b3440c9032d0a4deaf6dcbcc619a
-  data.tar.gz: 48c9406f82b0f735be5cc1877b9c32c986bd526c
+  metadata.gz: 6765580be1168de3d0f48cb50be74e722e5c1b4e
+  data.tar.gz: 02910ebe7b7f6c34fc0102b1ce5d539c6479d8b9
 SHA512:
-  metadata.gz: 5ec161fb721dfad4b9305c61152afd205b2e2924cbc526fa44ffd05bf5bdca8ca51e83c692016f5e4186c15ad9cdcb0da797c701e171c07f1d61c4bab1708501
-  data.tar.gz: 8cef349cb8c52551e30e48ddae261412b9b26b56822d9179d4d2b948f0c4ca50ba99af2943172b252e53fab1235ac55e85fa5fa76154f9b797c2b8cd1072fb71
+  metadata.gz: f493862592be4db91dd6d140dfb0fe10b655bfb331afe1918a6de9ccba6981c26e550a7ec261defd86a0f2db0f581ed82afcbddb89810ef6cb1d2906a03697e3
+  data.tar.gz: 8b38330c4661bba0f71c21c0223f721c49403d56fad567eb2c417dab319d6d1fa3814bb78ebff11cd2b26970b767e4d896c0844d05173a5c9f247c46f46a30ea

data/README.md

@@ -6,23 +6,45 @@ TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Ensure git and rbenv (or rvm) are installed on your machine:
 
-```ruby
-gem 'echo_cli'
+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
 ```
 
-And then execute:
+See more about rbenv here: https://github.com/rbenv/rbenv
 
-    $ bundle
+Install 'echo_cli':
 
-Or install it yourself as:
+```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
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+View available echo_cli commands and their short descriptions:
+
+```bash
+echo_cli
+```
+
+View a command's long description and an example of its use:
+
+```bash
+echo_cli help [COMMAND]
+```
+
+
 
 ## Development
 

data/lib/echo_cli/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'json'
 require 'colorize'
 require 'net/http'
 require 'net/https'
@@ -48,18 +49,18 @@ module Echo_cli
           end
 
           if options[:q]
-            sleep 10 # ensure data reception and replication
+            sleep 15 # ensure data reception and replication
           end
           time_end = Time.new.to_i.to_s
 
-          puts "\n\tSuccessfully posted ".green + request_body.yellow + " to ".green + ip.blue + " " + num.to_s.green + " time(s)".green + "\n\tTime start: ".green + time_start.yellow + ", Time end: ".green + time_end.yellow
+          puts "\nSuccessfully posted ".green + request_body.yellow + " to ".green + ip.blue + " " + num.to_s.green + " time(s)".green + "\nTime start: ".green + time_start.yellow + ", Time end: ".green + time_end.yellow
 
           if options[:q]
             query(ip, request_body[0..request_body.index(":")-1], time_start, time_end)
           end
 
         rescue
-          puts "\n\tFailed to post ".red + request_body.yellow + " to ".red + ip.blue + " " + num.to_s.red + " time(s)".red
+          puts "\nFailed to post ".red + request_body.yellow + " to ".red + ip.blue + " " + num.to_s.red + " time(s)".red
         end
 
       else
@@ -69,20 +70,20 @@ module Echo_cli
           res = https.request(req)
 
           if options[:q]
-            sleep 10 # ensure data reception and replication
+            sleep 15 # ensure data reception and replication
           end
 
           time_end = Time.new.to_i.to_s
 
           if res.code == '200'
-            puts "\n\tSuccessfully posted ".green + request_body.yellow + " to ".green + ip.blue + "\n\tTime start: ".green + time_start.yellow + ", Time end: ".green + time_end.yellow
+            puts "\nSuccessfully posted ".green + request_body.yellow + " to ".green + ip.blue + "\nTime start: ".green + time_start.yellow + ", Time end: ".green + time_end.yellow
 
             if options[:q]
               query(ip, request_body[0..request_body.index(":")-1], time_start, time_end)
             end
           end
         rescue
-          puts "\n\tFailed to post ".red + request_body.yellow + " to ".red + ip.blue
+          puts "\nFailed to post ".red + request_body.yellow + " to ".red + ip.blue
         end
       end
       return res.code
@@ -165,23 +166,23 @@ module Echo_cli
         begin
           res = https.request(req)
           if res.code == '200'
-            puts "\n\tSuccessfully retrieved ".green + metric.yellow + " from ".green + ip.blue + " in timestamp range: ".green + time_start.yellow + " to ".green + time_end.yellow + "\n\tStatus Code: ".green + res.code.yellow + "\n\tResponse Body: ".green + res.body.green
+            puts "\nSuccessfully retrieved ".green + metric.yellow + " from ".green + ip.blue + " in timestamp range: ".green + time_start.yellow + " to ".green + time_end.yellow + "\nStatus Code: ".green + res.code.yellow + "\nResponse Body: ".green + JSON.pretty_generate(JSON.parse(res.body)).green
           else
-            puts "\n\tFailed to retrieve ".red + metric.yellow + " from ".red + ip.blue + " in timestamp range: ".red + time_start.yellow + " to ".red + time_end.yellow + "\n\tStatus Code: ".red + res.code.yellow + "\n\tResponse Body: ".red + res.body.red
+            puts "\nFailed to retrieve ".red + metric.yellow + " from ".red + ip.blue + " in timestamp range: ".red + time_start.yellow + " to ".red + time_end.yellow + "\nStatus Code: ".red + res.code.yellow + "\nResponse Body: ".red + JSON.pretty_generate(JSON.parse(res.body)).red
           end
         rescue
-          puts "\n\tYour request returned an error. Are you sure your query was correct?"
+          puts "\nYour request returned an error. Are you sure your query was correct?"
         end
       else
         begin
           res = https.request(req)
           if res.code == '200'
-            puts "\n\tSuccessfully retrieved ".green + metric.yellow + " from ".green + ip.blue + " in timestamp range: ".green + time_start.yellow + " to ".green + time_end.yellow
+            puts "\nSuccessfully retrieved ".green + metric.yellow + " from ".green + ip.blue + " in timestamp range: ".green + time_start.yellow + " to ".green + time_end.yellow
           else
-            puts "\n\tFailed to retrieve ".red + metric.yellow + " from ".red + ip.blue + " in timestamp range: ".red + time_start.yellow + " to ".red + time_end.yellow
+            puts "\nFailed to retrieve ".red + metric.yellow + " from ".red + ip.blue + " in timestamp range: ".red + time_start.yellow + " to ".red + time_end.yellow
           end
         rescue
-          puts "\n\tYour request returned an error. Are you sure your query was correct?"
+          puts "\nYour request returned an error. Are you sure your query was correct?"
         end
       end
 
@@ -190,5 +191,97 @@ module Echo_cli
 
       return res.code
     end
+
+    desc "quick_query", "Query metrics on Echo for a given time range beginning at the current time. Use \"echo_cli quick_query <IP> '<metric>' <range>\""
+
+    long_desc <<-LONGDESC
+      `echo_cli quick_query` will query a metric directly from Echo's OpenTSDB server instance for a given time range beginning in the present.
+
+      Ensure single-quotes surround the metric.
+
+      Unlike the echo_cli post command, quick_query does not require the data value nor the data type (e.g. remove ':1|c' from 'example.post:1|c' and your query will still work).
+
+      The <range> parameter is defined in seconds, and is used to query the metric from the current time.
+
+      > $ echo_cli quick_query localhost 'example' 30
+
+      The previous example would find all data points with metric name 'example' on Echo's OpenTSDB instance at 'localhost' in the last 30 seconds.
+    LONGDESC
+
+    def quick_query(ip, metric, range)
+      metric = metric.gsub(/'/,"")
+      if metric.include? ":"
+        metric = metric[0..metric.index(":")-1]
+      end
+
+      opentsdb_uri = "http://" + ip + ":4242/api/query"
+
+      tags=""
+
+      if metric.include? "."
+        tags = metric[metric.index(".")+1..-1] + "."
+        metric = metric[0..metric.index(".")-1]
+
+        toReturn = ""
+        count = 1
+        while tags.include?(".") do
+          toReturn = toReturn + "\"tag" + count.to_s + "\": \"" + tags[0..tags.index(".")-1] + "\""
+          count = count + 1
+          tags = tags[tags.index(".")+1..-1]
+          if tags.include?(".")
+            toReturn = toReturn + ",\n"
+          end
+        end
+
+        tags = toReturn
+      end
+
+      time_end = Time.new.to_i
+      time_start = time_end - range.to_i
+
+      time_start = time_start.to_s
+      time_end = time_end.to_s
+
+      opentsdb_query =
+      "{
+        \"start\": " + time_start + ",
+        \"end\": " + time_end + ",
+        \"queries\": [
+          {
+          \"aggregator\": \"sum\",
+          \"metric\": \"" + metric + "\",
+          \"tags\": {" + tags +
+            "}
+          }
+        ]
+      }"
+
+      ENV["http_proxy"] = ENV["HTTP_PROXY"]
+      ENV["https_proxy"] = ENV["HTTPS_PROXY"]
+
+      uri = URI.parse(opentsdb_uri)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = false
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE if https.use_ssl?
+      req = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' => 'text/plain'}, )
+      req.body = opentsdb_query
+
+      begin
+        res = https.request(req)
+        if res.code == '200'
+          puts "\nSuccessfully retrieved ".green + metric.yellow + " from ".green + ip.blue + " in timestamp range: ".green + time_start.yellow + " to ".green + time_end.yellow + "\nData points in the last ".green + range.yellow + " seconds:\n".green +  JSON.pretty_generate(JSON.parse(res.body)).green
+        else
+          puts "\nFailed to retrieve ".red + metric.yellow + " from ".red + ip.blue + " in timestamp range: ".red + time_start.yellow + " to ".red + time_end.yellow + "\nStatus Code: ".red + res.code.yellow + "\nResponse Body: ".red + JSON.pretty_generate(JSON.parse(res.body)).red
+        end
+      rescue
+        puts "\nYour request returned an error. Are you sure your query was correct?"
+      end
+
+      ENV["http_proxy"] = ""
+      ENV["https_proxy"] = ""
+
+      return res.code
+
+    end
   end
 end

data/lib/echo_cli/version.rb

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

metadata

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