src/collectdctl.pod

   1 =head1 NAME
   2
   3 collectdctl - Control interface for collectd
   4
   5 =head1 SYNOPSIS
   6
   7 collectdctl I<[options]> I<E<lt>commandE<gt>> I<[command options]>
   8
   9 =head1 DESCRIPTION
  10
  11 collectdctl provides a control interface for collectd, which may be used to
  12 interact with the daemon using the C<unixsock plugin>.
  13
  14 =head1 OPTIONS
  15
  16 collectdctl supports the following options:
  17
  18 =over 4
  19
  20 =item B<-s> I<socket>
  21
  22 Path to the UNIX socket opened by collectd's C<unixsock plugin>.
  23 Default: /var/run/collectd-unixsock
  24
  25 =item B<-h>
  26
  27 Display usage information and exit.
  28
  29 =back
  30
  31 =head1 AVAILABLE COMMANDS
  32
  33 The following commands are supported:
  34
  35 =over 4
  36
  37 =item B<getval> I<E<lt>identifierE<gt>>
  38
  39 Query the latest collected value identified by the specified
  40 I<E<lt>identifierE<gt>> (see below). The value-list associated with that
  41 data-set is returned as a list of key-value-pairs, each on its own line. Keys
  42 and values are separated by the equal sign (C<=>).
  43
  44 =item B<flush> [B<timeout=>I<E<lt>secondsE<gt>>] [B<plugin=>I<E<lt>nameE<gt>>]
  45 [B<identifier=>I<E<lt>idE<gt>>]
  46
  47 Flush the daemon. This is useful, e.E<nbsp>g., to make sure that the latest
  48 values have been written to the respective RRD file before graphing them or
  49 copying them to somewhere else.
  50
  51 The following options are supported by the flush command:
  52
  53 =over 4
  54
  55 =item B<timeout=>I<E<lt>secondsE<gt>>
  56
  57 Flush values older than the specified timeout (in seconds) only.
  58
  59 =item B<plugin=>I<E<lt>nameE<gt>>
  60
  61 Flush the specified plugin only. I.E<nbsp>e., data cached by the specified
  62 plugin is written to disk (or network or whatever), if the plugin supports
  63 that operation.
  64
  65 Example: B<rrdtool>.
  66
  67 =item B<identifier=>I<E<lt>idE<gt>>
  68
  69 If this option is present, only the data specified by the specified identifier
  70 (see below) will be flushed. Note that this option is not supported by all
  71 plugins (e.E<nbsp>g., the C<network> plugin does not support this).
  72
  73 =back
  74
  75 The B<plugin> and B<identifier> options may be specified more than once. In
  76 that case, all combinations of specified plugins and identifiers will be
  77 flushed only.
  78
  79 =item B<listval>
  80
  81 Returns a list of all values (by their identifier) available to the
  82 C<unixsock> plugin. Each value is printed on its own line. I.E<nbsp>e., this
  83 command returns a list of valid identifiers that may be used with the other
  84 commands.
  85
  86 =back
  87
  88 =head1 IDENTIFIERS
  89
  90 An identifier has the following format:
  91
  92 [I<hostname>/]I<plugin>[-I<plugin_instance>]/I<type>[-I<type_instance>]
  93
  94 Examples:
  95  somehost/cpu-0/cpu-idle
  96  uptime/uptime
  97  otherhost/memory/memory-used
  98
  99 Hostname defaults to the local (non-fully qualified) hostname if omitted. No
 100 error is returned if the specified identifier does not exist (this is a
 101 limitation in the C<libcollectdclient> library).
 102
 103 =head1 EXAMPLES
 104
 105 =over 4
 106
 107 =item C<collectdctl flush plugin=rrdtool identifier=somehost/cpu-0/cpu-wait>
 108
 109 Flushes all CPU wait RRD values of the first CPU of the local host.
 110 I.E<nbsp>e., writes all pending RRD updates of that data-source to disk.
 111
 112 =item C<for ident in `collectdctl listval | grep users/users`; do
 113       collectdctl getval $ident;
 114   done>
 115
 116 Query the latest number of logged in users on all hosts known to the local
 117 collectd instance.
 118
 119 =back
 120
 121 =head1 SEE ALSO
 122
 123 L<collectd(1)>
 124 L<collectd.conf(5)>
 125 L<collectd-unixsock(5)>
 126
 127 =head1 AUTHOR
 128
 129 collectd has been written by Florian Forster E<lt>octo at verplant.orgE<gt>
 130 and many contributors (see `AUTHORS').
 131
 132 collectdctl has been written by
 133 Håkon J Dugstad Johnsen E<lt>hakon-dugstad.johnsenE<nbsp>atE<nbsp>telenor.comE<gt>
 134 and Sebastian Harl E<lt>sh at tokkee.orgE<gt>.
 135
 136 =cut