src/collectd-flush.pod

   1 =head1 NAME
   2
   3 collectd-flush - Small command line utility to flush collectd
   4
   5 =head1 SYNOPSIS
   6
   7 collectd-flush I<[options]>
   8
   9 =head1 DESCRIPTION
  10
  11 This small command line utitilty uses C<libcollectdclient> to flush collectd
  12 through a socket from the L<unixsock plugin>. Useful if you want to be sure
  13 you have the latest values in your RRD files before graphing them or copying
  14 them somewhere else.
  15
  16 =head1 ARGUMENTS AND OPTIONS
  17
  18 The following arguments and options are understood by collectd-flush. The order
  19 of the arguments generally doesn't matter, as long as no argument is passed
  20 more than once.
  21
  22 =over 4
  23
  24 =item B<-h>, B<--help>
  25
  26 Display information about the options.
  27
  28 =item B<-s>, B<--socket=>I<socket>
  29
  30 Path to the UNIX socket opened by collectd's C<unixsock plugin>.
  31 Default: /var/run/collectd-unixsock
  32
  33 =item B<-p>, B<--plugin=>I<plugin>
  34
  35 Plugin to flush I<to>. Example: B<rrdtool>.
  36
  37 =item B<-i>, B<--identifier=>I<identifier>
  38
  39 If this option is present, only the data specified by I<identifier> will be flushed.
  40 I<identifier> has the following format:
  41
  42 [I<hostname>/]I<plugin>[-I<plugin_instance>]/I<type>[-I<type_instance>]
  43
  44 Examples:
  45  somehost/cpu-0/cpu-idle
  46  uptime/uptime
  47  otherhost/memory/memory-used
  48
  49 Hostname defaults to the local hostname if omitted. No error is returned if the
  50 specified identifier does not exist (this is a limitation in the
  51 C<libcollectdclient> library).You can only specify one identifier each time you
  52 run this program (even though L<collectd-unixsock(5)> supports multiple
  53 identifiers).
  54
  55 =item B<-t>, B<--timeout=>I<timeout>
  56
  57 Only flush values older than I<timeout>.
  58
  59 =back
  60
  61 =head1 SEE ALSO
  62
  63 L<collectd(1)>
  64 L<collectd.conf(5)>
  65 L<collectd-unixsock(5)>
  66
  67 =head1 AUTHOR
  68
  69 Håkon J Dugstad Johnsen E<lt>hakon-dugstad.johnsenE<nbsp>atE<nbsp>telenor.comE<gt>
  70
  71 =cut