Class: WavefrontCommandWrite

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

Overview

Define the write 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, #sdk_class, #sdk_file, #tag_commands, #thing, #things, #word

Instance Method Details

#_commands ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/wavefront-cli/commands/write.rb', line 12

def _commands
  ['point [-DnViq] [-c file] [-P profile] [-E proxy] [-t time] ' \
   '[-p port] [-H host] [-T tag...] [-u method] [-S socket] <metric> ' \
   '[--] <value>',
   'distribution [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
   '[-p port] [-T tag...] [-u method] [-S socket] [-I interval] ' \
   '<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>',
   'noise [-DnViq] [-P profile] [-E proxy] [-H host] [-p port] ' \
   '[-T tag...] [-I interval] [-x value] [-X value] <metric>']
end

#_options ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/wavefront-cli/commands/write.rb', line 26

def _options
  ['-E, --proxy=URI            proxy endpoint',
   '-t, --time=TIME            time of data point (omit to use ' \
   'current time)',
   '-H, --host=STRING          source host', \
   '-p, --port=INT             Wavefront proxy port',
   '-T, --tag=TAG              point tag in key=value form',
   '-F, --infileformat=STRING  format of input file or stdin',
   '-m, --metric=STRING        the metric path to which contents of ' \
   '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'), 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

#description ⇒ Object 



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

def description
  'send data to Wavefront'
end

#postscript ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/wavefront-cli/commands/write.rb', line 48

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, 'd' for a comma-separated " \
  "distribution, and 'T' for tags. Put 'T' last.  Currently " \
  "supported transport methods are 'socket' (write to a proxy: the " \
  "default); 'api' (write directly to Wavefront); 'http' (write to " \
  "a proxy over HTTP); and 'unix' (write to a local Unix socket)."
    .cmd_fold(TW, 0)
end