wavefront-client 2.1.0 → 3.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjdmYWUzYzk4NjEwYzQ1YzdhNGJjYzViMGRmYjY0ZmNkMGExOWU4MQ==
+    YTkyYWUzNzQ3MTVmYjhlNGI3NWZlZDM5YTBjYTAwMzNkMTQ2MjQ0YQ==
   data.tar.gz: !binary |-
-    ODgzZGM5ZGMxNzViNjBhYTE5Y2UwZmI1NmZlMWE3MmVlZWQ0NjY5OQ==
+    NDNlN2ZiNmYxNDE0NzhlMzdjMTJhNjExZGI4ZjhhY2Q0YWE5YjViMw==
 SHA512:
   metadata.gz: !binary |-
-    Zjk2MDYxMWUxODc2MjA2Yzg2ZTQ3NWM5NDZjNzg1ZjA2NDRhY2JhYWVlYTM0
-    ZTEyMTQ3ODdlMDViNDFlNDkyYjZhMTFiN2VhMjcwMWQ0YWVjMmQ4MjBmZDA5
-    ZWQ2NmU5MWViYjAyMDkyZjY2YWVmYWJjZmMxMTdiMjdjYmY1N2I=
+    YzQxYzE3NGZmNzkwNWRjYzgxYWM0MDBhNDk5OGM1NGZlMjE4MDA2ZWI2YTNi
+    YTRhNTQxYTIzYzFhNWRlYTgxYzIyNWI1OTgwNTA1ZWE0NjFmMjY0M2Y2ODg3
+    ZmVlOTJmZDk2YTdiYjVkOGEzOTUzYTMwYjk3NTU5NjVkOWRjZjI=
   data.tar.gz: !binary |-
-    MTc0YWFjNmQyZGFlOWRjYzQwODdlZWIwYWVkOTFmYWJmODQ1OTVkZWQ4MWY4
-    ZGZlZDMxYTRkYjgyZDk4YWZhNjE1YWVhM2Q2YTcyODE2NTgxYWQ5N2MxOGFk
-    ZTI0Y2M3MzAxZGY3MzNkNTIxOGYzOGNmNzcyZDYxMTY0NmJhMjA=
+    MDljMjNlYzg3YTJhNjY0YWQ3MDA0Y2M2ZDYyOWVjMzlkOTA5NzEyMjJhMzNl
+    NmFhMjVmMjI4MDAyNjEzNTc1OTlmOWE5ZWYyY2Y4MzY2ZDg5ODAzOTI2OGEw
+    ZTg0NWFiZGQyOTNhZGRkYmEyNmE3ZGNiMzI2NmIxYjBmNjY1NmE=

data/README.md

@@ -1,8 +1,8 @@
-Wavefront::Client
+Wavefront
 ==========
 [![Build Status](https://travis-ci.org/wavefrontHQ/ruby-client.svg?branch=v0.5.2)](https://travis-ci.org/wavefrontHQ/ruby-client)
 
-This is a simple ruby gem for speaking to the [Wavefront][1] monitoring and graphing system.
+This is a ruby gem for speaking to the [Wavefront][1] monitoring and graphing system.
 
 ## Usage
 Within your own ruby code:
@@ -165,11 +165,52 @@ response.highcharts[0]['data'].first  # [1436849460000, 517160277.3333333]
 ```
 
 ### Command-line client
-A simple command line client is included too. You can see the full list of options by typing `wavefront-client --help` from a prompt.
+A command line client is included too. You can see the full list of options by typing `wavefront --help` from a prompt.
 
 ```bash
-$ wavefront-client '<TS_EXPRESSION>' --minutes --token <YOUR_TOKEN > # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query , <YOUR_TOKEN> : Placeholder for your Wavefront token
-response.class # Wavefront::Response::Ruby
+Usage: wavefront COMMAND QUERY (OPTIONS)
+    -h, --help      Display this message
+
+Available commands:
+
+  ts       Query the timeseries
+  alerts   Query alerts
+
+See `<command> --help` for more information on a specific command.
+
+$ wavefront ts --help
+Usage: wavefront COMMAND QUERY (OPTIONS)
+    -d, --days                        Query granularity of days
+    -D, --debug                       Enable debug mode
+    -m, --minutes                     Query granularity of minutes
+    -H, --hours                       Query granularity of hours
+    -E, --endpoint                    Connect to alternative cluster endpoint (default: metrics.wavefront.com)
+    -S, --seconds                     Query granularity of seconds
+    -s, --start                       Time in UNIX epoch seconds to begin the query from
+    -t, --token                       Wavefront authentication token
+    -e, --end                         Time in UNIX epoch seconds to query to
+    -f, --format                      Output format (raw, ruby, graphite, highcharts) (default: raw)
+    -p, --prefixlength                The number of path elements to treat as a prefix when doing schema manipulations (default: 1)
+    -X, --strict                      Flag to not return points outside the query window [q;s)  (default: true)
+    -O, --includeObsoleteMetrics      Flag to include metrics that have not been reporting for more than 4 weeks,defaults to false
+    -h, --help                        Display this message
+
+$ wavefront ts "ts(my.metric.path.host.cpu-0.percent-idle)" -t SECRET -m -f ruby
+#<Wavefront::Response::Ruby:0x007f02f6bf9d70
+ @granularity=60,
+ @name="Unknown",
+ @options=
+  {:response_format=>:ruby,
+   :prefix_length=>1,
+
+   ...
+
+$ wavefront alerts snoozed -t TOKEN -f json --shared ops
+[
+  {
+    "customerTagsWithCounts": {
+
+   ...
 ```
 
 

data/bin/wavefront

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+#     Copyright 2015 Wavefront Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'wavefront/client'
+require 'slop'
+
+options = Slop.parse(strict: true) do
+  banner 'Usage: wavefront COMMAND QUERY (OPTIONS)'
+    on 'h', 'help', 'Display this message'
+
+  command 'ts' do
+    description "Query the timeseries"
+    on 'd', 'days', 'Query granularity of days'
+    on 'D', 'debug', 'Enable debug mode'
+    on 'm', 'minutes', 'Query granularity of minutes'
+    on 'H', 'hours', 'Query granularity of hours'
+    on 'E', 'endpoint=', 'Connect to alternative cluster endpoint', default: Wavefront::Client::DEFAULT_HOST.to_s
+    on 'S', 'seconds', 'Query granularity of seconds'
+    on 's', 'start=', 'Time in UNIX epoch seconds to begin the query from'
+    on 't', 'token=', 'Wavefront authentication token'
+    on 'e', 'end=', 'Time in UNIX epoch seconds to query to'
+    on 'f', 'format=', "Output format (#{Wavefront::Client::FORMATS.join(', ')})", default: Wavefront::Client::DEFAULT_FORMAT.to_s
+    on 'p', 'prefixlength=', 'The number of path elements to treat as a prefix when doing schema manipulations', default: Wavefront::Client::DEFAULT_PREFIX_LENGTH
+    on 'X', 'strict=','Flag to not return points outside the query window [q;s) ', default: Wavefront::Client::DEFAULT_STRICT
+    on 'O', 'includeObsoleteMetrics=', 'Flag to include metrics that have not been reporting for more than 4 weeks,defaults to false', default: Wavefront::Client::DEFAULT_OBSOLETE_METRICS
+    on 'h', 'help', 'Display this message'
+    run do |options, arguments|
+      require 'wavefront/cli/ts'
+      cli = Wavefront::Cli::Ts.new(options, arguments)
+      cli.run
+    end
+  end
+
+  command 'alerts' do
+    description "Query alerts"
+    on 'E', 'endpoint=', 'Connect to alternative cluster endpoint', default: Wavefront::Client::DEFAULT_HOST.to_s
+    on 'f', 'format=', 'Output format (ruby, json)', default: 'ruby'
+    on 'h', 'help', 'Display this message'
+    on 'p', 'private=', 'Retrieve only alerts with named private tags, comma delimited.'
+    on 's', 'shared=', 'Retrieve only alerts with named shared tags, comma delimited.'
+    on 't', 'token=', 'Wavefront authentication token'
+    run do |options, arguments|
+      require 'wavefront/cli/alerts'
+      cli = Wavefront::Cli::Alerts.new(options, arguments)
+      cli.run
+    end
+  end
+
+end
+
+puts options

data/lib/wavefront/alerting.rb

@@ -53,6 +53,8 @@ module Wavefront
       get_alerts('affected_by_maintenance', options)
     end
 
+    private
+
     def get_alerts(path, options={})
       options[:host] ||= DEFAULT_HOST
       options[:path] ||= DEFAULT_PATH
@@ -77,8 +79,6 @@ module Wavefront
       RestClient.get(uri.to_s)
     end
 
-    private
-
     def debug(enabled)
       if enabled
         RestClient.log = 'stdout'

data/lib/wavefront/cli.rb

@@ -0,0 +1,33 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+module Wavefront
+  class Cli
+
+    attr_accessor :options, :arguments
+
+    def initialize(options, arguments)
+      @options   = options
+      @arguments = arguments
+
+      if @options.help?
+        puts @options
+        exit 0
+      end
+    end
+
+  end
+end

data/lib/wavefront/cli/alerts.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+#     Copyright 2015 Wavefront Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'wavefront/alerting'
+require 'wavefront/cli'
+require 'json'
+require 'pp'
+
+class Wavefront::Cli::Alerts < Wavefront::Cli
+
+  attr_accessor :options, :arguments
+
+  def run
+    alerts = Wavefront::Alerting.new(@options[:token])
+    queries = alerts.public_methods(false).sort
+    queries.delete(:token)
+ 
+    if arguments[0]
+      query = arguments[0].to_sym
+    else
+      puts "Your query should be one of: #{ queries.each {|q| q.to_s}.join(', ') }. See --help for more information"
+      exit 1
+    end
+
+    # This isn't especially nice, but if require to
+    # avoiding breaking the Alerting interface :(
+    options = Hash.new
+    options[:host] = @options[:endpoint]
+
+    if @options[:shared]
+      options[:shared_tags] = @options[:shared].delete(' ').split(',')
+    end
+    if @options[:private]
+      options[:private_tags] = @options[:private].delete(' ').split(',')
+    end
+
+    if queries.include?(query)
+      result = alerts.send(query, options)
+    else
+      puts "Your query should be one of: #{ queries.each {|q| q.to_s}.join(', ') }. See --help for more information"
+      exit 1
+    end
+
+    case @options[:format].to_sym
+    when :ruby
+      pp result
+    when :json
+      puts JSON.pretty_generate(JSON.parse(result))
+    else
+      puts "Invalid output format, See --help for more detail."
+      exit 1
+    end
+
+    exit 0
+  end
+end

data/lib/wavefront/cli/ts.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+#     Copyright 2015 Wavefront Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'wavefront/client'
+require 'wavefront/cli'
+require 'pp'
+require 'json'
+
+class Wavefront::Cli::Ts < Wavefront::Cli
+
+  attr_accessor :options, :arguments
+
+  def run
+    query = @arguments[0]
+    if @options.minutes?
+      granularity = 'm'
+    elsif @options.hours?
+      granularity = 'h'
+    elsif @options.seconds?
+      granularity = 's'
+    elsif @options.days?
+      granularity = 'd'
+    else
+      puts "You must specify a granularity of either --seconds, --minutes --hours or --days. See --help for more information."
+      exit 1
+    end
+
+    unless Wavefront::Client::FORMATS.include?(@options[:format].to_sym)
+      puts "The output format must be on of #{Wavefront::Client::FORMATS.join(', ')}"
+      exit 1
+    end
+
+    options = Hash.new
+    options[:response_format] = @options[:format].to_sym
+    options[:prefix_length] = @options[:prefixlength].to_i
+
+    if @options[:start]
+      options[:start_time] = Time.at(@options[:start].to_i)
+    end
+
+    if @options[:end]
+      options[:end_time] = Time.at(@options[:end].to_i)
+    end
+
+    wave = Wavefront::Client.new(@options[:token], @options[:endpoint], @options[:debug])
+    case options[:response_format]
+    when :raw
+      puts wave.query(query, granularity, options)
+    when :graphite
+      puts wave.query(query, granularity, options).graphite.to_json
+    else
+      pp wave.query(query, granularity, options)
+    end
+
+    exit 0
+  end
+end

data/lib/wavefront/client/version.rb

@@ -16,6 +16,6 @@ See the License for the specific language governing permissions and
 
 module Wavefront
   class Client
-    VERSION = "2.1.0"
+    VERSION = "3.0.0"
   end
 end

data/spec/wavefront/alerting_spec.rb

@@ -45,38 +45,38 @@ describe Wavefront::Alerting do
   describe '#get_alerts' do
     it 'makes API request with default options' do
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}")}")
-      @wave.get_alerts('all')
+      @wave.all
     end
 
     it 'makes API request with specified host' do
       host = 'madeup.wavefront.com'
       expect(RestClient).to receive(:get).with("https://#{File.join(host, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}")}")
-      @wave.get_alerts('all', { :host => host } )
+      @wave.all({ :host => host })
     end
 
     it 'makes API request with specified path' do
       path = '/api/new_alerts' 
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, path, "all?t=#{TEST_TOKEN}")}")
-      @wave.get_alerts('all', { :path => path })
+      @wave.all({ :path => path })
     end
 
     it 'makes API request with appended shared tags' do
       tags = [ 'first', 'second' ]
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&customerTag=first&customerTag=second")}")
-      @wave.get_alerts('all', { :shared_tags => tags })
+      @wave.all({ :shared_tags => tags })
     end
 
     it 'makes API request with appended private tags' do
       tags = [ 'first', 'second' ]
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&userTag=first&userTag=second")}")
-      @wave.get_alerts('all', { :private_tags => tags })
+      @wave.all({ :private_tags => tags })
     end
 
     it 'makes API request with both appended private tags and shared tags' do
       private_tag = 'first' 
       shared_tag = 'second'
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&customerTag=second&userTag=first")}")
-      @wave.get_alerts('all', { :private_tags => private_tag, :shared_tags => shared_tag })
+      @wave.all({ :private_tags => private_tag, :shared_tags => shared_tag })
     end
   end
 

data/wavefront-client.gemspec

@@ -22,7 +22,7 @@ require 'wavefront/client/version'
 Gem::Specification.new do |spec|
   spec.name          = "wavefront-client"
   spec.version       = Wavefront::Client::VERSION
-  spec.authors       = ["Sam Pointer", "Louis McCormack", "Joshua McGhee", "Conor Beverland", "Salil Deshmukh"]
+  spec.authors       = ["Sam Pointer", "Louis McCormack", "Joshua McGhee", "Conor Beverland", "Salil Deshmukh", "Rob Fisher"]
   spec.email         = ["support@wavefront.com"]
   spec.description   = %q{A simple abstraction for talking to wavefront in ruby}
   spec.summary       = %q{A simple abstraction for talking to wavefront in ruby}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sam Pointer
@@ -9,10 +9,11 @@ authors:
 - Joshua McGhee
 - Conor Beverland
 - Salil Deshmukh
+- Rob Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +101,7 @@ description: A simple abstraction for talking to wavefront in ruby
 email:
 - support@wavefront.com
 executables:
-- wavefront-client
+- wavefront
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,8 +113,11 @@ files:
 - NOTICE
 - README.md
 - Rakefile
-- bin/wavefront-client
+- bin/wavefront
 - lib/wavefront/alerting.rb
+- lib/wavefront/cli.rb
+- lib/wavefront/cli/alerts.rb
+- lib/wavefront/cli/ts.rb
 - lib/wavefront/client.rb
 - lib/wavefront/client/version.rb
 - lib/wavefront/constants.rb

data/bin/wavefront-client

@@ -1,84 +0,0 @@
-#!/usr/bin/env ruby
-
-#     Copyright 2015 Wavefront Inc.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-# http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-#    limitations under the License.
-
-require 'wavefront/client'
-require 'slop'
-require 'pp'
-require 'json'
-
-@opts = Slop.parse(strict: true) do
-  banner 'Usage: wavefront-client QUERY (OPTIONS)'
-  on 'd', 'days', 'Query granularity of days'
-  on 'D', 'debug', 'Enable debug mode'
-  on 'm', 'minutes', 'Query granularity of minutes'
-  on 'H', 'hours', 'Query granularity of hours'
-  on 'E', 'endpoint=', 'Connect to alternative cluster endpoint', default: Wavefront::Client::DEFAULT_HOST.to_s
-  on 'S', 'seconds', 'Query granularity of seconds'
-  on 's', 'start=', 'Time in UNIX epoch seconds to begin the query from'
-  on 't', 'token=', 'Wavefront authentication token'
-  on 'e', 'end=', 'Time in UNIX epoch seconds to query to'
-  on 'f', 'format=', "Output format (#{Wavefront::Client::FORMATS.join(', ')})", default: Wavefront::Client::DEFAULT_FORMAT.to_s
-  on 'p', 'prefixlength=', 'The number of path elements to treat as a prefix when doing schema manipulations', default: Wavefront::Client::DEFAULT_PREFIX_LENGTH
-  on 'X', 'strict=','Flag to not return points outside the query window [q;s) ', default: Wavefront::Client::DEFAULT_STRICT
-  on 'O', 'includeObsoleteMetrics=', 'Flag to include metrics that have not been reporting for more than 4 weeks,defaults to false', default: Wavefront::Client::DEFAULT_OBSOLETE_METRICS
-
-  on 'h', 'help', 'Display this message'
-end
-
-if @opts.help?
-  puts @opts
-  exit 0
-end
-
-query = ARGV[0]
-if @opts.minutes?
-  granularity = 'm'
-elsif @opts.hours?
-  granularity = 'h'
-elsif @opts.seconds?
-  granularity = 's'
-elsif @opts.days?
-  granularity = 'd'
-else
-  puts "You must specify a granularity of either --seconds, --minutes --hours or --days. See --help for more information."
-  exit 1
-end
-
-unless Wavefront::Client::FORMATS.include?(@opts[:format].to_sym)
-  puts "The output format must be on of #{Wavefront::Client::FORMATS.join(', ')}"
-  exit 1
-end
-
-options = Hash.new
-options[:response_format] = @opts[:format].to_sym
-options[:prefix_length] = @opts[:prefixlength].to_i
-
-if @opts[:start]
-  options[:start_time] = Time.at(@opts[:start].to_i)
-end
-
-if @opts[:end]
-  options[:end_time] = Time.at(@opts[:end].to_i)
-end
-
-wave = Wavefront::Client.new(@opts[:token], @opts[:endpoint], @opts[:debug])
-case options[:response_format]
-when :raw
-  puts wave.query(query, granularity, options)
-when :graphite
-  puts wave.query(query, granularity, options).graphite.to_json
-else
-  pp wave.query(query, granularity, options)
-end