echo_cli 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 095ca160f431f4387213366ef4666d663070ba0b
-  data.tar.gz: 5957c858d0157d75dfdb3f2ddb0f544b318c8c2e
+  metadata.gz: 1e597bdd28e23fe7e16607780bb9ebe575f3379e
+  data.tar.gz: 78a3ac55ee5895b3837ce94d7b780a77f6509a91
 SHA512:
-  metadata.gz: 2e58c1ce6e849abe3d81e3861de59408963141394f9d73540dcfef9814eec1b8bfd36a630f11cfdf6f0bbac01229da8cd243108a780eec8b953103539b41b440
-  data.tar.gz: cfb233798dd020ca0509a80c488b6d478e018d45ac1c2b0b96425b37932cacb354504c0a4c502703ad0f74cb58faaaf47ae241dc1e2673a9701878e4b9703c4d
+  metadata.gz: 8d55971b389d14d8e91aee2485ceb05d7390b0ad724c3449ebc163c8f3d7befa1c83d3a0119b3cb465dac50ad339cc21bec7470edbdb937913aea57074ed6cca
+  data.tar.gz: c18037b41bdecd4b6e13f2cbe36fd43d2c9ae4da38c8cbe55d88aa72ed87c02df7aec2b9ac08b08a3aa6fc81419d31045b9dc5ef303fb7e31ebfbab4a5ca452d

data/README.md

@@ -42,6 +42,17 @@ $ echo_cli help [COMMAND]
 
 ### Commands
 
+#### help
+```bash
+$ echo_cli help [COMMAND]
+```
+Provides a longer description and sample use case of an echo_cli command.
+
+Example:
+```bash
+$ echo_cli help post
+```
+
 #### post
 ```bash
 $ echo_cli post <IP> '<metric>' {number} {-q}
@@ -58,7 +69,13 @@ Parameters:
 
 `{-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
+Example:
+```bash
+$ echo_cli localhost 'sample.post.here:1|c' 10 -q
+```
+The previous example would post the metric 'sample' with tags 'post' and 'here' with data value '1' and with data type 'c' (for count). This information would be posted to the instance of StatsD located at 'localhost', and it would be posted 10. Additionally, because of the '-q' specified option, OpenTSDB will be queried immediately after the post to StatsD has been verified.
+
+#### query
 ```bash
 $ echo_cli query <IP> '<metric>' <time_start> <time_end> {-v}
 ```
@@ -74,9 +91,15 @@ Parameters:
 
 `{-v}`: (optional) verbosely prints the status code and response body of the query
 
-####quick_query
+Example:
+```bash
+$ echo_cli localhost 'sample.query.here' 1492464745 1492465045 -v
+```
+The previous example will query OpenTSDB with the metric name 'sample' and tags 'query' and 'here' between the times of '1492464745' and '1492465045'. Additionally, the '-v' specified option will also return the response code and response body upon completion.
+
+#### quick_query
 ```bash
-$ echo_cli quick_query <IP> '<metric>' <range>
+$ echo_cli quick_query <IP> '<metric>' <range> {-h}
 ```
 Parameters:
 
@@ -86,6 +109,28 @@ Parameters:
 
 `<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
 
+`{-e}`: (optional) formats the response datapoints such that their timestamps are in the epoch format
+
+Example:
+```bash
+$ echo_cli localhost 'sample.query.here' 300
+```
+The previous example will query OpenTSDB located on 'localhost' with the metric name 'sample' and tags 'query' and 'here', within the time range spanning from the current time to '300' seconds before the current time.
+
+#### convert
+```bash
+$ echo_cli convert <timestamp>
+```
+Parameters:
+
+`<timestamp>`: (required) the timestamp you wish to convert, it can be given in either epoch time or a human-readable format. Ensure that the epoch timestamp is in seconds, and does not have any punctuation. Ensure that the human-readable timestamp is of the form: YYYY-MM-DDTHH:MM:SS-Z (decimals may follow the SS value).
+
+Example:
+```bash
+$ echo_cli convert 1492186214
+```
+The previous example will convert the provided epoch timestamp into a human-readable format.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/echo_cli/cli.rb

@@ -99,6 +99,8 @@ module Echo_cli
     long_desc <<-LONGDESC
       `echo_cli query` will query a metric directly from Echo's OpenTSDB server instance.
 
+      Timestamps are given in epoch time, in seconds.
+
       If timestamps are unknown, echo_cli's post command provides time_start and time_end values for future querying.
 
       Ensure single-quotes surround the metric.
@@ -192,7 +194,9 @@ 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>\""
+    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> {-e}\""
+
+    option :e
 
     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.
@@ -203,6 +207,8 @@ module Echo_cli
 
       The <range> parameter is defined in seconds, and is used to query the metric from the current time.
 
+      With -e (epoch) option, echo_cli will format the response datapoints such that their timestamps will be in epoch format.
+
       > $ 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.
@@ -269,7 +275,21 @@ module Echo_cli
       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
+
+          json = JSON.parse(res.body)
+
+          if !options[:e]
+            obj = {}
+            for i in json[0]["dps"].keys do
+              Helper.new.stfu do
+                obj[convert(i)] = JSON.parse(res.body)[0]["dps"][i]; nil
+              end
+            end
+
+            json[0]["dps"] = obj
+          end
+
+          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).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
@@ -281,7 +301,50 @@ module Echo_cli
       ENV["https_proxy"] = ""
 
       return res.code
+    end
+
+    desc "convert", "Convert epoch timestamps to a human-readable format (YYYY-MM-DDTHH:MM:SS-Z), or vice-versa. Use \"echo_cli convert <timestamp>\""
+
+    long_desc <<-LONGDESC
+      `echo_cli convert` will convert a given timestamp from epoch to a human-readable format, or vice-versa. Useful for determining locations of data on grafana. Ensure that an epoch timestamp has no punctation, and a human-readable timestamp follows the format 'YYYY-MM-DDTHH:MM:SS.SSS-Z' exactly.
 
+      Epoch timestamp example: 1492186214
+
+      Human-readable date/time timestamp example: 2011-10-18T21:01:52-07:00
+
+      > $ echo_cli convert 1492186214
+
+      > $ echo_cli convert 2011-10-18T21:01:52-07:00
+    LONGDESC
+
+    def convert(timestamp)
+      if timestamp.include? ":"
+        time = Time.iso8601(timestamp).to_i.to_s
+      else
+        time = Time.at(timestamp.to_i).to_datetime.to_s
+      end
+      puts "\nConverted timstamp: ".green + time.yellow
+      return time
+    end
+  end
+
+  class Helper
+    def stfu
+      begin
+        orig_stderr = $stderr.clone
+        orig_stdout = $stdout.clone
+        $stderr.reopen File.new('/dev/null', 'w')
+        $stdout.reopen File.new('/dev/null', 'w')
+        retval = yield
+      rescue Exception => e
+        $stdout.reopen orig_stdout
+        $stderr.reopen orig_stderr
+        raise e
+      ensure
+        $stdout.reopen orig_stdout
+        $stderr.reopen orig_stderr
+      end
+      retval
     end
   end
 end

data/lib/echo_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: echo_cli
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Brandon Raphael
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor