wavefront-cli 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78c82e2fafc2ac41fd155095a99fbc63b33b377296aa67ee1f0ed1cb3252c46
-  data.tar.gz: 2ef97b05806363fd93fc72068af3f662d1eb6c5828a2a319d429844f8e717e6e
+  metadata.gz: c9007cbf188f6962a31b04002c5b64c86e85bbc2ddad05e5299647706970ad65
+  data.tar.gz: 6b5daf8e04b6d5090837620f51dc9e1b5ce3c9d45227fe66d118a2adb94e758b
 SHA512:
-  metadata.gz: f7646c92517c80068758780b69b01e385ff7de1bf62efb49003240a60a33af4b85a5c3d220a78f1573588bbe53e7d3236d7ef00741b17d3db033dc848f14f0cb
-  data.tar.gz: 21566d131e3064522a1583c3ae44b57b38b277b521edb5336d8d58cfed606e673fe3b9f7d4036882a7a314db60a1726f4204aed08c1152dea181c00ac64d5837
+  metadata.gz: c224961d3690bed9d069d689d632c726262342ad4cc278b1942d4e70cc54a4263e0d89eda027b156cd93fde9184db04f831f75cbad3fe374f5a45f3eb7f30769
+  data.tar.gz: 2b20581ec22ae10242eea44ff07862b43eeb5bac057774b56aa6f3a363379298dbaca416859d1c274770edb376fe4bf3f85484876e16db23a475c457b850ac1b

data/HISTORY.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.13.0 (11/12/2018)
+* Add CSV output for `query` command.
+* Add multiple format outputs for all applicable `alert`
+  subcommands.
+* Add `queries` subcommand for `alert` and `dashboard` subcommands,
+  to quickly see which queries (and therefore timeseries) are being
+  used.
+
 ## 2.12.0 (26/11/2018)
 * Support SDK's new `unix` writer, which lets you write points to a
   local Unix datagram socket. This requires `-u unix` and `-S

data/lib/wavefront-cli/alert.rb

@@ -54,6 +54,12 @@ module WavefrontCli
       in_state(:firing)
     end
 
+    def do_queries
+      wf.list(0, :all).tap do |r|
+        r.response.items.map! { |a| { id: a.id, condition: a.condition } }
+      end
+    end
+
     # How many alerts are in the given state? If none, say so,
     # rather than just printing nothing.
     #

data/lib/wavefront-cli/commands/alert.rb

@@ -9,8 +9,8 @@ class WavefrontCommandAlert < WavefrontCommandBase
 
   def _commands
     ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
-     "firing #{CMN} [-o offset] [-L limit]",
-     "snoozed #{CMN} [-o offset] [-L limit]",
+     "firing #{CMN} [-f format] [-o offset] [-L limit]",
+     "snoozed #{CMN} [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] [-v version] <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
@@ -25,8 +25,9 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "tag clear #{CMN} <id>",
      "tag add #{CMN} <id> <tag>",
      "tag delete #{CMN} <id> <tag>",
-     "currently #{CMN} <state>",
-     "summary #{CMN} [-a]"]
+     "currently #{CMN} [-f format] <state>",
+     "queries #{CMN} [-f format] [-b]",
+     "summary #{CMN} [-f format] [-a]"]
   end
 
   def _options
@@ -37,6 +38,7 @@ class WavefrontCommandAlert < WavefrontCommandBase
      '-o, --offset=n           start from nth alert',
      '-L, --limit=COUNT        number of alerts to list',
      '-T, --time=SECONDS       how long to snooze (default 3600)',
+     '-b, --brief              do not show alert names',
      '-f, --format=STRING      output format']
   end
 end

data/lib/wavefront-cli/commands/dashboard.rb

@@ -16,6 +16,7 @@ class WavefrontCommandDashboard < WavefrontCommandBase
      "undelete #{CMN} <id>",
      "history #{CMN} [-f format] [-o offset] [-L limit] <id>",
      "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
+     "queries #{CMN} [-f format] [-b]",
      tag_commands]
   end
 
@@ -26,6 +27,7 @@ class WavefrontCommandDashboard < WavefrontCommandBase
      '-o, --offset=n           start list from nth dashboard or revision',
      '-L, --limit=COUNT        number of dashboards or revisions to list',
      '-v, --version=INTEGER    version of dashboard',
+     '-b, --brief              do not show dashboard names',
      '-f, --format=STRING      output format']
   end
 end

data/lib/wavefront-cli/commands/query.rb

@@ -10,10 +10,11 @@ class WavefrontCommandQuery < WavefrontCommandBase
   def _commands
     ['aliases [-DV] [-c file] [-P profile]',
      "#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
-           '[-WikvO] [-S mode] [-N name] [-p points] <query>',
-     "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>",
+           '[-WikvO] [-S mode] [-N name] [-p points] [-F options] <query>',
+     "raw #{CMN} [-H host] [-s time] [-e time] [-f format] " \
+           '[-F options] <metric>',
      "run #{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
-           '[-WkivO] [-S mode] [-N name] [-p points] <alias>']
+           '[-F options] [-WkivO] [-S mode] [-N name] [-p points] <alias>']
   end
 
   def _options
@@ -31,6 +32,8 @@ class WavefrontCommandQuery < WavefrontCommandBase
      '-O, --obsolete            include metrics unreported for > 4 weeks',
      '-H, --host=STRING         host or source to query on',
      '-f, --format=STRING       output format',
+     '-F, --format-opts=STRING  comma-separated options to pass to ' \
+                                'output formatter',
      '-k, --nospark             do not show sparkline',
      '-W, --nowarn              do not show API warning messages']
   end
@@ -38,6 +41,9 @@ class WavefrontCommandQuery < WavefrontCommandBase
   def postscript
     'The query command has an additional output format. Using ' \
     "'-f wavefront' produces output suitable for feeding back into a " \
-    'proxy.'.cmd_fold(TW, 0)
+    "proxy. Other output formats are 'yaml', 'json', 'ruby', "\
+    "and 'csv'. CSV format options are 'header' (print column headers); " \
+    "'tagkeys' (print tags as key=value rather than value); and 'quote' " \
+    '(force quoting of every CSV element).'.cmd_fold(TW, 0)
   end
 end

data/lib/wavefront-cli/dashboard.rb

@@ -23,5 +23,36 @@ module WavefrontCli
     def do_history
       wf.history(options[:'<id>'])
     end
+
+    def do_queries
+      resp = wf.list(0, :all)
+
+      queries = resp.response.items.each_with_object({}) do |d, a|
+        a[d.id] = extract_values(d, 'query')
+      end
+
+      resp.tap { |r| r.response.items = queries }
+    end
+
+    # @param obj [Object] the thing to search
+    # @param key [String, Symbol] the key to search for
+    # @param aggr [Array] values of matched keys
+    # @return [Array]
+    #
+    def extract_values(obj, key, aggr = [])
+      if obj.is_a?(Hash)
+        obj.each_pair do |k, v|
+          if k == key && !v.to_s.empty?
+            aggr.<< v
+          else
+            extract_values(v, key, aggr)
+          end
+        end
+      elsif obj.is_a?(Array)
+        obj.each { |e| extract_values(e, key, aggr) }
+      end
+
+      aggr
+    end
   end
 end

data/lib/wavefront-cli/display/alert.rb

@@ -55,5 +55,13 @@ module WavefrontDisplay
       data.sort.each { |k, v| puts format("%-#{kw}s%s", k, v) }
     end
     # rubocop:enable Metrics/AbcSize
+
+    def do_queries
+      if options[:brief]
+        multicolumn(:condition)
+      else
+        multicolumn(:id, :condition)
+      end
+    end
   end
 end

data/lib/wavefront-cli/display/base.rb

@@ -220,6 +220,14 @@ module WavefrontDisplay
       end
     end
 
+    def do_queries
+      if options[:brief]
+        multicolumn(:condition)
+      else
+        multicolumn(:id, :condition)
+      end
+    end
+
     # Modify, in-place, the data structure to remove fields which
     # we deem not of interest to the user.
     #

data/lib/wavefront-cli/display/dashboard.rb

@@ -17,5 +17,14 @@ module WavefrontDisplay
       data[:sections] = data[:sections].map { |s| s[:name] }
       long_output
     end
+
+    def do_queries
+      if options[:brief]
+        @data = data.to_h.values.flatten.map { |q| { query: q } }
+        multicolumn(:query)
+      else
+        long_output
+      end
+    end
   end
 end

data/lib/wavefront-cli/display/printer/terse.rb

@@ -17,6 +17,7 @@ module WavefrontDisplayPrinter
     # @return [String] a Ruby format string for each line
     #
     def format_string
+      return '%s' if keys.length == 1
       lk = longest_keys
       keys.each_with_object('') { |k, out| out.<< "%-#{lk[k]}s  " }
     end

data/lib/wavefront-cli/output/csv.rb

@@ -0,0 +1,8 @@
+require_relative 'base'
+
+module WavefrontOutput
+  #
+  # Display query results in CSV format.
+  #
+  class Csv < Base; end
+end

data/lib/wavefront-cli/output/csv/base.rb

@@ -0,0 +1,18 @@
+module WavefrontCsvOutput
+  #
+  # Standard output template
+  #
+  class Base
+    attr_reader :resp, :options
+
+    def initialize(resp, options)
+      @resp        = resp
+      @options     = options
+      post_initialize if respond_to?(:post_initialize)
+    end
+
+    def run
+      puts _run
+    end
+  end
+end

data/lib/wavefront-cli/output/csv/query.rb

@@ -0,0 +1,117 @@
+require 'set'
+require_relative 'base'
+
+module WavefrontCsvOutput
+  #
+  # Display query results in CSV format.
+  #
+  # The following options are supported:
+  #  quote   -- puts all values in soft quotes
+  #  headers -- print CSV column headers
+  #  tagkeys -- normally point tag keys go in the header and values in
+  #             the CSV data. This option puts key=value in the CSV.
+  #
+  class Query < Base
+    attr_reader :columns, :formatopts, :headers, :data_map
+
+    def _run
+      csv_headers + csv_body
+    end
+
+    def post_initialize
+      @headers = []
+      @formatopts = extract_formatopts
+      @data_map    = options[:raw] ? raw_output : query_output
+      @columns     = all_keys.freeze
+    end
+
+    # @return [Array[Hash]] which goes in the @data_map
+    #
+    def raw_output
+      resp.each_with_object([]) do |point, a|
+        point[:points].each do |p|
+          a.<< csv_format(options[:'<metric>'],
+                          p[:value],
+                          p[:timestamp],
+                          options[:host],
+                          point[:tags])
+        end
+      end
+    end
+
+    # @return [Array[Hash]] which goes in the @data_map
+    #
+    def query_output
+      resp[:timeseries].each_with_object([]) do |ts, a|
+        ts[:data].each do |point|
+          a.<< csv_format(ts[:label],
+                          point[1],
+                          point[0],
+                          ts[:host],
+                          ts[:tags])
+        end
+      end
+    end
+
+    # @return [Array] unique list of all keys in an array of hashes
+    #
+    def all_keys(data = data_map)
+      data.each_with_object(Set.new) { |row, a| a.merge(row.keys) }.to_a
+    end
+
+    # @return [Array] single element of comma-separated CSV column
+    #   headers if requested, otherwise []
+    #
+    def csv_headers
+      return [] unless formatopts.include?('headers')
+      [columns.map { |c| csv_value(c) }.join(',')]
+    end
+
+    def csv_body
+      data_map.map { |r| map_row_to_csv(r) }
+    end
+
+    def map_row_to_csv(row)
+      columns.map { |col| csv_value(row[col]) }.join(',')
+    end
+
+    # Do escaping and quoting
+    #
+    def csv_value(value)
+      if (formatopts.include?('quote') || value =~ /[,\s"]/) &&
+         !value.to_s.empty?
+        quote_value(value)
+      else
+        value
+      end
+    end
+
+    def quote_value(value)
+      format('"%s"', value.to_s.gsub(/"/, '\"'))
+    end
+
+    # Turn a string of output options into an easy-to-query array
+    #
+    def extract_formatopts
+      options[:formatopts].nil? ? [] : options[:formatopts].split(',')
+    end
+
+    # Take the data describing a point, and turn it into a CSV row.
+    # Tags have their keys removed.
+    #
+    def csv_format(path, value, timestamp, source, tags = nil)
+      ret = { path:      path,
+              value:     value,
+              timestamp: timestamp,
+              source:    source }
+
+      ret.tap { |r| tags.each { |k, v| r[k.to_sym] = tag_val(k, v) } }
+    end
+
+    # We may be doing key=val or just val, depending on the formatter options
+    #
+    def tag_val(key, val)
+      formatopts.include?('tagkeys') ? format('%s=%s', key, val) : val
+    end
+  end
+end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.12.0'.freeze
+WF_CLI_VERSION = '2.13.0'.freeze

data/spec/wavefront-cli/output/csv/query_spec.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+require_relative '../../../spec_helper'
+require_relative '../../../../lib/wavefront-cli/output/csv/query'
+
+# Test CSV output
+#
+class WavefrontOutputCsvTest < MiniTest::Test
+  attr_reader :wfq, :wfr, :wfqq, :wfh, :wft
+
+  def setup
+    @wfq = WavefrontCsvOutput::Query.new(load_query_response, {})
+    @wfr = WavefrontCsvOutput::Query.new(
+      load_raw_query_response,
+      raw: true,
+      host: 'www-blue',
+      '<metric>': 'solaris.network.obytes64'
+    )
+    @wfqq = WavefrontCsvOutput::Query.new(load_query_response,
+                                          formatopts: 'quote')
+    @wfh = WavefrontCsvOutput::Query.new(load_query_response,
+                                         formatopts: 'headers')
+    @wft = WavefrontCsvOutput::Query.new(load_query_response,
+                                         formatopts: 'tagkeys')
+  end
+
+  def test_all_keys
+    assert_equal(%i[a b c d e],
+                 wfq.all_keys([{ a: 1, b: 2 }, { a: 3, c: 3 },
+                               { d: 4, e: 5 }, { a: 1 }]))
+  end
+
+  def test_csv_value
+    assert_equal('word', wfq.csv_value('word'))
+    assert_equal('"word"', wfqq.csv_value('word'))
+    assert_equal('"7\" single"', wfq.quote_value('7" single'))
+    assert_equal('"7\" single"', wfqq.quote_value('7" single'))
+    assert_equal('"two words"', wfq.quote_value('two words'))
+    assert_equal('"two words"', wfqq.quote_value('two words'))
+    assert_equal('"a, b"', wfq.quote_value('a, b'))
+    assert_equal('"a, b"', wfqq.quote_value('a, b'))
+  end
+
+  def test_quote_value
+    assert_equal('"word"', wfq.quote_value('word'))
+    assert_equal('"1"', wfr.quote_value(1))
+    assert_equal('"two words"', wft.quote_value('two words'))
+    assert_equal('"7\" single"', wfh.quote_value('7" single'))
+  end
+
+  def test_csv_headers
+    assert_empty(wfq.csv_headers)
+    wfh = WavefrontCsvOutput::Query.new(load_query_response,
+                                        formatopts: 'headers')
+    assert_equal(['path,value,timestamp,source,colour,environment,' \
+                  'product,role,nic,platform,dc'], wfh.csv_headers)
+  end
+
+  def test_map_row_to_csv
+    assert_equal(',,,,,,,,,,', wfq.map_row_to_csv(merp: 1))
+    assert_equal('test.path,1,1544529523,testsource,,"unit test",,,,,',
+                 wfq.map_row_to_csv(path:        'test.path',
+                                    value:       1,
+                                    timestamp:   1_544_529_523,
+                                    source:      'testsource',
+                                    environment: 'unit test'))
+    assert_equal('"test.path","1","1544529523","testsource",,"unit test",,,,,',
+                 wfqq.map_row_to_csv(path:        'test.path',
+                                     value:       1,
+                                     timestamp:   1_544_529_523,
+                                     source:      'testsource',
+                                     environment: 'unit test'))
+  end
+
+  def test_csv_format
+    assert_equal({ path:        'test.path',
+                   value:       1,
+                   timestamp:   1_544_529_523,
+                   source:      'testsource',
+                   environment: 'test',
+                   dc:          'travis' },
+                 wfq.csv_format('test.path', 1, 1_544_529_523, 'testsource',
+                                environment: 'test', dc: 'travis'))
+
+    assert_equal({ path:        'test.path',
+                   value:       1,
+                   timestamp:   1_544_529_523,
+                   source:      'testsource',
+                   environment: 'environment=test',
+                   dc:          'dc=travis' },
+                 wft.csv_format('test.path', 1, 1_544_529_523, 'testsource',
+                                environment: 'test', dc: 'travis'))
+  end
+
+  def test_tag_val
+    assert_equal('value', wfq.tag_val('key', 'value'))
+    assert_equal('value', wfr.tag_val('key', 'value'))
+    assert_equal('key=value', wft.tag_val('key', 'value'))
+    assert_equal('key=value', wft.tag_val(:key, :value))
+  end
+
+  def test__run_query
+    out_q = wfq._run
+    assert_equal(
+      'solaris.network.obytes64,20910.38968253968,1533679200,' \
+      'wavefront-blue,blue,production,websites,wavefront-proxy,net0,' \
+      'JPC-triton,eu-ams-1', out_q.first
+    )
+    assert_equal(24, out_q.size)
+    check_csv_output(out_q)
+
+    out_h = wfh._run
+    assert_equal(
+      'path,value,timestamp,source,colour,environment,product,role,' \
+      'nic,platform,dc', out_h.first
+    )
+    assert_equal(
+      'solaris.network.obytes64,20910.38968253968,1533679200,' \
+      'wavefront-blue,blue,production,websites,wavefront-proxy,net0,' \
+      'JPC-triton,eu-ams-1', out_h[1]
+    )
+    assert_equal(25, out_h.size)
+
+    out_t = wft._run
+    assert_equal(
+      'solaris.network.obytes64,20910.38968253968,1533679200,' \
+      'wavefront-blue,colour=blue,environment=production,product=websites,' \
+      'role=wavefront-proxy,nic=net0,' \
+      'platform=JPC-triton,dc=eu-ams-1', out_t.first
+    )
+    assert_equal(24, out_t.size)
+    check_csv_output(out_q)
+  end
+
+  def test__run_raw
+    check_csv_output(wfq._run)
+  end
+
+  def check_csv_output(out)
+    out.each do |l|
+      c = l.split(',', 5)
+      assert_equal(c[0], 'solaris.network.obytes64')
+      assert_match(/^[\d\.]+$/, c[1])
+      # query returns epoch s timestamp, raw returns epoch ms
+      assert_match(/^\d+$/, c[2])
+      assert(c[2].size == 10 || c[2].size == 13)
+      assert(c[3] =~ /.*blue$/)
+    end
+  end
+end

data/spec/wavefront-cli/output/csv_spec.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-cli/output/csv'
+
+# Test the CSV instantiation of the base class
+#
+class CsvOutputBaseTest < MiniTest::Test
+  attr_reader :wfo
+
+  def setup
+    @wfo = WavefrontOutput::Csv.new(load_query_response, class: 'query')
+  end
+
+  def test_my_format
+    assert('csv', wfo.my_format)
+  end
+
+  def test_command_class_name
+    assert_equal('WavefrontCsvOutput::Query', wfo.command_class_name)
+  end
+
+  def test_command_file
+    assert_equal('csv/query', wfo.command_file)
+  end
+
+  def test_command_class
+    supported_commands = %w[query]
+
+    supported_commands.each do |cmd|
+      wfo = WavefrontOutput::Csv.new(load_query_response, class: cmd)
+      klass = wfo.command_class
+      assert_equal("WavefrontCsvOutput::#{cmd.capitalize}",
+                   klass.class.name)
+      assert klass.respond_to?(:run)
+    end
+
+    (CMDS - supported_commands).each do |cmd|
+      wfo = WavefrontOutput::Csv.new(load_query_response, class: cmd)
+      assert_raises(LoadError) { wfo.command_class }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -230,6 +230,9 @@ files:
 - lib/wavefront-cli/notificant.rb
 - lib/wavefront-cli/opt_handler.rb
 - lib/wavefront-cli/output/base.rb
+- lib/wavefront-cli/output/csv.rb
+- lib/wavefront-cli/output/csv/base.rb
+- lib/wavefront-cli/output/csv/query.rb
 - lib/wavefront-cli/output/hcl.rb
 - lib/wavefront-cli/output/hcl/alert.rb
 - lib/wavefront-cli/output/hcl/base.rb
@@ -288,6 +291,8 @@ files:
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
 - spec/wavefront-cli/opt_handler_spec.rb
+- spec/wavefront-cli/output/csv/query_spec.rb
+- spec/wavefront-cli/output/csv_spec.rb
 - spec/wavefront-cli/output/hcl_spec.rb
 - spec/wavefront-cli/output/json_spec.rb
 - spec/wavefront-cli/output/ruby_spec.rb
@@ -366,6 +371,8 @@ test_files:
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
 - spec/wavefront-cli/opt_handler_spec.rb
+- spec/wavefront-cli/output/csv/query_spec.rb
+- spec/wavefront-cli/output/csv_spec.rb
 - spec/wavefront-cli/output/hcl_spec.rb
 - spec/wavefront-cli/output/json_spec.rb
 - spec/wavefront-cli/output/ruby_spec.rb