doc/rrdupdate.1

   1 .\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
   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 "2008-03-15" "1.3.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 \&\fBN\fR|\fItimestamp\fR\fB:\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]
 139 \&\fIat-timestamp\fR\fB@\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]
 140 [\fItimestamp\fR\fB:\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]\ ...]
 141 .SH "DESCRIPTION"
 142 .IX Header "DESCRIPTION"
 143 The \fBupdate\fR function feeds new data values into an \fB\s-1RRD\s0\fR. The data
 144 is time aligned (interpolated) according to the properties of the
 145 \&\fB\s-1RRD\s0\fR to which the data is written.
 146 .IP "\fBupdatev\fR" 8
 147 .IX Item "updatev"
 148 This alternate version of \fBupdate\fR takes the same arguments and
 149 performs the same function. The \fIv\fR stands for \fIverbose\fR, which
 150 describes the output returned. \fBupdatev\fR returns a list of any and all
 151 consolidated data points (CDPs) written to disk as a result of the
 152 invocation of update. The values are indexed by timestamp (time_t),
 153 \&\s-1RRA\s0 (consolidation function and PDPs per \s-1CDP\s0), and data source (name).
 154 Note that depending on the arguments of the current and previous call to
 155 update, the list may have no entries or a large number of entries.
 156 .IP "\fIfilename\fR" 8
 157 .IX Item "filename"
 158 The name of the \fB\s-1RRD\s0\fR you want to update.
 159 .IP "\fB\-\-template\fR|\fB\-t\fR \fIds-name\fR[\fB:\fR\fIds-name\fR]..." 8
 160 .IX Item "--template|-t ds-name[:ds-name]..."
 161 By default, the \fBupdate\fR function expects its data input in the order
 162 the data sources are defined in the \s-1RRD\s0, excluding any \s-1COMPUTE\s0 data
 163 sources (i.e. if the third data source \fB\s-1DST\s0\fR is \s-1COMPUTE\s0, the third
 164 input value will be mapped to the fourth data source in the \fB\s-1RRD\s0\fR and
 165 so on). This is not very error resistant, as you might be sending the
 166 wrong data into an \s-1RRD\s0.
 167 .Sp
 168 The template switch allows you to specify which data sources you are
 169 going to update and in which order. If the data sources specified in
 170 the template are not available in the \s-1RRD\s0 file, the update process
 171 will abort with an error message.
 172 .Sp
 173 While it appears possible with the template switch to update data sources
 174 asynchronously, \fBRRDtool\fR implicitly assigns non-COMPUTE data sources missing
 175 from the template the \fI*UNKNOWN*\fR value.
 176 .Sp
 177 Do not specify a value for a \s-1COMPUTE\s0 \fB\s-1DST\s0\fR in the \fBupdate\fR
 178 function. If this is done accidentally (and this can only be done
 179 using the template switch), \fBRRDtool\fR will ignore the value specified
 180 for the \s-1COMPUTE\s0 \fB\s-1DST\s0\fR.
 181 .IP "\fBN\fR|\fItimestamp\fR\fB:\fR\fIvalue\fR[\fB:\fR\fIvalue\fR...]" 8
 182 .IX Item "N|timestamp:value[:value...]"
 183 The data used for updating the \s-1RRD\s0 was acquired at a certain
 184 time. This time can either be defined in seconds since 1970\-01\-01 or
 185 by using the letter 'N', in which case the update time is set to be
 186 the current time. Negative time values are subtracted from the current
 187 time. An \s-1AT_STYLE\s0 \s-1TIME\s0 \s-1SPECIFICATION\s0 (see the \fIrrdfetch\fR
 188 documentation) may also be used by delimiting the end of the time
 189 specification with the '@' character instead of a ':'. Getting the
 190 timing right to the second is especially important when you are
 191 working with data-sources of type \fB\s-1COUNTER\s0\fR, \fB\s-1DERIVE\s0\fR or
 192 \&\fB\s-1ABSOLUTE\s0\fR.
 193 .Sp
 194 The remaining elements of the argument are \s-1DS\s0 updates. The order of
 195 this list is the same as the order the data sources were defined in
 196 the \s-1RRA\s0. If there is no data for a certain data-source, the letter
 197 \&\fBU\fR (e.g., N:0.1:U:1) can be specified.
 198 .Sp
 199 The format of the value acquired from the data source is dependent on
 200 the data source type chosen. Normally it will be numeric, but the data
 201 acquisition modules may impose their very own parsing of this
 202 parameter as long as the colon (\fB:\fR) remains the data source value
 203 separator.
 204 .SH "EXAMPLE"
 205 .IX Header "EXAMPLE"
 206 \&\f(CW\*(C`rrdtool update demo1.rrd N:3.44:3.15:U:23\*(C'\fR
 207 .PP
 208 Update the database file demo1.rrd with 3 known and one \fI*UNKNOWN*\fR
 209 value. Use the current time as the update time.
 210 .PP
 211 \&\f(CW\*(C`rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7\*(C'\fR
 212 .PP
 213 Update the database file demo2.rrd which expects data from a single
 214 data-source, three times. First with an \fI*UNKNOWN*\fR value then with two
 215 regular readings. The update interval seems to be around 300 seconds.
 216 .SH "AUTHOR"
 217 .IX Header "AUTHOR"
 218 Tobias Oetiker <tobi@oetiker.ch>