wavefront-cli 2.9.4 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e2d1e86b7889da1db692a783bab9f5cef73d244cbfc1e5fe22ac7140d34bdd
-  data.tar.gz: ffba1e5d56717720094a76db34f06462d7a8421c20f6e45324f69c24b32c4421
+  metadata.gz: d12064132ca2cdf1520ff601c8ad3797adfcf0adf306f258bf27e7cf596748f0
+  data.tar.gz: 57e656c7b47e5c477e1b7ff3efd410b9aa659f83b00a3e730909fc36726d0079
 SHA512:
-  metadata.gz: 11a3ce1cbb5648bacc9ae6c8c06780ab52d7dd3f039d820ca9d30550bc4e7f7b90bd095e3f129f614ab6b0647d8075a9e96fad22c4c1f4b3fd35fd825c765cbd
-  data.tar.gz: d4e1279e1b09979e8976af7fbd04e0f397e9b73b2cec1570a1afe018f4724c332c9515eddd624781b6c3cac0827422ab0b6d876d6daf5b110d8f4b469faab97a
+  metadata.gz: 07f9bd142969a90d45e604abc9ef64ce166bcddcc031115bdb8a2ea0db96d299f21b654e03ec0b1a237462d8ac785c6423d34c0436fb77be8b8b8596a62fc4fc
+  data.tar.gz: cd92759ebce2f7df4ba85d7340d0c6683a082bb7e46daae33191638164fb9417cce27f3a96924773f623338ab98c2befe85b9702f145c97991737797cedc2a35

data/.rubocop.yml

@@ -9,3 +9,5 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Max: 13
 
+Style/NumericLiterals:
+  Enabled: false

data/HISTORY.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 2.10.0
+* Most `list` subcommands accept `-a / --all`, and will show all
+  objects of the given type, with no pagination. (Exceptions are
+  `user`, which never paginated because the API doesn't, and
+  `source`, where the operation would take a prohibitively long
+  time.)
+* `search` operations also accept `-a / --all`.
+* Add `window ongoing` subcommand, to show currently open
+  maintenance windows.
+* Add `window pending` subcommand, to show upcoming
+  maintenance windows. Defaults to windows in the next 24 hours, but
+  takes a decimal hour as an argument.
+* Add `alert currently <state>` subcommand to list all alerts in any
+  allowable state.
+* Use version 2 of [wavefront-sdk](https://github.com/snltd/wavefront-sdk).
+* Write
+  [distributions](https://docs.wavefront.com/proxies_histograms.html)
+  to a proxy. Distributions can be specified singly, or streamed
+  from a file. Please see [this
+  page](https://sysdef.xyz/post/2018-04-08-wavefront-writer) for
+  more information.
+* Add `-u / --using` option to `write` command. This lets you send
+  points to proxies using alternate transport methods. At the moment
+  only `-u http` is supported, but other mechanisms will be added as
+  they are made available by Wavefront.
+* Display local times by default, in the same way as the UI.
+* Improve quality of `--verbose` output when writing points.
+* Improved usage error messages.
+* Use a single connection when streaming data to a proxy from STDIN.
+* Don't list hidden sources unless specifically asked.
+
 ## 2.9.3 (03/09/2018)
 * Fix a bug where indefinitely snoozed alerts broke `wf alert
   snoozed`.
@@ -29,17 +60,14 @@
   better, more flexible way.
 
 ## 2.7.0 (04/07/2018)
-
 * Add a `-i` option to the `report` command, to send delta metrics.
 * Fix delta metrics on the `write` command.
 
 ## 2.6.0 (27/06/2018)
-
 * Anything which can be imported can be imported from STDIN. The CLI
   will do its best to work out if the format is YAML or JSON.
 
 ## 2.5.0 (25/06/2018)
-
 * Support [derived
   metrics](https://docs.wavefront.com/derived_metrics.html).
 * Remove options which were not actually supported.
@@ -50,7 +78,6 @@
 * Remove obsolete code and test files.
 
 ## 2.4.0 (10/04/2017)
-
 * Support direct data ingestion via `report` command.
 * Support writing delta metrics.
 * Add `-q` to silenty write data points.
@@ -60,31 +87,24 @@
   provider](https://github.com/spaceapegames/terraform-provider-wavefront).
 
 ## 2.3.1 (24/03/2017)
-
 * Fix broken handling of negative values in `write` command.
 
 ## 2.3.0 (23/02/2017)
-
 * Add query aliases.
 
 ## 2.2.0 (18/02/2017)
-
 * Add `alert firing` and `alert snoozed` subcommands.
 
 ## 2.1.6 (11/01/2017)
-
 * Correctly handle `=` characters in `update` subcommands.
 
 ## 2.1.5 (05/12/2017)
-
 * Allow the user to tag events when they are created.
 
 ## 2.1.4 (15/11/2017)
-
 * `event create` bugfix.
 
 ## 2.1.3 (31/10/2017)
-
 * Use credential mechanism from SDK instead of rolling our own.
 * Fix bug which ignored supposedly supported environment variables,
   and add support for more.
@@ -92,38 +112,30 @@
 * Eradicate build warnings.
 
 ## 2.1.2 (31/10/2017)
-
 * Fix no-op bug.
 * Add BSD license.
 
 ## 2.1.1 (12/10/2017)
-
 * Fix bug in relative time specifications.
 
 ## 2.1.0 (12/10/2017)
-
 * Allow users to specify relative times, like `-10m`.
 
 ## 2.0.0 (09/10/2017)
-
 * Support viewing and managing of integrations.
 * Support notificants. (AKA alert targets).
 * Support new source descriptions.
 * Breaking change in `source` command.
 
 ## 1.0.3 (25/08/2017)
-
 * Fix nil tag bug in terse source listing.
 
 ## 1.0.2 (04/08/2017)
-
 * Greatly improve support for maintenance windows. They can now be
   extended, shrunk, and closed and created on the fly.
 
 ## 1.0.1 (31/07/2017)
-
 * Report `no data` if a query returns no data.
 
 ## 1.0.0 (28/07/2017)
-
 * First official release.

data/lib/wavefront-cli/alert.rb

@@ -36,15 +36,35 @@ module WavefrontCli
       wf.history(options[:'<id>'], options[:offset], options[:limit])
     end
 
+    def do_currently
+      state = options[:'<state>'].to_s
+
+      if wf.respond_to?(state)
+        in_state(state)
+      else
+        abort format("'%s' is not a valid alert state.", state)
+      end
+    end
+
     def do_firing
-      find_in_state(:firing)
+      in_state(:firing)
     end
 
     def do_snoozed
-      find_in_state(:snoozed)
+      in_state(:firing)
+    end
+
+    # How many alerts are in the given state? If none, say so,
+    # rather than just printing nothing.
+    #
+    def in_state(status)
+      options[:all] = true
+      ret = find_in_state(status)
+      ok_exit(format('No alerts are currently %s.', status)) if ret.empty?
+      ret
     end
 
-    # Does the work for #do_firing() and #do_snoozed()
+    # Does the work for #in_state
     # @param status [Symbol,String] the alert status you wish to
     #   find
     # @return Wavefront::Response

data/lib/wavefront-cli/base.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 require 'json'
 require 'wavefront-sdk/validators'
+require_relative 'constants'
 require_relative 'exception'
 
 module WavefrontCli
@@ -22,10 +23,11 @@ module WavefrontCli
     attr_accessor :wf, :options, :klass, :klass_word
 
     include Wavefront::Validators
+    include WavefrontCli::Constants
 
     def initialize(options)
       @options = options
-      sdk_class = self.class.name.sub(/Cli/, '')
+      sdk_class = _sdk_class
       @klass_word = sdk_class.split('::').last.downcase
       validate_input
 
@@ -37,6 +39,13 @@ module WavefrontCli
       send(:post_initialize, options) if respond_to?(:post_initialize)
     end
 
+    # Normally we map the class name to a similar one in the SDK.
+    # Overriding his method lets you map to something else.
+    #
+    def _sdk_class
+      self.class.name.sub(/Cli/, '')
+    end
+
     # Some subcommands don't make an API call, so they don't return
     # a Wavefront::Response object. You can override this method
     # with something which returns an array of methods like that.
@@ -50,7 +59,13 @@ module WavefrontCli
     end
 
     def options_and_exit
-      puts options
+      ok_exit(options)
+    end
+
+    # Print a message and exit 0
+    #
+    def ok_exit(message)
+      puts message
       exit 0
     end
 
@@ -113,9 +128,12 @@ module WavefrontCli
     # @return [Hash] containing `debug`, `verbose`, and `noop`.
     #
     def mk_opts
-      { debug:   options[:debug],
-        verbose: options[:verbose],
-        noop:    options[:noop] }
+      ret = { debug:   options[:debug],
+              verbose: options[:verbose],
+              noop:    options[:noop] }
+
+      ret.merge!(extra_options) if respond_to?(:extra_options)
+      ret
     end
 
     # To allow a user to default to different output formats for
@@ -334,6 +352,7 @@ module WavefrontCli
     # harm inheriting unneeded things. Some classes override them.
     #
     def do_list
+      return wf.list(ALL_PAGE_SIZE, :all) if options[:all]
       wf.list(options[:offset] || 0, options[:limit] || 100)
     end
 
@@ -374,12 +393,23 @@ module WavefrontCli
     def do_search(cond = options[:'<condition>'])
       require 'wavefront-sdk/search'
       wfs = Wavefront::Search.new(mk_creds, mk_opts)
-
       query = conds_to_query(cond)
+      wfs.search(search_key, query, range_hash)
+    end
+
+    # If the user has specified --all, override any limit and offset
+    # values
+    #
+    def range_hash
+      if options[:all]
+        limit  = :all
+        offset = ALL_PAGE_SIZE
+      else
+        limit  = options[:limit]
+        offset = options[:offset] || options[:cursor]
+      end
 
-      wfs.search(search_key, query, limit:  options[:limit],
-                                    offset: options[:offset] ||
-                                            options[:cursor])
+      { limit: limit, offset: offset }
     end
 
     # The search URI pattern doesn't always match the command name,

data/lib/wavefront-cli/base_write.rb

@@ -1,4 +1,4 @@
-require 'wavefront-sdk/mixins'
+require 'wavefront-sdk/support/mixins'
 require_relative 'base'
 
 module WavefrontCli
@@ -24,7 +24,8 @@ module WavefrontCli
     def send_point(point)
       call_write(point)
     rescue Wavefront::Exception::InvalidEndpoint
-      abort "could not speak to proxy #{options[:proxy]}:#{options[:port]}."
+      abort format("Could not connect to proxy '%s:%s'.",
+                   options[:proxy], options[:port])
     end
 
     def do_file
@@ -56,10 +57,15 @@ module WavefrontCli
       end
     end
 
-    # A wrapper which lets us send normal points or deltas
+    # A wrapper which lets us send normal points, deltas, or
+    # distributions
     #
-    def call_write(data)
-      options[:delta] ? wf.write_delta(data) : wf.write(data)
+    def call_write(data, openclose = true)
+      if options[:delta]
+        wf.write_delta(data, openclose)
+      else
+        wf.write(data, openclose)
+      end
     end
 
     # Read from standard in and stream points through an open
@@ -68,7 +74,7 @@ module WavefrontCli
     #
     def read_stdin
       open_connection
-      STDIN.each_line { |l| call_write(process_line(l.strip)) }
+      STDIN.each_line { |l| call_write(process_line(l.strip), false) }
       close_connection
     rescue SystemExit, Interrupt
       puts 'ctrl-c. Exiting.'
@@ -84,8 +90,28 @@ module WavefrontCli
     # raise Wavefront::Exception::InvalidValue if it's not a value
     #
     def extract_value(chunks)
-      v = chunks[fmt.index('v')]
-      v.to_f
+      if fmt.include?('v')
+        v = chunks[fmt.index('v')]
+        v.to_f
+      else
+        raw = chunks[fmt.index('d')].split(',')
+        xpanded = expand_dist(raw)
+        wf.mk_distribution(xpanded)
+      end
+    end
+
+    # We will let users write a distribution as '1 1 1' or '3x1' or
+    # even a mix of the two
+    #
+    def expand_dist(dist)
+      dist.map do |v|
+        if v.is_a?(String) && v.include?('x')
+          x, val = v.split('x', 2)
+          Array.new(x.to_i, val.to_f)
+        else
+          v.to_f
+        end
+      end.flatten
     end
 
     # Find and return the source in a chunked line of input.
@@ -146,6 +172,7 @@ module WavefrontCli
     #
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
     def process_line(line)
       return true if line.empty?
       chunks = line.split(/\s+/, fmt.length)
@@ -156,8 +183,9 @@ module WavefrontCli
                   tags:  line_tags(chunks),
                   value: extract_value(chunks) }
 
-        point[:ts]     = extract_ts(chunks)     if fmt.include?('t')
-        point[:source] = extract_source(chunks) if fmt.include?('s')
+        point[:ts]       = extract_ts(chunks)        if fmt.include?('t')
+        point[:source]   = extract_source(chunks)    if fmt.include?('s')
+        point[:interval] = options[:interval] || 'm' if fmt.include?('d')
       rescue TypeError
         raise(WavefrontCli::Exception::UnparseableInput,
               "could not process #{line}")
@@ -165,6 +193,7 @@ module WavefrontCli
 
       point
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/AbcSize
 
@@ -195,22 +224,37 @@ module WavefrontCli
       end
     end
 
-    # The format string must contain a 'v'. It must not contain
-    # anything other than 'm', 't', 'T', 's', or 'v', and the 'T',
-    # if there, must be at the end. No letter must appear more than
-    # once.
+    # The format string must contain values. They can be single
+    # values or distributions. So we must have 'v' xor 'd'. It must
+    # not contain anything other than 'm', 't', 'T', 's', 'd', or
+    # 'v', and the 'T', if there, must be at the end. No letter must
+    # appear more than once.
     #
     # @param fmt [String] format of input file
     #
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
     def valid_format?(fmt)
-      if fmt.include?('v') && fmt.match(/^[mstv]+T?$/) &&
-         fmt == fmt.split('').uniq.join
-        return true
-      end
+      err = if fmt.include?('v') && fmt.include?('d')
+              "'v' and 'd' are mutually exclusive"
+            elsif !fmt.include?('v') && !fmt.include?('d')
+              "format string must include 'v' or 'd'"
+            elsif !fmt.match(/^[dmstTv]+$/)
+              'unsupported field in format string'
+            elsif !fmt == fmt.split('').uniq.join
+              'repeated field in format string'
+            elsif fmt.include?('T') && !fmt.end_with?('T')
+              "if used, 'T' must come at end of format string"
+            end
 
-      raise(WavefrontCli::Exception::UnparseableInput,
-            'Invalid format string.')
+      return true if err.nil?
+
+      raise(WavefrontCli::Exception::UnparseableInput, err)
     end
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize
 
     # Make sure we have the right number of columns, according to
     # the format string. We want to take every precaution we can to
@@ -224,7 +268,8 @@ module WavefrontCli
       ncols = line.split.length
       return true if fmt.include?('T') && ncols >= fmt.length
       return true if ncols == fmt.length
-      raise WavefrontCli::Exception::UnparseableInput, 'wrong number of fields'
+      raise(WavefrontCli::Exception::UnparseableInput,
+            format('Expected %s fields, got %s', fmt.length, ncols))
     end
 
     # Although the SDK does value checking, we'll add another layer

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

@@ -8,7 +8,7 @@ class WavefrontCommandAlert < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "firing #{CMN} [-o offset] [-L limit]",
      "snoozed #{CMN} [-o offset] [-L limit]",
      "describe #{CMN} [-f format] [-v version] <id>",
@@ -19,12 +19,13 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "snooze #{CMN} [-T time] <id>",
      "update #{CMN} <key=value> <id>",
      "unsnooze #{CMN} <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
      "tags #{CMN} [-f format] <id>",
      "tag set #{CMN} <id> <tag>...",
      "tag clear #{CMN} <id>",
      "tag add #{CMN} <id> <tag>",
      "tag delete #{CMN} <id> <tag>",
+     "currently #{CMN} <state>",
      "summary #{CMN} [-a]"]
   end
 

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

@@ -16,17 +16,18 @@ class WavefrontCommandCloudintegration < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "import #{CMN} <file>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
      '-l, --long           list cloud integrations in detail',
+     '-a, --all            list all cloud integrations',
      '-o, --offset=n       start from nth cloud integration',
      '-L, --limit=COUNT    number of cloud integrations to list',
      '-f, --format=STRING  output format']

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

@@ -8,20 +8,21 @@ class WavefrontCommandDashboard < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] [-v version] <id>",
      "import #{CMN} [-f format] <file>",
      "update #{CMN} <key=value> <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "history #{CMN} [-f format] [-o offset] [-L limit] <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
      tag_commands]
   end
 
   def _options
     [common_options,
      '-l, --long               list dashboards in detail',
+     '-a, --all                list all dashboards',
      '-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',

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

@@ -16,7 +16,7 @@ class WavefrontCommandDerivedmetric < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] [-v version] <id>",
      "create #{CMN} [-d description] [-T tag...] [-O] [-i interval] " \
      '[-r range] <name> <query>',
@@ -25,13 +25,14 @@ class WavefrontCommandDerivedmetric < WavefrontCommandBase
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "history #{CMN} [-f format] [-o offset] [-L limit] <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
      tag_commands]
   end
 
   def _options
     [common_options,
      '-l, --long              list derived metrics in detail',
+     '-a, --all               list all derived metrics',
      '-o, --offset=n          start list from nth derived metrics or ' \
                               'revision',
      '-L, --limit=COUNT       number of derived metrics or revisions to ' \

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

@@ -8,19 +8,20 @@ class WavefrontCommandIntegration < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "install #{CMN} <id>",
      "uninstall #{CMN} <id>",
      "manifests #{CMN}",
      "status #{CMN} <id>",
      "statuses #{CMN}",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
      '-l, --long           list cloud integrations in detail',
+     '-a, --all            list all cloud integrations',
      '-o, --offset=n       start from nth cloud integration',
      '-L, --limit=COUNT    number of cloud integrations to list',
      '-f, --format=STRING  output format']

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

@@ -16,19 +16,20 @@ class WavefrontCommandLink < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "create #{CMN} [-m regex] [-s regex] [-p str=regex...] <name> " \
      '<description> <template>',
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
      '-l, --long               list external links in detail',
+     '-a, --all                list all external links',
      '-o, --offset=n           start from nth external link',
      '-L, --limit=COUNT        number of external link to list',
      '-m, --metric-regex=REGEX metric filter regular expression',

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

@@ -8,7 +8,7 @@ class WavefrontCommandMessage < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit] [-a]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "mark #{CMN} [-f format] <id>"]
   end
 

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

@@ -4,24 +4,25 @@ require_relative 'base'
 #
 class WavefrontCommandNotificant < WavefrontCommandBase
   def description
-    'view and manage Wavefront notification targets'
+    'view and manage Wavefront alert targets'
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "import #{CMN} <file>",
      "delete #{CMN} <id>",
      "test #{CMN} <id>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
-     '-l, --long                list proxies in detail',
-     '-o, --offset=n            start from nth proxy',
+     '-l, --long                list alert targets in detail',
+     '-a, --all                 list all alert targets',
+     '-o, --offset=n            start from nth alert target',
      '-f, --format=STRING       output format',
-     '-L, --limit=COUNT         number of proxies to list']
+     '-L, --limit=COUNT         number of alert targets to list']
   end
 end

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

@@ -8,17 +8,18 @@ class WavefrontCommandProxy < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "rename #{CMN} <id> <name>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
      '-l, --long                list proxies in detail',
+     '-a, --all                 list all proxies',
      '-o, --offset=n            start from nth proxy',
      '-f, --format=STRING       output format',
      '-L, --limit=COUNT         number of proxies to list']

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

@@ -16,16 +16,17 @@ class WavefrontCommandSavedsearch < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
      '-l, --long                list saved searches in detail',
+     '-a, --all                 list all saved searches',
      '-o, --offset=n            start from nth saved search',
      '-L, --limit=COUNT         number of saved searches to list',
      '-f, --format=STRING       output format']

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

@@ -8,17 +8,18 @@ class WavefrontCommandWebhook < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
     [common_options,
      '-l, --long                list webhooks in detail',
+     '-a, --all                 list all webhooks',
      '-o, --offset=n            start list from nth webhook',
      '-L, --limit=COUNT         number of webhooks to list',
      '-f, --format=STRING       output format']

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

@@ -16,7 +16,7 @@ class WavefrontCommandWindow < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
+    ["list #{CMN} [-al] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",
      "create #{CMN} -d reason [-s time] [-e time] " \
      '[-A alert_tag...] [-T host_tag...] [-H host...] <title>',
@@ -25,12 +25,15 @@ class WavefrontCommandWindow < WavefrontCommandBase
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>..."]
+     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
+     "ongoing #{CMN}",
+     "pending #{CMN} [<hours>]"]
   end
 
   def _options
     [common_options,
      '-l, --long           list maintenance windows in detail',
+     '-a, --all            list all maintenance windows',
      '-o, --offset=n       start from nth maintenance window',
      '-L, --limit=COUNT    number of maintenance windows to list',
      '-d, --desc=STRING    reason for maintenance window',

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

@@ -9,9 +9,12 @@ class WavefrontCommandWrite < WavefrontCommandBase
 
   def _commands
     ['point [-DnViq] [-c file] [-P profile] [-E proxy] [-t time] ' \
-     '[-p port] [-H host] [-T tag...] <metric> <value>',
+     '[-p port] [-H host] [-T tag...] [-u method] <metric> <value>',
+     'distribution [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
+     '[-p port] [-T tag...] [-u method] [-I interval] <metric> <val>...',
      'file [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
-     '[-p port] [-F infileformat] [-m metric] [-T tag...] <file>']
+     '[-p port] [-F infileformat] [-m metric] [-T tag...] [-I interval] ' \
+     '[-u method] <file>']
   end
 
   def _options
@@ -26,6 +29,8 @@ class WavefrontCommandWrite < WavefrontCommandBase
      'a file will be assigned. If the file contains a metric name, ' \
      'the two will be dot-concatenated, with this value first',
      '-i, --delta                increment metric by given value',
+     "-I, --interval=INTERVAL    interval of distribution (default 'm')",
+     '-u, --using=METHOD         method by which to send points',
      "-q, --quiet                don't report the points sent summary " \
      '(unless there were errors)']
   end
@@ -33,7 +38,9 @@ class WavefrontCommandWrite < WavefrontCommandBase
   def postscript
     'Files are whitespace separated, and fields can be defined ' \
     "with the '-F' option.  Use 't' for timestamp, 'm' for metric " \
-    "name, 'v' for value, 's' for source, and 'T' for tags. Put 'T' " \
-    'last.'.cmd_fold(TW, 0)
+    "name, 'v' for value, 's' for source, 'd' for a comma-separated " \
+    "distribution, and 'T' for tags. Put 'T' last.  Currently " \
+    "supported transport methods are 'socket' (the default) " \
+    "and 'http'.".cmd_fold(TW, 0)
   end
 end

data/lib/wavefront-cli/constants.rb

@@ -12,5 +12,10 @@ module WavefrontCli
       endpoint: 'metrics.wavefront.com',
       format:   :human
     }.freeze
+
+    # How many objects to get in each request when we are asked for
+    # --all
+    #
+    ALL_PAGE_SIZE = 999
   end
 end

data/lib/wavefront-cli/controller.rb

@@ -120,6 +120,8 @@ class WavefrontCliController
     abort "Host system error. #{e.message}"
   rescue WavefrontCli::Exception::UnsupportedOperation => e
     abort "Unsupported operation.\n#{e.message}"
+  rescue Wavefront::Exception::UnsupportedWriter => e
+    abort "Unsupported writer '#{e.message}'."
   rescue StandardError => e
     warn "general error: #{e}"
     warn "re-run with '-D' for stack trace." unless opts[:debug]

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

@@ -122,14 +122,11 @@ module WavefrontDisplay
     def pagination_line
       return unless raw.respond_to?(:moreItems) && raw.moreItems == true
 
-      if raw.respond_to?(:offset) && raw.respond_to?(:limit)
-        puts 'List shows paginated output. Use -o and -L for more.'
-        return
-      end
-
       enditem = raw.limit > 0 ? raw.offset + raw.limit - 1 : 0
       puts format('List shows items %d to %d. Use -o and -L for more.',
                   raw.offset, enditem)
+    rescue StandardError
+      puts 'List shows paginated output. Use -o and -L for more.'
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -277,7 +274,7 @@ module WavefrontDisplay
       # rubocop:disable Style/DateTime
       ret = DateTime.strptime(str, fmt).to_time
       # rubocop:enable Style/DateTime
-      ret = ret.utc if force_utc
+      ret = force_utc ? ret.utc : ret.localtime
       ret.strftime(out_fmt)
     end
 

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

@@ -0,0 +1,14 @@
+require_relative 'write'
+
+module WavefrontDisplay
+  # Format human-readable output when writing distributions
+  #
+  class Distribution < Write
+    # rubocop:disable Metrics/AbcSize
+    def do_distribution
+      report unless options[:quiet] || (data[:unsent] + data[:rejected] > 0)
+      exit(data.rejected.zero? && data.unsent.zero? ? 0 : 1)
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

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

@@ -2,7 +2,7 @@ require_relative 'base'
 
 module WavefrontDisplay
   #
-  # Format human-readable output for cloud integrations.
+  # Format human-readable output for integrations.
   #
   class Integration < Base
     def do_list_brief

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

@@ -15,5 +15,14 @@ module WavefrontDisplay
     def do_list_brief
       multicolumn(:id, :title)
     end
+
+    def do_pending
+      do_ongoing
+    end
+
+    def do_ongoing
+      readable_time_arr(:startTimeInSeconds, :endTimeInSeconds)
+      multicolumn(:id, :reason, :startTimeInSeconds, :endTimeInSeconds)
+    end
   end
 end

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

@@ -2,28 +2,39 @@ require_relative 'base'
 
 module WavefrontDisplay
   #
-  # Format human-readable output for webhooks.
+  # Format human-readable output for sources.
   #
   class Source < Base
     def do_list
-      drop_cluster_sources
+      massage_data
       long_output
     end
 
     def do_list_brief
-      drop_cluster_sources
+      massage_data
       multicolumn(:id, :description)
     end
 
+    def massage_data
+      return if options[:all]
+      drop_cluster_sources
+      drop_hidden_sources
+    end
+
     def do_search_brief
       multicolumn(:id)
     end
 
+    # Filter out any sources with 'hidden=true'
+    #
+    def drop_hidden_sources
+      data.delete_if { |k| k.tags['hidden'] == true }
+    end
+
     # Filter out the Wavefront cluster sources. Don't sort them, or
     # using offset and cursor becomes confusing.
     #
     def drop_cluster_sources
-      return if options[:all]
       data.delete_if { |k| k.id =~ /prod-[\da-f]{2}-/ }
     end
   end

data/lib/wavefront-cli/event.rb

@@ -1,6 +1,6 @@
 require 'fileutils'
 require 'open3'
-require 'wavefront-sdk/mixins'
+require 'wavefront-sdk/support/mixins'
 require_relative 'base'
 
 EVENT_STATE_DIR = Pathname.new('/var/tmp/wavefront')

data/lib/wavefront-cli/maintenancewindow.rb

@@ -1,4 +1,4 @@
-require 'wavefront-sdk/mixins'
+require 'wavefront-sdk/support/mixins'
 require_relative 'base'
 
 module WavefrontCli
@@ -81,5 +81,24 @@ module WavefrontCli
     def change_end_time(timestamp)
       wf.update(options[:'<id>'], endTimeInSeconds: timestamp)
     end
+
+    def do_ongoing
+      w = wf.ongoing
+      ok_exit('No maintenance windows currently ongoing.') if w.empty?
+      w
+    end
+
+    def do_pending
+      range = options[:'<hours>'].to_f
+      range = 24 unless range.positive?
+
+      w = wf.pending(range)
+
+      if w.empty?
+        ok_exit(format('No maintenance windows in the next %s hours.',
+                       range))
+      end
+      w
+    end
   end
 end

data/lib/wavefront-cli/query.rb

@@ -1,4 +1,4 @@
-require 'wavefront-sdk/mixins'
+require 'wavefront-sdk/support/mixins'
 require_relative 'base'
 
 module WavefrontCli

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.9.4'.freeze
+WF_CLI_VERSION = '2.10.0'.freeze

data/lib/wavefront-cli/write.rb

@@ -7,16 +7,62 @@ module WavefrontCli
   # speaks to a proxy rather than to the API.
   #
   class Write < BaseWrite
+    # rubocop:disable Metrics/AbcSize
+    def do_distribution
+      p = { path:     options[:'<metric>'],
+            interval: options[:interval] || 'M',
+            value:    mk_dist,
+            tags:     tags_to_hash(options[:tag]) }
+
+      p[:source] = options[:host] if options[:host]
+      p[:ts] = parse_time(options[:time]) if options[:time]
+      send_point(p)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Turn our user's representation of a distribution into one
+    # which suits Wavefront. The SDK can do this for us.
+    #
+    def mk_dist
+      xpanded = expand_dist(options[:'<val>'])
+      wf.mk_distribution(xpanded.map(&:to_f))
+    end
+
+    def extra_options
+      options[:using] ? { writer: options[:using] } : {}
+    end
+
+    # I chose to prioritise UI consistency over internal elegance
+    # here. The `write` command doesn't follow the age-old
+    # assumption that each command maps 1:1 to a similarly named SDK
+    # class. Write can use `write` or `distribution`.
+    #
+    def _sdk_class
+      return 'Wavefront::Distribution' if distribution?
+      'Wavefront::Write'
+    end
+
+    def distribution?
+      return true if options[:distribution]
+      options[:infileformat] && options[:infileformat].include?('d')
+    end
+
     def mk_creds
-      { proxy: options[:proxy], port: options[:port] || 2878 }
+      { proxy:    options[:proxy],
+        port:     options[:port] || default_port,
+        endpoint: options[:endpoint],
+        token:    options[:token] }
+    end
+
+    def default_port
+      distribution? ? 40000 : 2878
     end
 
     def validate_opts
       validate_opts_file if options[:file]
 
       return true if options[:proxy]
-      raise(WavefrontCli::Exception::CredentialError,
-            'Missing proxy address.')
+      raise(WavefrontCli::Exception::CredentialError, 'No proxy address.')
     end
 
     def validate_opts_file

data/spec/spec_helper.rb

@@ -55,7 +55,6 @@ end
 #  command
 # @param call [Hash]
 #
-# rubocop:disable Metrics/AbcSize
 def cmd_to_call(word, args, call, sdk_class = nil)
   headers = { 'Accept':          /.*/,
               'Accept-Encoding': /.*/,
@@ -89,10 +88,7 @@ def cmd_to_call(word, args, call, sdk_class = nil)
 
           require "wavefront-sdk/#{sdk_class.name.split('::').last.downcase}"
           Spy.on_instance_method(
-            Object.const_get(
-              "Wavefront::#{sdk_class.name.split('::').last}"
-            ),
-            :respond
+            Object.const_get('Wavefront::ApiCaller'), :respond
           ).and_return({})
 
           d = Spy.on_instance_method(sdk_class, :display)
@@ -105,7 +101,6 @@ def cmd_to_call(word, args, call, sdk_class = nil)
     end
   end
 end
-# rubocop:enable Metrics/AbcSize
 
 # Run a command we expect to fail, returning stdout and stderr
 #

data/spec/wavefront-cli/base_spec.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require_relative '../spec_helper'
-require_relative '../../lib/wavefront-cli/base'
+require_relative '../../lib/wavefront-cli/alert'
 require 'spy'
 require 'spy/integration'
 
@@ -26,21 +26,25 @@ DISP_DATA = {
   b: %w[list_1 list_2]
 }.freeze
 
-# Test base class
+# Since I tidied up the file layout in wavefront-sdk, there's no
+# longer a 1:1 mapping of CLI and SDK classes. wavefront-sdk/base is
+# now wavefront-sdk/core/api. The only thing that broke was the
+# tests in this class. Now we test the methods in the abstract base
+# class via an instantiation of a concrete class. I don't think any
+# of this matters.
 #
 class WavefrontCliBaseTest < MiniTest::Test
   attr_reader :wf, :wf_cmd
 
   def setup
-    @wf = WavefrontCli::Base.new(OPTS)
-    @wf_cmd = WavefrontCli::Base.new(OPTS_CMD)
-    wf_cmd.define_singleton_method(:do_test_cmd) { true }
+    @wf = WavefrontCli::Alert.new(OPTS)
   end
 
   def test_mk_creds
-    assert_equal wf.mk_creds, endpoint: 'test.wavefront.com',
-                              token:    '0123456789-ABCDEF',
-                              agent:    "wavefront-cli-#{WF_CLI_VERSION}"
+    assert_equal({ endpoint: 'test.wavefront.com',
+                   token:    '0123456789-ABCDEF',
+                   agent:    "wavefront-cli-#{WF_CLI_VERSION}" },
+                 wf.mk_creds)
   end
 
   def test_dispatch

data/spec/wavefront-cli/commands/write_spec.rb

@@ -12,6 +12,6 @@ class WavefrontCommmandWriteTest < WavefrontCommmandBaseTest
   def setup
     @wf = WavefrontCommandWrite.new
     @col_width = 25
-    @skip_cmd = /write (point|file)/
+    @skip_cmd = /write (point|file|distribution)/
   end
 end

data/spec/wavefront-cli/query_spec.rb

@@ -4,7 +4,7 @@ word = 'query'
 
 require_relative '../spec_helper'
 require_relative "../../lib/wavefront-cli/#{word}"
-require 'wavefront-sdk/mixins'
+require 'wavefront-sdk/support/mixins'
 # rubocop:disable Style/MixinUsage
 include Wavefront::Mixins
 # rubocop:enable Style/MixinUsage

data/spec/wavefront-cli/write_spec.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/wavefront-cli/write'
+
+# Test base writer
+#
+class WavefrontCliWriteTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = WavefrontCli::Write.new({})
+  end
+
+  def test_expand_dist
+    assert_equal(wf.expand_dist([1, 1, 1]), [1, 1, 1])
+    assert_equal(wf.expand_dist(['3x1']), [1, 1, 1])
+    assert_equal(wf.expand_dist(%w[3x1 1x4]), [1, 1, 1, 4])
+    assert_equal(wf.expand_dist([1, 1, 1, '2x2']).sort, [2, 2, 1, 1, 1].sort)
+  end
+end

data/wavefront-cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = %w[lib]
 
   gem.add_runtime_dependency 'docopt', '~> 0.6.0'
-  gem.add_runtime_dependency 'wavefront-sdk', '~> 1.6', '>= 1.6.2'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 2.0', '>= 2.0.1'
 
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.9.4
+  version: 2.10.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-22 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +200,7 @@ files:
 - lib/wavefront-cli/display/cloudintegration.rb
 - lib/wavefront-cli/display/dashboard.rb
 - lib/wavefront-cli/display/derivedmetric.rb
+- lib/wavefront-cli/display/distribution.rb
 - lib/wavefront-cli/display/event.rb
 - lib/wavefront-cli/display/externallink.rb
 - lib/wavefront-cli/display/integration.rb
@@ -303,6 +304,7 @@ files:
 - spec/wavefront-cli/stdlib/string_spec.rb
 - spec/wavefront-cli/user_spec.rb
 - spec/wavefront-cli/webhook_spec.rb
+- spec/wavefront-cli/write_spec.rb
 - wavefront-cli.gemspec
 homepage: https://github.com/snltd/wavefront-cli
 licenses:
@@ -380,3 +382,4 @@ test_files:
 - spec/wavefront-cli/stdlib/string_spec.rb
 - spec/wavefront-cli/user_spec.rb
 - spec/wavefront-cli/webhook_spec.rb
+- spec/wavefront-cli/write_spec.rb