echo_cli 0.6.29 → 0.6.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26bf693fbc018a0624ee60571d06ce3c33bfa07d
-  data.tar.gz: 95192e063314016954d2061a219e86584d3f9de5
+  metadata.gz: b439b9468fe852290283224be9c6fe0532ed8a5f
+  data.tar.gz: 91ab851d7dc0a1df8d3bf00727a9bcf6e6534932
 SHA512:
-  metadata.gz: a92e5e51809a070142ae9a4f7e2066b86c8d7470eab7dfd1f22de3ace02709fc1b141bd585e39fad72601dee5551e172e715eb135df4e09e2aa7b4ca43495915
-  data.tar.gz: 92e19d071b2a66ce36b2594d126410b9d9f34f797b908f3904c9c3e7ebc54ed1b9eb6c7fd39c4fb6ebde73b1f92845396133a1af51d0168176761f1b47600c84
+  metadata.gz: 29ffc04dc9219323aac4f00e4ea509932890272bb8d08300b0e6f69a95468e084d5e6ff8e3ab3bd8855d1dfd9fddf3b8fa18a3c0317423beb4356bb968799371
+  data.tar.gz: dce30d422c33bc587e5716ea593e7b8e5f3de433c0fc481a9e3044a62dbf440488265fa935bc16df1acd37f1dda0b86a0bf30cd86b87ce673e1afff5e9199892

data/README.md

@@ -1,7 +1,33 @@
 # Echo_cli
 
+#### Table of Contents
+* [Installation](https://github.allstate.com/CompoZedPlatform/echo_cli#installation)
+  * [Quick Start](https://github.allstate.com/CompoZedPlatform/echo_cli#quick-start)
+  * [Long Start](https://github.allstate.com/CompoZedPlatform/echo_cli#long-start)
+* [Metrics Explained](https://github.allstate.com/CompoZedPlatform/echo_cli#metrics-explained)
+  * [Posting Data to Echo](https://github.allstate.com/CompoZedPlatform/echo_cli#posting-data-to-echo)
+* [Usage](https://github.allstate.com/CompoZedPlatform/echo_cli#usage)
+  * [Commands](https://github.allstate.com/CompoZedPlatform/echo_cli#commands)
+* [Development](https://github.allstate.com/CompoZedPlatform/echo_cli#development)
+  * [Testing](https://github.allstate.com/CompoZedPlatform/echo_cli#testing)
+* [Contributing](https://github.allstate.com/CompoZedPlatform/echo_cli#contributing)
+* [License](https://github.allstate.com/CompoZedPlatform/echo_cli#license)
+
 ## Installation
 
+### Quick Start
+***NOTE: requires rbenv and git already installed***
+
+```bash
+$ export ECHO_CLI_HOST = {ECHO_IP}
+$ sudo gem install echo_cli
+$ echo_cli
+```
+
+Replace {ECHO_IP} with Echo's instance IP address (e.g. 10.100.100.100)
+
+### Long Start
+
 Ensure git and rbenv (or rvm, NOT both) are installed on your machine:
 
 Verify the 'rbenv' and 'git' commands are found
@@ -56,19 +82,19 @@ Finally, export the environment variable "ECHO_CLI_HOST", and set this value to
 The Echo server receives data in text format with the following syntax:
 
 ```
-<Application_name>.<tag1>.<tag2>…<tag(n)>:<value>|<metric type>
+<Application_name>.<tag1>.<tag2>…<tag(n)>:<value>|<metric_type>
 ```
 
-### Application name
+#### 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)
+#### 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
+#### Value
 This is a numeric value that is representative of the metric being tracked.  It must be a number in text format.
 
-### Metric type
+#### 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.
@@ -152,7 +178,7 @@ The previous example would post the application name 'sample' with tags 'post' a
 
 #### query
 ```bash
-$ echo_cli query '<metric>' <time_start> <time_end>
+$ echo_cli query '<metric>' {time_start} {time_end} {-n}
 ```
 Parameters:
 
@@ -162,6 +188,8 @@ Parameters:
 
 `{time_end}`: (optional) the end of the range you are attempting to query in seconds from January 1, 1970 (epoch time)
 
+`{-n}`: (optional) return all datapoints upon a successful query, including null datapoints
+
 See: https://graphite-api.readthedocs.io/en/latest/api.html#from-until for possible time_start and time_end formats.
 
 The default timestamp query range begins 15 minutes prior to the current time, to now.
@@ -172,7 +200,7 @@ $ echo_cli query 'sample.query.here:1|c' 1492464745 1492465045
 ```
 The previous example will query Graphite with the application name 'sample' and tags 'query' and 'here' between the times of '1492464745' and '1492465045'.
 
-## Development
+## Development (Echo Devs Only)
 
 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.
 
@@ -196,7 +224,7 @@ $ rake release
 $ gem install echo_cli
 ```
 
-#### Testing
+### Testing
 ```bash
 $ gem install webmock
 $ ruby test/echo_cli_test.rb

data/lib/echo_cli/cli.rb

@@ -72,10 +72,12 @@ module Echo_cli
       helper.unset_envs()
     end
 
-    desc "query", "Query metrics on Echo. Use \"echo_cli query '<metric>' {time_start} {time_end}\""
+    desc "query", "Query metrics on Echo. Use \"echo_cli query '<metric>' {time_start} {time_end} {-n}\""
+
+    option :n
 
     long_desc <<-LONGDESC
-      Query metrics on Echo. Use \"echo_cli query '<metric>' {time_start} {time_end}\"
+      Query metrics on Echo. Use \"echo_cli query '<metric>' {time_start} {time_end} {-n}\"
 
       `echo_cli query` will query a metric directly from Echo's Graphite server instance.
 
@@ -89,6 +91,10 @@ module Echo_cli
 
       Ensure the environment variable 'ECHO_CLI_HOST' is set to the correct IP.
 
+      By default, the CLI removes any null datapoints from the returned query, so an empty dataset returned upon a successful query would suggest that either not datapoints were found in the query range, or that the metric was spelled incorrectly.
+
+      The -n option can be used to print all of the datapoints - including null datapoints - resulting from a query.
+
       > $ echo_cli query 'example.query:1|c' {1492186212} {-5min}
     LONGDESC
 
@@ -108,7 +114,11 @@ module Echo_cli
         puts "\nResponse Body:\n".red
         puts response.body
       else
-        puts "\nSuccessful Query:\n\n".green + JSON.parse(response.body).to_s.green
+        res = JSON.parse(response.body)
+        if(!options[:n])
+          res.each_with_index{|target, index| res[index]["datapoints"].delete_if{|value| value[0] == nil}}
+        end
+        puts "\nSuccessful Query:\n\n".green + JSON.pretty_generate(res).to_s.green
       end
       helper.unset_envs()
     end
@@ -200,11 +210,11 @@ module Echo_cli
       type = metric[metric.index('|') + 1 .. metric.length]
       case type
       when 'c'
-        return "stats.counters." + metric[0..metric.index(':')-1] + ".count"
+        return "stats.counters." + metric[0..metric.index(':')-1] + ".*"
       when 'ms'
-        return "stats.timers." + metric[0..metric.index(':')-1]
+        return "stats.timers." + metric[0..metric.index(':')-1] + ".*"
       when 's'
-        return "stats.sets." + metric[0..metric.index(':')-1]
+        return "stats.sets." + metric[0..metric.index(':')-1] + ".*"
       when 'g'
         return "stats.gauges." + metric[0..metric.index(':')-1]
       end
@@ -212,7 +222,7 @@ module Echo_cli
 
     def check_metric_format(metric)
       if /.*(:\d*\.?\d*)\|(ms|c|g|s)/.match(metric).to_s != metric
-        puts "\nThe posted metric was not of the correct form.\nMetrics must be of the form <metric>.<tag1>.<tag2>...<tagN>:<value>|<type>".red
+        puts "\nThe posted metric was not of the correct form.\nMetrics must be of the form ".red + "<Application_name>.<tag1>.<tag2>...<tag(n)>:<value>|<metric_type>".yellow
         puts "Where <value> is a number, and <type> is any of the following: 'ms', 'c', 's', 'g'.".red
         return false
       end

data/lib/echo_cli/version.rb

@@ -1,3 +1,3 @@
 module Echo_cli
-  VERSION = "0.6.29"
+  VERSION = "0.6.31"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: echo_cli
 version: !ruby/object:Gem::Version
-  version: 0.6.29
+  version: 0.6.31
 platform: ruby
 authors:
 - Brandon Raphael
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor