echo_cli 0.6.20 → 0.6.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5f609e5d770299aa3c77843c4f22d1a8ce5243
-  data.tar.gz: 0128cf4cddd4dc07ecb9a6e1cad5f89c1df46c9e
+  metadata.gz: 455a70f05530bd541185638a1c07ed7005bba915
+  data.tar.gz: d298d2bd257fd85935a71c0e9a123a1efde0c34f
 SHA512:
-  metadata.gz: 1056a5fa9b7197db6a646d37892f8f2086fac67b49124d33c5c0a6ec20dbb2aaf9cf040178f5d51617a622e1f0a977278dfce2e2f84e8f9c908582650f840a89
-  data.tar.gz: c0016a5bef2ee41db51406ea3a12cbf70fcbc0f5de5435ccd0642ecab0f42b875614a69af093d5cd080a19ab4ecb4f6d740b36d8296547b2d2ba095e1582c3d6
+  metadata.gz: aee1848d8b950130cbd33ecc95bf2d9a4134551f481b50cef43105003d6906fe63c05be04b18559826c5dfcc30a84aad51b48410d7f3c46942c6ff76351be519
+  data.tar.gz: fd88e47ba8f795825c6cd69854d1fdf54b0fc4531500b02e4e1b3004098583ea52c040bae12f621a560e4c3526e578f7979efdaaff4d042fbc43b166b4989bcf

data/README.md

@@ -2,7 +2,29 @@
 
 ## Installation
 
-Ensure git and rbenv (or rvm) are installed on your machine:
+Ensure git and rbenv (or rvm, NOT both) are installed on your machine:
+
+Verify the 'rbenv' and 'git' commands are found
+```bash
+$ git
+```
+
+```bash
+$ rbenv
+```
+
+If you are missing git:
+
+Install git:
+
+```bash
+$ brew update
+$ brew install git
+```
+
+See more about git here: https://www.atlassian.com/git/tutorials/install-git
+
+If you are missing rbenv:
 
 Install rbenv:
 
@@ -17,7 +39,7 @@ See more about rbenv here: https://github.com/rbenv/rbenv
 Install 'echo_cli':
 
 ```bash
-$ gem install echo_cli
+$ sudo gem install echo_cli
 ```
 
 Test the installation to ensure it is working properly (no errors should occur if the installation was successful):
@@ -26,6 +48,30 @@ Test the installation to ensure it is working properly (no errors should occur i
 $ echo_cli
 ```
 
+## Metrics Explained
+
+### Posting data to Echo
+The Echo server receives data in text format with the following syntax:
+
+```
+<Application_name>.<tag1>.<tag2>…<tag(n)>:<value>|<metric type>
+```
+
+### Application name
+This is the name of the application that you are sending the data from.  It is what you are measuring.  It must be a text string.  
+
+### Tag1 – tag(n)
+The database works off of tags to identify metrics.  What ever tags you use will be what identifies your measurement in the database and in the front end.  We recommend that you use two to three tags for each measurement type.
+
+### Value
+This is a numeric value that is representative of the metric being tracked.  It must be a number in text format.
+
+### Metric type
+A special flag that tells the Echo server what type of data you are recording.  The server will perform different calculations depending on this value.  There are three types of flags that are currently supported by Echo:
+* **c**: (Count) – Tells the Echo server that the values represent a count.  
+* **ms**: (Time Duration) – Tells the server that values represent a duration of time.  The number is recorded in milliseconds and is to be transmitted as a number, not a time stamp. Note: in practice, ms does not have to represent time.  It can represent any number.  The system does not care, it only records.
+* **g**: (Gauge) – Represents a Gauge function.  When a number is received, the server will continue to record that number every 10 seconds until a new number is received. Note: The gauge auto repost function has been turned off in the sandbox environment.  This is to reduce the amount of noise in the data as people test and configure different measurements.
+
 ## Usage
 
 View available echo_cli commands and their short descriptions:
@@ -48,7 +94,7 @@ $ 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).
+`<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 (decimals may follow the SS value).
 
 Example:
 ```bash
@@ -56,18 +102,26 @@ $ echo_cli convert 1492186214
 ```
 The previous example will convert the provided epoch timestamp into a human-readable format.
 
+Example:
+```bash
+$ echo_cli convert 2017-05-11T15:05:23-07:00
+```
+This example will convert from a human-readable timestamp to an epoch timestamp.
+
 #### cpost
 ```bash
-$ echo_cli cpost <URL> '<metric>' {frequency} {-z}
+$ echo_cli cpost <URL> '<metric>' {frequency} {-v} {-z}
 ```
 Parameters:
 
 `<URL>`: (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
+`'<metric>'`: (required) the application name, as well as any tags, and data value and data type to be posted to StatsD
 
 `{frequency}`: (optional) the rate at which the metric will be continuously posted to Echo's server. If left unspecified, this value will default to 10 seconds.
 
+`{-v}`: (optional) continuously output a 'successfully posted' message, with updated start and end times, to the command line.
+
 `{-z}`: (optional) spawn the continuous post process in the background. Additionally, this option will return a PID (Process ID) that can be used in the future to kill the command. Use `kill -9 <PID>` to kill the process.
 
 Example:
@@ -95,18 +149,18 @@ Parameters:
 
 `<URL>`: (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
+`'<metric>'`: (required) the application 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
+`{-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 to occur
 
 Example:
 ```bash
 $ echo_cli https://localhost:8125/metrix '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 'https://localhost:8125/metrix', 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.
+The previous example would post the application name '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 'https://localhost:8125/metrix', and it would be posted 10 times. Additionally, because of the '-q' specified option, OpenTSDB will be queried immediately after the post to StatsD, to verify it has been received by Echo's instance of OpenTSDB.
 
 #### query
 ```bash
@@ -116,7 +170,7 @@ Parameters:
 
 `<URL>`: (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
+`'<metric>'`: (required) the application 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)
 
@@ -132,7 +186,7 @@ Example:
 ```bash
 $ echo_cli https://localhost:4242/api/query '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.
+The previous example will query OpenTSDB with the application 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
@@ -142,7 +196,7 @@ Parameters:
 
 `<URL>`: (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
+`'<metric>'`: (required) the application 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
 
@@ -154,7 +208,7 @@ Example:
 ```bash
 $ echo_cli https://localhost:4242/api/query 'sample.query.here' 300 -s
 ```
-The previous example will query OpenTSDB located on 'https://localhost:4242/api/query' 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. The '-s' option will return the data as SQL statements for later insertion into a SQL database.
+The previous example will query OpenTSDB located on 'https://localhost:4242/api/query' with the application name 'sample' and tags 'query' and 'here', within the time range spanning from the current time to '300' seconds before the current time. The '-s' option will return the data as SQL statements for later insertion into a SQL database.
 
 ## Development
 

data/lib/echo_cli/cli.rb

@@ -86,7 +86,6 @@ module Echo_cli
           if response.code == '200'
             puts "\nSuccessfully posted ".green + request.body.yellow + " to ".green + statsd_uri.blue + "\nTime start: ".green + time_start.yellow + ", Time end: ".green + time_end.yellow
 
-
             if options[:q]
               opentsdb_uri = statsd_uri[0..statsd_uri.index(':8125')-1] + ":4242/api/query"
               query(opentsdb_uri, request.body[0..request.body.index(":")-1], time_start, time_end)
@@ -101,9 +100,10 @@ module Echo_cli
       Helper.new.unset_envs()
     end
 
-    desc "cpost", "Continuously post metrics to Echo. Use \"echo_cli cpost <URL> '<metric>' {frequency} {-z}\""
+    desc "cpost", "Continuously post metrics to Echo. Use \"echo_cli cpost <URL> '<metric>' {frequency} {-v} {-z}\""
 
     option :z
+    option :v
 
     long_desc <<-LONGDESC
       `echo_cli cpost` will continuously post a metric directly to Echo's StatsD server. This process can be killed with "CTRL-c".
@@ -112,9 +112,11 @@ module Echo_cli
 
       Ensure single-quotes surround the metric.
 
-      With -z (zombie) option, cpost will continuously send posts to Echo in the background, and return its PID for future removal. Use "$ kill -9 <PID>" to kill the zombie process.
+      With -v (verbose) option, cpost will continuously output a 'successfully posted' message, with updated times, to the command line.
 
-      > $ echo_cli cpost https://localhost:8125/metrix 'example.post:1|c' {1} {-z}
+      With -z (zombie) option, cpost will continuously send posts to Echo in the background, and return its PID for future removal. Use "$ kill -9 <PID>" to kill the zombie process. Specifying this option will override the '-v' option.
+
+      > $ echo_cli cpost https://localhost:8125/metrix 'example.post:1|c' {1} {-v} {-z}
     LONGDESC
 
     def cpost(statsd_uri, metric, num = 0)
@@ -146,14 +148,23 @@ module Echo_cli
             sleep s
           end
         end
-        puts "Process ID: " + pid.to_s
+        puts "\nProcess ID: ".green + pid.to_s.yellow + "\nUse ".green + "kill -9 ".yellow + pid.to_s.yellow + " to kill the zombie process.".green
       else
         puts "\nPosting: ".green + metric.yellow + " once every ".green + s.to_s.yellow + " seconds".green + " to ".green + statsd_uri.yellow + "\nPress Ctrl-c to kill the process.\n".green
         while true do
-          Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+          time_start = Time.new.to_i.to_s
+
+          response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
             http.request(request)
           end
+
           sleep s
+
+          time_end = Time.new.to_i.to_s
+
+          if(options[:v] && response.code == '200')
+            puts "\nSuccessfully posted ".green + request.body.yellow + " to ".green + statsd_uri.blue + "\nTime start: ".green + time_start.yellow + ", Time end: ".green + time_end.yellow + "\nPress Ctrl-c to kill the process.\n".green
+          end
         end
       end
 
@@ -203,7 +214,7 @@ module Echo_cli
       req.body = opentsdb_query
 
       if options[:v]
-        # begin
+        begin
           res = https.request(req)
           if res.code == '200'
 
@@ -233,9 +244,9 @@ module Echo_cli
           else
             puts "\nFailed to retrieve ".red + metric_name.yellow + " from ".red + opentsdb_uri.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
+        rescue
+          puts "\nYour request returned an error. Are you sure your query was correct?"
+        end
       else
         begin
           res = https.request(req)

data/lib/echo_cli/version.rb

@@ -1,3 +1,3 @@
 module Echo_cli
-  VERSION = "0.6.20"
+  VERSION = "0.6.21"
 end

metadata

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