doc/rrdupdate.1

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "RRDUPDATE 1"
 127 .TH RRDUPDATE 1 "2013-05-23" "1.4.8" "rrdtool"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 rrdupdate \- Store a new set of values into the RRD
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\fBrrdtool\fR {\fBupdate\fR | \fBupdatev\fR} \fIfilename\fR
 137 [\fB\-\-template\fR|\fB\-t\fR\ \fIds-name\fR[\fB:\fR\fIds-name\fR]...]
 138 [\fB\-\-daemon\fR\ \fIaddress\fR] [\fB\-\-\fR]
 139 \&\fBN\fR|\fItimestamp\fR\fB:\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]
 140 \&\fIat-timestamp\fR\fB@\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]
 141 [\fItimestamp\fR\fB:\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]\ ...]
 142 .SH "DESCRIPTION"
 143 .IX Header "DESCRIPTION"
 144 The \fBupdate\fR function feeds new data values into an \fB\s-1RRD\s0\fR. The data
 145 is time aligned (interpolated) according to the properties of the
 146 \&\fB\s-1RRD\s0\fR to which the data is written.
 147 .IP "\fBupdatev\fR" 8
 148 .IX Item "updatev"
 149 This alternate version of \fBupdate\fR takes the same arguments and
 150 performs the same function. The \fIv\fR stands for \fIverbose\fR, which
 151 describes the output returned. \fBupdatev\fR returns a list of any and all
 152 consolidated data points (CDPs) written to disk as a result of the
 153 invocation of update. The values are indexed by timestamp (time_t),
 154 \&\s-1RRA\s0 (consolidation function and PDPs per \s-1CDP\s0), and data source (name).
 155 Note that depending on the arguments of the current and previous call to
 156 update, the list may have no entries or a large number of entries.
 157 .Sp
 158 Since \fBupdatev\fR requires direct disk access, the \fB\-\-daemon\fR option cannot be
 159 used with this command.
 160 .IP "\fIfilename\fR" 8
 161 .IX Item "filename"
 162 The name of the \fB\s-1RRD\s0\fR you want to update.
 163 .IP "\fB\-\-template\fR|\fB\-t\fR \fIds-name\fR[\fB:\fR\fIds-name\fR]..." 8
 164 .IX Item "--template|-t ds-name[:ds-name]..."
 165 By default, the \fBupdate\fR function expects its data input in the order
 166 the data sources are defined in the \s-1RRD\s0, excluding any \s-1COMPUTE\s0 data
 167 sources (i.e. if the third data source \fB\s-1DST\s0\fR is \s-1COMPUTE\s0, the third
 168 input value will be mapped to the fourth data source in the \fB\s-1RRD\s0\fR and
 169 so on). This is not very error resistant, as you might be sending the
 170 wrong data into an \s-1RRD\s0.
 171 .Sp
 172 The template switch allows you to specify which data sources you are
 173 going to update and in which order. If the data sources specified in
 174 the template are not available in the \s-1RRD\s0 file, the update process
 175 will abort with an error message.
 176 .Sp
 177 While it appears possible with the template switch to update data sources
 178 asynchronously, \fBRRDtool\fR implicitly assigns non-COMPUTE data sources missing
 179 from the template the \fI*UNKNOWN*\fR value.
 180 .Sp
 181 Do not specify a value for a \s-1COMPUTE\s0 \fB\s-1DST\s0\fR in the \fBupdate\fR
 182 function. If this is done accidentally (and this can only be done
 183 using the template switch), \fBRRDtool\fR will ignore the value specified
 184 for the \s-1COMPUTE\s0 \fB\s-1DST\s0\fR.
 185 .IP "\fB\-\-daemon\fR \fIaddress\fR" 8
 186 .IX Item "--daemon address"
 187 If given, \fBRRDTool\fR will try to connect to the caching daemon rrdcached
 188 at \fIaddress\fR and will fail if the connection cannot be established. If the
 189 connection is successfully established the values will be sent to the daemon
 190 instead of accessing the files directly.
 191 .Sp
 192 For a list of accepted formats, see the \fB\-l\fR option in the rrdcached manual.
 193 .IP "\fBN\fR|\fItimestamp\fR\fB:\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]" 8
 194 .IX Item "N|timestamp:value[:value...]"
 195 The data used for updating the \s-1RRD\s0 was acquired at a certain
 196 time. This time can either be defined in seconds since 1970\-01\-01 or
 197 by using the letter 'N', in which case the update time is set to be
 198 the current time. Negative time values are subtracted from the current
 199 time. An \s-1AT_STYLE\s0 \s-1TIME\s0 \s-1SPECIFICATION\s0 (see the \fIrrdfetch\fR
 200 documentation) may also be used by delimiting the end of the time
 201 specification with the '@' character instead of a ':'. Getting the
 202 timing right to the second is especially important when you are
 203 working with data-sources of type \fB\s-1COUNTER\s0\fR, \fB\s-1DERIVE\s0\fR or
 204 \&\fB\s-1ABSOLUTE\s0\fR.
 205 .Sp
 206 When using negative time values, options and data have to be separated
 207 by two dashes (\fB\-\-\fR), else the time value would be parsed as an option.
 208 See below for an example.
 209 .Sp
 210 When using negative time values, options and data have to be separated
 211 by two dashes (\fB\-\-\fR), else the time value would be parsed as an option.
 212 See below for an example.
 213 .Sp
 214 The remaining elements of the argument are \s-1DS\s0 updates. The order of
 215 this list is the same as the order the data sources were defined in
 216 the \s-1RRA\s0. If there is no data for a certain data-source, the letter
 217 \&\fBU\fR (e.g., N:0.1:U:1) can be specified.
 218 .Sp
 219 The format of the value acquired from the data source is dependent on
 220 the data source type chosen. Normally it will be numeric, but the data
 221 acquisition modules may impose their very own parsing of this
 222 parameter as long as the colon (\fB:\fR) remains the data source value
 223 separator.
 224 .SH "ENVIRONMENT VARIABLES"
 225 .IX Header "ENVIRONMENT VARIABLES"
 226 The following environment variables may be used to change the behavior of
 227 \&\f(CW\*(C`rrdtool\ update\*(C'\fR:
 228 .IP "\fB\s-1RRDCACHED_ADDRESS\s0\fR" 4
 229 .IX Item "RRDCACHED_ADDRESS"
 230 If this environment variable is set it will have the same effect as specifying
 231 the \f(CW\*(C`\-\-daemon\*(C'\fR option on the command line. If both are present, the command
 232 line argument takes precedence.
 233 .SH "EXAMPLES"
 234 .IX Header "EXAMPLES"
 235 .IP "\(bu" 4
 236 \&\f(CW\*(C`rrdtool update demo1.rrd N:3.44:3.15:U:23\*(C'\fR
 237 .Sp
 238 Update the database file demo1.rrd with 3 known and one \fI*UNKNOWN*\fR
 239 value. Use the current time as the update time.
 240 .IP "\(bu" 4
 241 \&\f(CW\*(C`rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7\*(C'\fR
 242 .Sp
 243 Update the database file demo2.rrd which expects data from a single
 244 data-source, three times. First with an \fI*UNKNOWN*\fR value then with two
 245 regular readings. The update interval seems to be around 300 seconds.
 246 .IP "\(bu" 4
 247 \&\f(CW\*(C`rrdtool update demo3.rrd \-\- \-5:21 N:42\*(C'\fR
 248 .Sp
 249 Update the database file demo3.rrd two times, using five seconds in the
 250 past and the current time as the update times.
 251 .IP "\(bu" 4
 252 \&\f(CW\*(C`rrdtool update \-\-cache /var/lib/rrd/demo3.rrd N:42\*(C'\fR
 253 .Sp
 254 Update the file \f(CW\*(C`/var/lib/rrd/demo3.rrd\*(C'\fR with a single data source, using the
 255 current time. If the caching daemon cannot be reached, do \fBnot\fR fall back to
 256 direct file access.
 257 .IP "\(bu" 4
 258 \&\f(CW\*(C`rrdtool update \-\-daemon unix:/tmp/rrdd.sock demo4.rrd N:23\*(C'\fR
 259 .Sp
 260 Use the \s-1UNIX\s0 domain socket \f(CW\*(C`/tmp/rrdd.sock\*(C'\fR to contact the caching daemon. If
 261 the caching daemon is not available, update the file \f(CW\*(C`demo4.rrd\*(C'\fR directly.
 262 \&\fB\s-1WARNING:\s0\fR Since a relative path is specified, the following disturbing effect
 263 may occur: If the daemon is available, the file relative to the working
 264 directory \fBof the daemon\fR is used. If the daemon is not available, the file
 265 relative to the current working directory of the invoking process is used.
 266 \&\fBThis may update two different files depending on whether the daemon could be
 267 reached or not.\fR Don't do relative paths, kids!
 268 .SH "AUTHORS"
 269 .IX Header "AUTHORS"
 270 Tobias Oetiker <tobi@oetiker.ch>,
 271 Florian Forster <octo\ at\ verplant.org>