wavefront-client 3.5.3 → 3.5.4

data/lib/wavefront/alerting.rb

@@ -17,6 +17,7 @@ See the License for the specific language governing permissions and
 require "wavefront/client/version"
 require "wavefront/constants"
 require 'wavefront/mixins'
+require 'wavefront/validators'
 require 'rest_client'
 require 'uri'
 require 'logger'
@@ -28,11 +29,18 @@ module Wavefront
     include Wavefront::Mixins
     DEFAULT_PATH = '/api/alert/'
 
-    attr_reader :token
+    attr_reader :token, :noop, :verbose, :endpoint
 
-    def initialize(token, debug=false)
+    def initialize(token, host = DEFAULT_HOST, debug=false, options = {})
+      #
+      # Following existing convention, 'host' is the Wavefront API endpoint.
+      #
+      @headers = { :'X-AUTH-TOKEN' => token }
+      @endpoint = host
       @token = token
       debug(debug)
+      @noop = options[:noop]
+      @verbose = options[:verbose]
     end
 
     def active(options={})
@@ -76,7 +84,7 @@ module Wavefront
     end
 
     def get_alerts(path, options={})
-      options[:host] ||= DEFAULT_HOST
+      options[:host] ||= endpoint
       options[:path] ||= DEFAULT_PATH
 
       uri = URI::HTTPS.build(
@@ -85,6 +93,9 @@ module Wavefront
 	      query: mk_qs(options),
       )
 
+      puts "GET #{uri.to_s}" if (verbose || noop)
+      return if noop
+
       RestClient.get(uri.to_s)
     end
 

data/lib/wavefront/batch_writer.rb

@@ -66,12 +66,15 @@ module Wavefront
                    rejected: 0,
                    unsent:   0,
                  }
+
       @opts = setup_options(options, defaults)
 
       if opts[:tags]
         valid_tags?(opts[:tags])
         @global_tags = opts[:tags]
       end
+
+      debug(options[:debug])
     end
 
     def setup_options(user, defaults)
@@ -210,5 +213,9 @@ module Wavefront
       puts 'Closing connection to proxy.' if opts[:verbose]
       sock.close
     end
+
+    def debug(enabled)
+      RestClient.log = 'stdout' if enabled
+    end
   end
 end

data/lib/wavefront/cli.rb

@@ -14,16 +14,19 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'inifile'
+require 'wavefront/constants'
 
 module Wavefront
+  #
+  # Parent of all the CLI classes.
+  #
   class Cli
-
-    attr_accessor :options, :arguments
+    attr_accessor :options, :arguments, :noop
 
     def initialize(options, arguments)
       @options   = options
       @arguments = arguments
+      @noop = options[:noop]
 
       if options.include?(:help) && options[:help]
         puts options
@@ -31,22 +34,17 @@ module Wavefront
       end
     end
 
-    def load_profile
+    def validate_opts
       #
-      # Load in configuration options from the (optionally) given
-      # section of an ini-style configuration file. If the file's
-      # not there, we don't consider that an error.
+      # There are things we need to have. If we don't have them,
+      # stop the user right now. Also, if we're in debug mode, print
+      # out a hash of options, which can be very useful when doing
+      # actual debugging. Some classes may have to override this
+      # method. The writer, for instance, uses a proxy and has no
+      # token.
       #
-      return unless options[:config].is_a?(String)
-      cf = Pathname.new(options[:config])
-      return unless cf.exist?
-
-      pf = options[:profile] || 'default'
-      puts "using #{pf} profile from #{cf}" if options[:debug]
-
-      IniFile.load(cf)[pf].each_with_object({}) do |(k, v), memo|
-        memo[k.to_sym] = v
-      end
+      raise 'Please supply an API token.' unless options[:token]
+      raise 'Please supply an API endpoint.' unless options[:endpoint]
     end
   end
 end

data/lib/wavefront/cli/alerts.rb

@@ -28,9 +28,11 @@ class Wavefront::Cli::Alerts < Wavefront::Cli
     raise 'Missing query.' if arguments.empty?
     query = arguments[0].to_sym
 
-    wfa = Wavefront::Alerting.new(@options[:token])
+    wfa = Wavefront::Alerting.new(@options[:token], @options[:endpoint],
+                                  @options[:debug], {
+      noop: @options[:noop], verbose: @options[:verbose]})
     valid_state?(wfa, query)
-    valid_format?(@options[:format].to_sym)
+    valid_format?(@options[:alertformat].to_sym)
     options = { host: @options[:endpoint] }
 
     if @options[:shared]
@@ -43,11 +45,12 @@ class Wavefront::Cli::Alerts < Wavefront::Cli
 
     begin
       result = wfa.send(query, options)
-    rescue
+    rescue => e
+      puts e if @options[:debug]
       raise 'Unable to execute query.'
     end
 
-    format_result(result, @options[:format].to_sym)
+    format_result(result, @options[:alertformat].to_sym)
     exit
   end
 
@@ -56,6 +59,8 @@ class Wavefront::Cli::Alerts < Wavefront::Cli
     # Call a suitable method to display the output of the API call,
     # which is JSON.
     #
+    return if noop
+
     case format
     when :ruby
       pp result
@@ -83,11 +88,10 @@ class Wavefront::Cli::Alerts < Wavefront::Cli
     # Check the alert type we've been given is valid. There needs to
     # be a public method in the 'alerting' class for every one.
     #
-    s = wfa.public_methods(false).sort
-    s.delete(:token)
-    unless s.include?(state)
-      raise 'State must be one of: ' + s.each { |q| q.to_s }.join(', ') +
-        '.'
+    states = %w(active affected_by_maintenance all invalid snoozed)
+
+    unless states.include?(state.to_s)
+      raise "State must be one of: #{states.join(', ')}."
     end
     true
   end
@@ -120,7 +124,7 @@ class Wavefront::Cli::Alerts < Wavefront::Cli
         else
           human_line(key, alert[key])
         end
-      end
+      end.<< ''
     end
   end
 
@@ -166,6 +170,7 @@ class Wavefront::Cli::Alerts < Wavefront::Cli
     #
     # hanging indent long lines to fit in an 80-column terminal
     #
+    return unless line
     line.gsub(/(.{1,#{cols - offset}})(\s+|\Z)/, "\\1\n#{' ' *
               offset}").rstrip
   end

data/lib/wavefront/cli/batch_write.rb

@@ -12,14 +12,23 @@ class Wavefront::Cli::BatchWrite < Wavefront::Cli
   include Wavefront::Constants
   include Wavefront::Mixins
 
+  def validate_opts
+    #
+    # Unlike all the API methods, we don't need a token here
+    #
+    abort 'Please supply a proxy endpoint.' unless options[:proxy]
+  end
+
   def run
-    raise 'Invalid format string.' unless valid_format?(options[:format])
+    unless valid_format?(options[:infileformat])
+      raise 'Invalid format string.'
+    end
 
     file = options[:'<file>']
     setup_opts(options)
 
-    if options.key?(:format)
-      setup_fmt(options[:format])
+    if options.key?(:infileformat)
+      setup_fmt(options[:infileformat])
     else
       setup_fmt
     end

data/lib/wavefront/cli/events.rb

@@ -27,7 +27,8 @@ require 'socket'
 # in a timeseries API call.
 #
 class Wavefront::Cli::Events < Wavefront::Cli
-  attr_accessor :state_dir, :hosts, :hostname, :t_start, :t_end, :wf_event
+  attr_accessor :state_dir, :hosts, :hostname, :t_start, :t_end,
+                :wf_event
 
   include Wavefront::Constants
   include Wavefront::Mixins
@@ -43,8 +44,11 @@ class Wavefront::Cli::Events < Wavefront::Cli
     @hosts = prep_hosts(options[:host])
     @t_start = prep_time(:start)
     @t_end = prep_time(:end)
+    @noop = options[:noop]
 
-    @wf_event = Wavefront::Events.new(options[:token])
+    @wf_event = Wavefront::Events.new(
+      options[:token], options[:endpoint], options[:debug],
+      { verbose: options[:verbose], noop: options[:noop]})
 
     if options[:create]
       create_event_handler
@@ -77,7 +81,7 @@ class Wavefront::Cli::Events < Wavefront::Cli
       raise 'Cannot delete event.'
     end
 
-    puts 'Deleted event.'
+    puts 'Deleted event.' unless noop
   end
 
   def prep_time(t)
@@ -104,6 +108,8 @@ class Wavefront::Cli::Events < Wavefront::Cli
     #
     output = create_event
 
+    return if noop
+
     unless options[:end] || options[:instant]
       create_state_dir
       create_state_file(output) unless options[:nostate]
@@ -211,6 +217,7 @@ class Wavefront::Cli::Events < Wavefront::Cli
     #
     # Returns an array of [timestamp, event_name]
     #
+    return false unless state_dir.exist?
     list = state_dir.children
     list.select! { |f| f.basename.to_s.split('::').last == name } if name
     return false if list.length == 0
@@ -249,4 +256,13 @@ class Wavefront::Cli::Events < Wavefront::Cli
 
     puts "Event state recorded at #{fname}."
   end
+
+  def validate_opts
+    #
+    # the 'show' sub-command does not make an API call
+    #
+    return true if options[:show]
+    abort 'Please supply an API token.' unless options[:token]
+    abort 'Please supply an API endpoint.' unless options[:endpoint]
+  end
 end

data/lib/wavefront/cli/sources.rb

@@ -7,18 +7,21 @@ require 'pp'
 # Turn CLI input, from the 'sources' command, into metadata API calls
 #
 class Wavefront::Cli::Sources < Wavefront::Cli
-  attr_accessor :wf, :out_format, :show_hidden, :show_tags
+  attr_accessor :wf, :out_format, :show_hidden, :show_tags, :verbose
 
   def setup_wf
     @wf = Wavefront::Metadata.new(options[:token], options[:endpoint],
-                                 false, { verbose: options[:verbose] })
+                                  options[:debug],
+                                  { verbose: options[:verbose],
+                                    noop:    options[:noop]})
   end
 
   def run
     setup_wf
-    @out_format = options[:format]
+    @out_format = options[:sourceformat].to_s
     @show_hidden = options[:all]
     @show_tags = options[:tags]
+    @verbose = options[:verbose]
 
     begin
       if options[:list]
@@ -49,17 +52,20 @@ class Wavefront::Cli::Sources < Wavefront::Cli
 
     q = {
       desc:         false,
-      limit:        limit,
+      limit:        limit.to_i,
       pattern:      pattern
     }
 
     q[:lastEntityId] = start if start
 
-    display_data(wf.show_sources(q), 'list_source')
+    res = wf.show_sources(q)
+    return if noop
+    display_data(res, 'list_source')
   end
 
   def describe_handler(hosts, desc)
     hosts = [Socket.gethostname] if hosts.empty?
+    hosts = [hosts] if hosts.is_a?(String)
 
     hosts.each do |h|
       if desc.empty?
@@ -77,20 +83,22 @@ class Wavefront::Cli::Sources < Wavefront::Cli
   end
 
   def untag_handler(hosts)
-    hosts ||= [Socket.gethostname]
+    hosts ||= Socket.gethostname
+    hosts = [hosts] if hosts.is_a?(String)
 
     hosts.each do |h|
-      puts "Removing all tags from '#{h}'"
+      puts "Removing all tags from '#{h}'" if verbose
       wf.delete_tags(h)
     end
   end
 
   def add_tag_handler(hosts, tags)
-    hosts ||= [Socket.gethostname]
+    hosts ||= Socket.gethostname
+    hosts = [hosts] if hosts.is_a?(String)
 
     hosts.each do |h|
       tags.each do |t|
-        puts "Tagging '#{h}' with '#{t}'"
+        puts "Tagging '#{h}' with '#{t}'" if verbose
         begin
           wf.set_tag(h, t)
         rescue Wavefront::Exception::InvalidString
@@ -101,11 +109,12 @@ class Wavefront::Cli::Sources < Wavefront::Cli
   end
 
   def delete_tag_handler(hosts, tags)
-    hosts ||= [Socket.gethostname]
+    hosts ||= Socket.gethostname
+    hosts = [hosts] if hosts.is_a?(String)
 
     hosts.each do |h|
       tags.each do |t|
-        puts "Removing tag '#{t}' from '#{h}'"
+        puts "Removing tag '#{t}' from '#{h}'" if verbose
         wf.delete_tag(h, t)
       end
     end
@@ -125,6 +134,7 @@ class Wavefront::Cli::Sources < Wavefront::Cli
   end
 
   def display_data(result, method)
+    return if noop
     if out_format == 'human'
       puts public_send('humanize_' + method, result)
     elsif out_format == 'json'
@@ -146,7 +156,7 @@ class Wavefront::Cli::Sources < Wavefront::Cli
       if options[:tagged]
         skip = false
         options[:tagged].each do |t|
-          unless s['userTags'].include?(t)
+          unless s.key?('userTags') && s['userTags'].include?(t)
             skip = true
             break
           end

data/lib/wavefront/cli/ts.rb

@@ -55,8 +55,16 @@ class Wavefront::Cli::Ts < Wavefront::Cli
       options[:end_time] = Time.at(parse_time(@options[:end]))
     end
 
-    wave = Wavefront::Client.new(@options[:token], @options[:endpoint], @options[:debug])
+    wave = Wavefront::Client.new(@options[:token], @options[:endpoint], @options[:debug], { noop: @options[:noop], verbose: @options[:verbose]})
+
+    if noop
+      wave.query(query, granularity, options)
+      return
+    end
+
     case options[:response_format]
+    when :json
+      pp wave.query(query, granularity, options)
     when :raw
       puts wave.query(query, granularity, options)
     when :graphite

data/lib/wavefront/cli/write.rb

@@ -12,6 +12,13 @@ class Wavefront::Cli::Write < Wavefront::Cli
   include Wavefront::Constants
   include Wavefront::Mixins
 
+  def validate_opts
+    #
+    # Unlike all the API methods, we don't need a token here
+    #
+    abort 'Please supply a proxy endpoint.' unless options[:proxy]
+  end
+
   def run
     valid_value?(options[:'<value>'])
     valid_metric?(options[:'<metric>'])

data/lib/wavefront/client.rb

@@ -28,16 +28,17 @@ module Wavefront
     include Wavefront::Constants
     DEFAULT_PATH = '/chart/api'
 
-    attr_reader :headers, :base_uri
+    attr_reader :headers, :base_uri, :noop, :verbose
 
-    def initialize(token, host=DEFAULT_HOST, debug=false)
+    def initialize(token, host=DEFAULT_HOST, debug=false, options = {})
+      @verbose = options[:verbose]
+      @noop = options[:noop]
       @headers = {'X-AUTH-TOKEN' => token}
       @base_uri = URI::HTTPS.build(:host => host, :path => DEFAULT_PATH)
       debug(debug)
     end
 
     def query(query, granularity='m', options={})
-
       options[:end_time] ||= Time.now.utc
       options[:start_time] ||= options[:end_time] - DEFAULT_PERIOD_SECONDS
       options[:response_format] ||= DEFAULT_FORMAT
@@ -48,7 +49,7 @@ module Wavefront
       [ options[:start_time], options[:end_time] ].each { |o| raise Wavefront::Exception::InvalidTimeFormat unless o.is_a?(Time) }
       raise Wavefront::Exception::InvalidGranularity unless GRANULARITIES.include?(granularity)
       raise Wavefront::Exception::InvalidResponseFormat unless FORMATS.include?(options[:response_format])
-      raise InvalidPrefixLength unless options[:prefix_length].is_a?(Fixnum)
+      raise InvalidPrefixLength unless options[:prefix_length].is_a?(Integer)
 
       args = {:params =>
               {:q => query, :g => granularity, :n => 'Unknown',
@@ -62,11 +63,14 @@ module Wavefront
         args[:params].merge!(options[:passthru])
       end
 
+      puts "GET #{@base_uri.to_s}\nPARAMS #{args.to_s}" if (verbose || noop)
+
+      return if noop
+
       response = RestClient.get @base_uri.to_s, args
 
       klass = Object.const_get('Wavefront').const_get('Response').const_get(options[:response_format].to_s.capitalize)
       return klass.new(response, options)
-
     end
 
     private