Class: WavefrontCommandQuery

Inherits:
WavefrontCommandBase show all
Defined in:
lib/wavefront-cli/commands/query.rb

Overview

Define the query command.

Instance Method Summary collapse

Methods inherited from WavefrontCommandBase

#commands, #common_options, #docopt, #global_options, #opt_row, #option_column_width, #options, #postscript, #sdk_class, #sdk_file, #tag_commands, #word

Instance Method Details

#_commandsObject



10
11
12
13
14
# File 'lib/wavefront-cli/commands/query.rb', line 10

def _commands
  ["#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
         '[-ivO] [-S mode] [-N name] [-p points] <query>',
   "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>"]
end

#_optionsObject



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'lib/wavefront-cli/commands/query.rb', line 16

def _options
  [common_options,
   '-g, --granularity=STRING  query granularity (d, h, m, or s)',
   '-s, --start=TIME          start of query window',
   '-e, --end=TIME            end of query window',
   '-N, --name=STRING         name identifying query',
   '-p, --points=INTEGER      maximum number of points to return',
   '-i, --inclusive           include matching series with no ' \
   'points inside the query window',
   '-v, --events              include events for matching series',
   '-S, --summarize=STRING    summarization strategy for bucketing ' \
   'points (mean, median, min, max, sum, count, last, first)',
   '-O, --obsolete            include metrics unreported for > 4 weeks',
   '-H, --host=STRING         host or source to query on',
   '-f, --format=STRING       output format']
end

#descriptionObject



6
7
8
# File 'lib/wavefront-cli/commands/query.rb', line 6

def description
  'query the Wavefront API'
end