echo_cli 0.6.21 → 0.6.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 455a70f05530bd541185638a1c07ed7005bba915
-  data.tar.gz: d298d2bd257fd85935a71c0e9a123a1efde0c34f
+  metadata.gz: 0d6b85ab3089231acf50fb16fa379c145fe269dc
+  data.tar.gz: 479af41f845d3ef69a59cd5e148017d1b6071d18
 SHA512:
-  metadata.gz: aee1848d8b950130cbd33ecc95bf2d9a4134551f481b50cef43105003d6906fe63c05be04b18559826c5dfcc30a84aad51b48410d7f3c46942c6ff76351be519
-  data.tar.gz: fd88e47ba8f795825c6cd69854d1fdf54b0fc4531500b02e4e1b3004098583ea52c040bae12f621a560e4c3526e578f7979efdaaff4d042fbc43b166b4989bcf
+  metadata.gz: 4131237a0635701a8d5f76c32b93c30d62e584b62d009cc252685e5c1b48bb0a4c714c2bd3e6b1d842c27a656b07bf6ba960030a4af0bc191f88e38b9b3478ae
+  data.tar.gz: e0cc7373b95d1a4334b11f68fd3dc1c37f6f53b605cf24ec6d5aa51c38045c674d8c5dcb970553267ba97fa6fd92ae28329eb23a94950716b649ed540d573db6

data/README.md

@@ -48,6 +48,8 @@ Test the installation to ensure it is working properly (no errors should occur i
 $ echo_cli
 ```
 
+Finally, export the environment variable "ECHO_CLI_HOST", and set this value to be the IP of the Echo instance you would like to use (e.g. export ECHO_CLI_HOST=10.111.111.111). This environment variable can be set inside your .bashrc file to ensure ease of use of the Echo CLI every time you create a new bash environment.
+
 ## Metrics Explained
 
 ### Posting data to Echo
@@ -110,12 +112,10 @@ This example will convert from a human-readable timestamp to an epoch timestamp.
 
 #### cpost
 ```bash
-$ echo_cli cpost <URL> '<metric>' {frequency} {-v} {-z}
+$ echo_cli cpost '<metric>' {frequency} {-v} {-z}
 ```
 Parameters:
 
-`<URL>`: (required) specifies the StatsD endpoint you are attempting to post a metric to
-
 `'<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.
@@ -126,9 +126,9 @@ Parameters:
 
 Example:
 ```bash
-$ echo_cli cpost https://localhost:8125/metrix 'example.post:1|c' 5 -z
+$ echo_cli cpost 'example.post:1|c' 5 -z
 ```
-The previous example will post the metric 'example' with tag 'post' to Echo's StatsD server instance at 'https://localhost:8125/metrix' once every 5 seconds. The specified '-z' option will spawn the process in the background, and return the newly spawned process ID in the command line.
+The previous example will post the metric 'example' with tag 'post' to Echo's StatsD server instance once every 5 seconds. The specified '-z' option will spawn the process in the background, and return the newly spawned process ID in the command line.
 
 #### help
 ```bash
@@ -143,33 +143,28 @@ $ echo_cli help post
 
 #### post
 ```bash
-$ echo_cli post <URL> '<metric>' {number} {-q}
+$ echo_cli post '<metric>' {number} {-q}
 ```
 Parameters:
 
-`<URL>`: (required) specifies the StatsD endpoint you are attempting to post a metric to
-
 `'<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 to occur
 
 Example:
 ```bash
-$ echo_cli https://localhost:8125/metrix 'sample.post.here:1|c' 10 -q
+$ echo_cli 'sample.post.here:1|c' 10 -q
 ```
-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.
+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, 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
-$ echo_cli query <URL> '<metric>' <time_start> <time_end> {-v} {-e} {-s}
+$ echo_cli query '<metric>' <time_start> <time_end> {-v} {-e} {-s}
 ```
 Parameters:
 
-`<URL>`: (required) specifies the OpenTSDB endpoint you are attempting to query
-
 `'<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)
@@ -184,18 +179,16 @@ Parameters:
 
 Example:
 ```bash
-$ echo_cli https://localhost:4242/api/query 'sample.query.here' 1492464745 1492465045 -v
+$ echo_cli query 'sample.query.here' 1492464745 1492465045 -v
 ```
 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
+#### fquery
 ```bash
-$ echo_cli quick_query <URL> '<metric>' <range> {-e} {-s}
+$ echo_cli fquery '<metric>' <range> {-e} {-s}
 ```
 Parameters:
 
-`<URL>`: (required) specifies the OpenTSDB endpoint you are attempting to query
-
 `'<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
@@ -206,9 +199,9 @@ Parameters:
 
 Example:
 ```bash
-$ echo_cli https://localhost:4242/api/query 'sample.query.here' 300 -s
+$ echo_cli fquery 'sample.query.here' 300 -s
 ```
-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.
+The previous example will query OpenTSDB 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

@@ -9,7 +9,7 @@ require 'openssl'
 
 module Echo_cli
   class Echo < Thor
-    desc "post", "Post metrics to Echo. Use \"echo_cli post <URL> '<metric>' {number} {-q}\""
+    desc "post", "Post metrics to Echo. Use \"echo_cli post '<metric>' {number} {-q}\""
 
     option :q
 
@@ -22,10 +22,11 @@ module Echo_cli
 
       With -q (query-verify) option, post will perform a query of previously posted metric in Echo's instance of OpenTSDB, and provide a message verifying the datapoint exists.
 
-      > $ echo_cli post https://localhost:8125/metrix 'example.post:1|c' {10} {-q}
+      > $ echo_cli post 'example.post:1|c' {10} {-q}
     LONGDESC
 
-    def post(statsd_uri, metric, num = 0)
+    def post(metric, num = 0)
+      statsd_uri = "https://" + ENV["ECHO_CLI_HOST"] + ":8125/metrix"
 
       Helper.new.set_envs()
 
@@ -100,7 +101,7 @@ module Echo_cli
       Helper.new.unset_envs()
     end
 
-    desc "cpost", "Continuously post metrics to Echo. Use \"echo_cli cpost <URL> '<metric>' {frequency} {-v} {-z}\""
+    desc "cpost", "Continuously post metrics to Echo. Use \"echo_cli cpost '<metric>' {frequency} {-v} {-z}\""
 
     option :z
     option :v
@@ -116,10 +117,11 @@ module Echo_cli
 
       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}
+      > $ echo_cli cpost 'example.post:1|c' {1} {-v} {-z}
     LONGDESC
 
-    def cpost(statsd_uri, metric, num = 0)
+    def cpost(metric, num = 0)
+      statsd_uri = "https://" + ENV["ECHO_CLI_HOST"] + ":8125/metrix"
 
       Helper.new.set_envs()
 
@@ -172,7 +174,7 @@ module Echo_cli
 
     end
 
-    desc "query", "Query metrics on Echo. Use \"echo_cli query <URL> '<metric>' <time_start> <time_end> {-v} {-e} {-s}\""
+    desc "query", "Query metrics on Echo. Use \"echo_cli query '<metric>' <time_start> <time_end> {-v} {-e} {-s}\""
 
     option :v
     option :e
@@ -195,10 +197,12 @@ module Echo_cli
 
       With -s (sql) option, echo_cli will format the response data, with the verbose ('-v') option selected, to be usable within a sql database.
 
-      > $ echo_cli query https://localhost:4242/api/query 'example.post' 1492186212 1492186214 {-v}
+      > $ echo_cli query 'example.post' 1492186212 1492186214 {-v}
     LONGDESC
 
-    def query(opentsdb_uri, metric, time_start, time_end)
+    def query(metric, time_start, time_end)
+      opentsdb_uri = "https://" + ENV["ECHO_CLI_HOST"] + ":4242/api/query"
+
       metric = Helper.new.get_metric(metric)
       metric_name = Helper.new.get_metric_name(metric)
       tags = Helper.new.check_get_tags(metric)
@@ -265,17 +269,17 @@ module Echo_cli
       return res.code
     end
 
-    desc "quick_query", "Query metrics on Echo from the current time. Use \"echo_cli quick_query <URL> '<metric>' <range> {-e} {-s}\""
+    desc "fquery", "Query metrics on Echo from the current time. Use \"echo_cli fquery '<metric>' <range> {-e} {-s}\""
 
     option :e
     option :s
 
     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.
+      `echo_cli fquery` (fast 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).
+      Unlike the echo_cli post command, fquery 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.
 
@@ -283,12 +287,14 @@ module Echo_cli
 
       With -s (sql) option, echo_cli will format the response data to be usable within a sql database.
 
-      > $ echo_cli quick_query https://localhost:4242/api/query 'example' 30
+      > $ echo_cli fquery '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(opentsdb_uri, metric, range)
+    def fquery(metric, range)
+      opentsdb_uri = "https://" + ENV["ECHO_CLI_HOST"] + ":4242/api/query"
+
       time_end = Time.new.to_i
       time_start = time_end - range.to_i
       time_start = time_start.to_s

data/lib/echo_cli/version.rb

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

metadata

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