Class: WavefrontCommandSpy

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

Overview

Define the spy command.

Instance Method Summary collapse

Methods inherited from WavefrontCommandBase

#acl_commands, #commands, #common_options, #docopt, #global_option_text, #global_options, #opt_row, #option_column_width, #options, #postscript, #sdk_class, #sdk_file, #tag_commands, #thing, #things, #word

Instance Method Details

#_commandsObject



16
17
18
19
20
21
# File 'lib/wavefront-cli/commands/spy.rb', line 16

def _commands
  ["points #{_common_opts} [-T tag_key...] [-H host]",
   "histograms #{_common_opts} [-T tag_key...] [-H host]",
   "spans #{_common_opts} [-T tag_key...] [-H host]",
   "ids #{_common_opts} [-y type]"]
end

#_common_optsObject



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

def _common_opts
  "#{CMN} [-e timeout] [-p prefix] [-r rate] [-m]"
end

#_optionsObject



23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/wavefront-cli/commands/spy.rb', line 23

def _options
  [common_options,
   '-e, --end-after=SECONDS  stop spying after (approximately) the given ' \
   'number of seconds',
   '-m, --timestamp          prefix each block of output with the current ' \
   'time',
   '-r, --rate=NUMBER        sampling rate to use, from 0.01 to 0.5 ' \
   '(default 0.01)',
   '-p, --prefix=STRING      only show metric names beginning with given ' \
   'string',
   '-H, --host=STRING        only show metrics from given host',
   '-T, --tag-key=TAG        only show metrics with the given point tag key',
   '-y, --type=STRING        one of METRIC, SPAN, HOST, or STRING']
end

#descriptionObject



8
9
10
# File 'lib/wavefront-cli/commands/spy.rb', line 8

def description
  'monitor traffic going into Wavefront'
end