doc/rrdupdate.pod

   1 =head1 NAME
   2
   3 rrdupdate - Store a new set of values into the RRD
   4
   5 =head1 SYNOPSIS
   6
   7 B<rrdtool> {B<update> | B<updatev>} I<filename>
   8 S<[B<--template>|B<-t> I<ds-name>[B<:>I<ds-name>]...]>
   9 S<[B<--daemon> I<address>]> [B<-->]
  10 S<B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]>
  11 S<I<at-timestamp>B<@>I<value>[B<:>I<value>...]>
  12 S<[I<timestamp>B<:>I<value>[B<:>I<value>...] ...]>
  13
  14 =head1 DESCRIPTION
  15
  16 The B<update> function feeds new data values into an B<RRD>. The data
  17 is time aligned (interpolated) according to the properties of the
  18 B<RRD> to which the data is written.
  19
  20 =over 8
  21
  22 =item B<updatev>
  23
  24 This alternate version of B<update> takes the same arguments and
  25 performs the same function. The I<v> stands for I<verbose>, which
  26 describes the output returned. B<updatev> returns a list of any and all
  27 consolidated data points (CDPs) written to disk as a result of the
  28 invocation of update. The values are indexed by timestamp (time_t),
  29 RRA (consolidation function and PDPs per CDP), and data source (name).
  30 Note that depending on the arguments of the current and previous call to
  31 update, the list may have no entries or a large number of entries.
  32
  33 Since B<updatev> requires direct disk access, the B<--daemon> option cannot be
  34 used with this command.
  35
  36 =item I<filename>
  37
  38 The name of the B<RRD> you want to update.
  39
  40 =item B<--template>|B<-t> I<ds-name>[B<:>I<ds-name>]...
  41
  42 By default, the B<update> function expects its data input in the order
  43 the data sources are defined in the RRD, excluding any COMPUTE data
  44 sources (i.e. if the third data source B<DST> is COMPUTE, the third
  45 input value will be mapped to the fourth data source in the B<RRD> and
  46 so on). This is not very error resistant, as you might be sending the
  47 wrong data into an RRD.
  48
  49 The template switch allows you to specify which data sources you are
  50 going to update and in which order. If the data sources specified in
  51 the template are not available in the RRD file, the update process
  52 will abort with an error message.
  53
  54 While it appears possible with the template switch to update data sources
  55 asynchronously, B<RRDtool> implicitly assigns non-COMPUTE data sources missing
  56 from the template the I<*UNKNOWN*> value.
  57
  58 Do not specify a value for a COMPUTE B<DST> in the B<update>
  59 function. If this is done accidentally (and this can only be done
  60 using the template switch), B<RRDtool> will ignore the value specified
  61 for the COMPUTE B<DST>.
  62
  63 =item B<--daemon> I<address>
  64
  65 If given, B<RRDTool> will try to connect to the caching daemon L<rrdcached>
  66 at I<address> and will fail if the connection cannot be established. If the
  67 connection is successfully established the values will be sent to the daemon
  68 instead of accessing the files directly.
  69
  70 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
  71
  72 =item B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]
  73
  74 The data used for updating the RRD was acquired at a certain
  75 time. This time can either be defined in seconds since 1970-01-01 or
  76 by using the letter 'N', in which case the update time is set to be
  77 the current time. Negative time values are subtracted from the current
  78 time. An AT_STYLE TIME SPECIFICATION (see the I<rrdfetch>
  79 documentation) may also be used by delimiting the end of the time
  80 specification with the '@' character instead of a ':'. Getting the
  81 timing right to the second is especially important when you are
  82 working with data-sources of type B<COUNTER>, B<DERIVE> or
  83 B<ABSOLUTE>.
  84
  85 When using negative time values, options and data have to be separated
  86 by two dashes (B<-->), else the time value would be parsed as an option.
  87 See below for an example.
  88
  89 When using negative time values, options and data have to be separated
  90 by two dashes (B<-->), else the time value would be parsed as an option.
  91 See below for an example.
  92
  93 The remaining elements of the argument are DS updates. The order of
  94 this list is the same as the order the data sources were defined in
  95 the RRA. If there is no data for a certain data-source, the letter
  96 B<U> (e.g., N:0.1:U:1) can be specified.
  97
  98 The format of the value acquired from the data source is dependent on
  99 the data source type chosen. Normally it will be numeric, but the data
 100 acquisition modules may impose their very own parsing of this
 101 parameter as long as the colon (B<:>) remains the data source value
 102 separator.
 103
 104 =back
 105
 106 =head1 ENVIRONMENT VARIABLES
 107
 108 The following environment variables may be used to change the behavior of
 109 C<rrdtoolE<nbsp>update>:
 110
 111 =over
 112
 113 =item B<RRDCACHED_ADDRESS>
 114
 115 If this environment variable is set it will have the same effect as specifying
 116 the C<--daemon> option on the command line. If both are present, the command
 117 line argument takes precedence.
 118
 119 =back
 120
 121 =head1 EXAMPLES
 122
 123 =over
 124
 125 =item *
 126
 127 C<rrdtool update demo1.rrd N:3.44:3.15:U:23>
 128
 129 Update the database file demo1.rrd with 3 known and one I<*UNKNOWN*>
 130 value. Use the current time as the update time.
 131
 132 =item *
 133
 134 C<rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7>
 135
 136 Update the database file demo2.rrd which expects data from a single
 137 data-source, three times. First with an I<*UNKNOWN*> value then with two
 138 regular readings. The update interval seems to be around 300 seconds.
 139
 140 =item *
 141
 142 C<rrdtool update demo3.rrd -- -5:21 N:42>
 143
 144 Update the database file demo3.rrd two times, using five seconds in the
 145 past and the current time as the update times.
 146
 147 =item *
 148
 149 C<rrdtool update --cache /var/lib/rrd/demo3.rrd N:42>
 150
 151 Update the file C</var/lib/rrd/demo3.rrd> with a single data source, using the
 152 current time. If the caching daemon cannot be reached, do B<not> fall back to
 153 direct file access.
 154
 155 =item *
 156
 157 C<rrdtool update --daemon unix:/tmp/rrdd.sock demo4.rrd N:23>
 158
 159 Use the UNIX domain socket C</tmp/rrdd.sock> to contact the caching daemon. If
 160 the caching daemon is not available, update the file C<demo4.rrd> directly.
 161 B<WARNING:> Since a relative path is specified, the following disturbing effect
 162 may occur: If the daemon is available, the file relative to the working
 163 directory B<of the daemon> is used. If the daemon is not available, the file
 164 relative to the current working directory of the invoking process is used.
 165 B<This may update two different files depending on whether the daemon could be
 166 reached or not.> Don't do relative paths, kids!
 167
 168 =back
 169
 170 =head1 AUTHORS
 171
 172 Tobias Oetiker <tobi@oetiker.ch>,
 173 Florian Forster <octoE<nbsp>atE<nbsp>verplant.org>
 174