wavefront-cli 6.0.0 → 8.0.1

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

@@ -8,6 +8,7 @@ class WavefrontCommandAlert < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "firing #{CMN} [-o offset] [-L limit]",
+     "affected #{CMN} hosts [<id>]",
      "snoozed #{CMN} [-o offset] [-L limit]",
      "describe #{CMN} [-v version] <id>",
      "delete #{CMN} <id>",

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

@@ -165,6 +165,6 @@ class WavefrontCommandBase
   # @return [String] a full options string which docopt understands
   #
   def docopt
-    commands + "\n\n" + options + "\n" + postscript
+    commands + "\n\n" + options + "\n\n" + postscript
   end
 end

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

@@ -26,7 +26,10 @@ class WavefrontCommandCloudintegration < WavefrontCommandBase
      "disable #{CMN} <id>",
      "dump #{CMN}",
      "import #{CMN} [-uU] <file>",
-     "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <condition>...",
+     "awsid #{CMN} generate",
+     "awsid #{CMN} delete <external_id>",
+     "awsid #{CMN} confirm <external_id>"]
   end
 
   def _options

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

@@ -10,7 +10,7 @@ class WavefrontCommandProxy < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+    ["list #{CMN} [-laA] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
@@ -23,6 +23,7 @@ class WavefrontCommandProxy < WavefrontCommandBase
     [common_options,
      "-l, --long                list #{things} in detail",
      "-a, --all                 list all #{things}",
+     "-A, --active              only show active #{things}",
      "-o, --offset=n            start from nth #{thing}",
      '-O, --fields=F1,F2,...    only show given fields',
      "-L, --limit=COUNT         number of #{things} to list"]

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

@@ -12,7 +12,7 @@ class WavefrontCommandQuery < WavefrontCommandBase
   def _commands
     ['aliases [-DV] [-c file] [-P profile]',
      "#{CMN} [-g granularity] [-s time] [-e time] " \
-           '[-WikvO] [-S mode] [-N name] [-p points] [-F options] <query>',
+           '[-ikvCGKOW] [-S mode] [-N name] [-p points] [-F options] <query>',
      "raw #{CMN} [-H host] [-s time] [-e time] " \
            '[-F options] <metric>',
      "run #{CMN} [-g granularity] [-s time] [-e time] " \
@@ -36,6 +36,9 @@ class WavefrontCommandQuery < WavefrontCommandBase
      '-F, --format-opts=STRING  comma-separated options to pass to ' \
                                 'output formatter',
      '-k, --nospark             do not show sparkline',
+     '-C, --nocache             do not use the query cache',
+     '-K, --nostrict            allow points outside the query window',
+     '-G, --histogram-view      use histogram view rather than metric',
      '-W, --nowarn              do not show API warning messages']
   end
 

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+# Define the 'role' command.
+#
+class WavefrontCommandRole < WavefrontCommandBase
+  def _commands
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
+     "create #{CMN} [-d description] [-p permission...] <name>",
+     "delete #{CMN} <id>",
+     "dump #{CMN}",
+     "import #{CMN} [-uU] <file>",
+     "set #{CMN} <key=value> <id>",
+     "accounts #{CMN} <id>",
+     "groups #{CMN} <id>",
+     "permissions #{CMN} <id>",
+     "give #{CMN} <id> to <member>...",
+     "take #{CMN} <id> from <member>...",
+     "grant #{CMN} <permission> to <id>",
+     "revoke #{CMN} <permission> from <id>",
+     "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <condition>..."]
+  end
+
+  def _options
+    [common_options,
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
+     "-L, --limit=COUNT        number of #{things} to list",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-u, --update             update an existing #{thing}",
+     "-U, --upsert             import new or update existing #{thing}",
+     "-d, --description=STRING description of #{thing}",
+     '-p, --permission=STRING  Wavefront permission']
+  end
+
+  def postscript
+    "A role 'member' can be an account ID or a usergroup ID. 'wf settings " \
+    "list permissions' will give you a list of all currently supported " \
+    'permissions.'.fold(TW, 0)
+  end
+end

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

@@ -34,9 +34,4 @@ class WavefrontCommandSpy < WavefrontCommandBase
      '-T, --tag-key=TAG        only show metrics with the given point tag key',
      '-y, --type=STRING        one of METRIC, SPAN, HOST, or STRING']
   end
-
-  def postscript
-    "\nNOTE: This command uses the unofficial 'spy' API endpoint, which " \
-      'is not guaranteed to remain stable.'.cmd_fold(TW, 0)
-  end
 end

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

@@ -24,17 +24,18 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
-     "create #{CMN} [-p permission...] <name>",
+     "create #{CMN} [-r role_id...] <name>",
      "delete #{CMN} <id>",
      "dump #{CMN}",
      "import #{CMN} [-uU] <file>",
      "set #{CMN} <key=value> <id>",
+     "add to #{CMN} <id> <user>...",
+     "remove from #{CMN} <id> <user>...",
      "users #{CMN} <id>",
+     "add role #{CMN} <id> <role>...",
+     "remove role #{CMN} <id> <role>...",
+     "roles #{CMN} <id>",
      "permissions #{CMN} <id>",
-     "add user #{CMN} <id> <user>...",
-     "remove user #{CMN} <id> <user>...",
-     "grant #{CMN} <permission> to <id>",
-     "revoke #{CMN} <permission> from <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <condition>..."]
   end
 
@@ -47,11 +48,6 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
      '-O, --fields=F1,F2,...   only show given fields',
      "-u, --update             update an existing #{thing}",
      "-U, --upsert             import new or update existing #{thing}",
-     '-p, --permission=STRING  Wavefront permission']
-  end
-
-  def postscript
-    "'wf settings list permissions' will give you a list of all " \
-    'currently supported permissions.'.fold(TW, 0)
+     '-r, --role-id=STRING     Wavefront role ID']
   end
 end

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

@@ -18,7 +18,9 @@ class WavefrontCommandWrite < WavefrontCommandBase
      '<metric> [--] <val>...',
      'file [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
      '[-p port] [-F infileformat] [-m metric] [-T tag...] [-I interval] ' \
-     '[-u method] [-S socket] <file>']
+     '[-u method] [-S socket] <file>',
+     'noise [-DnViq] [-P profile] [-E proxy] [-H host] [-p port] ' \
+     '[-T tag...] [-I interval] [-x value] [-X value] <metric>']
   end
 
   def _options
@@ -33,9 +35,12 @@ 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')",
+     "-I, --interval=INTERVAL    interval of distribution (default 'm'), or " \
+     'time in seconds between noise values (default 1)',
      '-u, --using=METHOD         method by which to send points',
      '-S, --socket=FILE          Unix datagram socket',
+     '-x, --min=NUMERIC          lower bound of random values (default -10)',
+     '-X, --max=NUMERIC          upper bound of random values (default 10)',
      "-q, --quiet                don't report the points sent summary " \
      '(unless there were errors)']
   end

data/lib/wavefront-cli/config.rb

@@ -36,11 +36,13 @@ module WavefrontCli
 
     RX = /^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/.freeze
 
+    # rubocop:disable Lint/MissingSuper
     def initialize(options)
       @options = options
       @config_file = _config_file
       @profile = options[:'<profile>'] || 'default'
     end
+    # rubocop:enable Lint/MissingSuper
 
     def do_location
       puts config_file
@@ -144,7 +146,7 @@ module WavefrontCli
     # catch a ctrl-d
     #
     def read_input
-      STDIN.gets.strip
+      $stdin.gets.strip
     rescue NoMethodError
       abort "\nInput aborted at user request."
     end

data/lib/wavefront-cli/controller.rb

@@ -17,6 +17,7 @@ require_relative 'version'
 require_relative 'constants'
 require_relative 'exception'
 require_relative 'opt_handler'
+require_relative 'exception_handler'
 require_relative 'stdlib/string'
 
 CMD_DIR = Pathname.new(__dir__) + 'commands'
@@ -28,6 +29,7 @@ class WavefrontCliController
   attr_reader :args, :usage, :opts, :cmds, :tw
 
   include WavefrontCli::Constants
+  include WavefrontCli::ExceptionMixins
 
   def initialize(args)
     @args = args
@@ -107,12 +109,8 @@ class WavefrontCliController
   #
   def cli_class(cmd, opts)
     load_cli_class(cmd, opts)
-  rescue WavefrontCli::Exception::UnhandledCommand
-    abort 'Fatal error. Unsupported command. Please open a Github issue.'
-  rescue WavefrontCli::Exception::InvalidInput => e
-    abort "Invalid input. #{e.message}"
-  rescue RuntimeError => e
-    abort "Unable to run command. #{e.message}."
+  rescue StandardError => e
+    exception_handler(e)
   end
 
   def load_cli_class(cmd, opts)
@@ -120,68 +118,12 @@ class WavefrontCliController
     Object.const_get('WavefrontCli').const_get(cmds[cmd].sdk_class).new(opts)
   end
 
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
   def run_command(cli_class_obj)
     cli_class_obj.validate_opts
     cli_class_obj.run
-  rescue Interrupt
-    abort "\nOperation aborted at user request."
-  rescue WavefrontCli::Exception::ConfigFileNotFound => e
-    abort "Configuration file #{e}' not found."
-  rescue WavefrontCli::Exception::CredentialError => e
-    handle_missing_credentials(e)
-  rescue WavefrontCli::Exception::MandatoryValue
-    abort 'A value must be supplied.'
-  rescue Wavefront::Exception::NetworkTimeout
-    abort 'Connection timed out.'
-  rescue Wavefront::Exception::InvalidPermission => e
-    abort "'#{e}' is not a valid privilege."
-  rescue Wavefront::Exception::InvalidUserGroupId => e
-    abort "'#{e}' is not a valid user group id."
-  rescue WavefrontCli::Exception::InvalidValue => e
-    abort "Invalid value for #{e}."
-  rescue WavefrontCli::Exception::ProfileExists => e
-    abort "Profile '#{e}' already exists."
-  rescue WavefrontCli::Exception::ProfileNotFound => e
-    abort "Profile '#{e}' not found."
-  rescue WavefrontCli::Exception::FileNotFound
-    abort 'File not found.'
-  rescue WavefrontCli::Exception::InsufficientData => e
-    abort "Insufficient data. #{e.message}"
-  rescue WavefrontCli::Exception::InvalidQuery => e
-    abort "Invalid query. API message: '#{e.message}'."
-  rescue WavefrontCli::Exception::SystemError => e
-    abort "Host system error. #{e.message}"
-  rescue WavefrontCli::Exception::UnparseableInput => e
-    abort "Cannot parse input. #{e.message}"
-  rescue WavefrontCli::Exception::UnparseableSearchPattern
-    abort 'Searches require a key, a value, and a match operator.'
-  rescue WavefrontCli::Exception::UnsupportedFileFormat
-    abort 'Unsupported file format.'
-  rescue WavefrontCli::Exception::UnsupportedOperation => e
-    abort "Unsupported operation.\n#{e.message}"
-  rescue WavefrontCli::Exception::UnsupportedOutput => e
-    abort e.message
-  rescue WavefrontCli::Exception::UnsupportedNoop
-    abort 'Multiple API call operations cannot be performed as no-ops.'
-  rescue WavefrontCli::Exception::UserGroupNotFound => e
-    abort "Cannot find user group '#{e.message}'."
-  rescue Wavefront::Exception::UnsupportedWriter => e
-    abort "Unsupported writer '#{e.message}'."
-  rescue WavefrontCli::Exception::UserError => e
-    abort "User error: #{e.message}."
-  rescue WavefrontCli::Exception::ImpossibleSearch
-    abort 'Search on non-existent key. Please use a top-level field.'
-  rescue Wavefront::Exception::InvalidSamplingValue
-    abort 'Sampling rates must be between 0 and 0.05.'
   rescue StandardError => e
-    warn "general error: #{e}"
-    backtrace_message(e)
-    abort
+    exception_handler(e)
   end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
 
   def backtrace_message(err)
     if opts[:debug]
@@ -235,8 +177,6 @@ class WavefrontCliController
   # return [Hash] h with modified keys
   #
   def sanitize_keys(options)
-    options.each_with_object({}) do |(k, v), r|
-      r[k.to_s.delete('-').to_sym] = v
-    end
+    options.transform_keys { |k| k.to_s.delete('-').to_sym }
   end
 end

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WavefrontDisplay
+  #
+  # Format human-readable output for account management.
+  #
+  class Account < Base
+    def do_list_brief
+      filter_user_list
+      puts(data.map { |account| account[:identifier] })
+    end
+
+    def do_list
+      filter_user_list
+      super
+    end
+
+    def do_role_add_to
+      puts format("Gave %<quoted_roles>s to '%<id>s'.",
+                  id: options[:'<id>'],
+                  quoted_roles: quoted(options[:'<role>']))
+    end
+
+    def do_role_remove_from
+      puts format("Removed %<quoted_roles>s from '%<id>s'.",
+                  id: options[:'<id>'],
+                  quoted_roles: quoted(options[:'<role>']))
+    end
+
+    def do_roles
+      roles = data.fetch(:roles, [])
+      puts roles.empty? ? "'#{options[:'<id>']}' has no roles." : roles
+    end
+
+    def do_group_add_to
+      puts format("Added '%<id>s' to %<quoted_group>s.",
+                  id: options[:'<id>'],
+                  quoted_group: quoted(options[:'<group>']))
+    end
+
+    def do_group_remove_from
+      puts format("Removed '%<id>s' from %<quoted_group>s.",
+                  id: options[:'<id>'],
+                  quoted_group: quoted(options[:'<group>']))
+    end
+
+    def do_groups
+      groups = data.fetch(:userGroups, [])
+
+      if groups.empty?
+        puts "'#{options[:'<id>']}' does not belong to any groups."
+      else
+        puts groups.sort
+      end
+    end
+
+    def do_business_functions
+      puts data.sort
+    end
+
+    def do_grant_to
+      puts format("Granted '%<permission>s' to %<quoted_accounts>s.",
+                  permission: options[:'<permission>'],
+                  quoted_accounts: quoted(options[:'<account>']))
+    end
+
+    def do_revoke_from
+      puts format("Revoked '%<permission>s' from %<quoted_accounts>s.",
+                  permission: options[:'<permission>'],
+                  quoted_accounts: quoted(options[:'<account>']))
+    end
+
+    def do_permissions
+      perms = data.fetch(:groups, [])
+
+      if perms.empty?
+        puts "'#{options[:'<id>']}' does not have any permissions directly " \
+             'attached.'
+      else
+        puts perms.sort
+      end
+    end
+
+    def do_ingestionpolicy_add_to
+      puts format("Added '%<policy>s' to '%<id>s'.",
+                  id: options[:'<id>'],
+                  policy: options[:'<policy>'])
+    end
+
+    def do_ingestionpolicy_remove_from
+      puts format("Removed '%<policy>s' from '%<id>s'.",
+                  id: options[:'<id>'],
+                  policy: options[:'<policy>'])
+    end
+
+    def do_ingestionpolicy
+      policy = data.fetch(:ingestionPolicyId, [])
+
+      if policy.empty?
+        puts "'#{options[:'<id>']}' has no ingestion policy."
+      else
+        puts policy
+      end
+    end
+
+    def do_invite_user
+      puts format("Sent invitation to '%<id>s'.", id: options[:'<id>'])
+    end
+
+    private
+
+    def filter_user_list
+      if options[:user]
+        data.delete_if { |a| a[:identifier].start_with?('sa::') }
+      elsif options[:service]
+        data.delete_if { |a| !a[:identifier].start_with?('sa::') }
+      end
+    end
+  end
+end

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

@@ -74,5 +74,13 @@ module WavefrontDisplay
     def do_version
       puts data.max
     end
+
+    def do_affected_hosts
+      if data == [nil]
+        puts 'Alert event is not attached to any hosts.'
+      else
+        long_output
+      end
+    end
   end
 end