doc/rrdfetch.pod

   1 =head1 NAME
   2
   3 rrdfetch - Fetch data from an RRD.
   4
   5 =head1 SYNOPSIS
   6
   7 B<rrdtool> B<fetch> I<filename> I<CF>
   8 S<[B<--resolution>|B<-r> I<resolution>]>
   9 S<[B<--start>|B<-s> I<start>]>
  10 S<[B<--end>|B<-e> I<end>]>
  11 S<[B<--daemon> I<address>]>
  12
  13 =head1 DESCRIPTION
  14
  15 The B<fetch> function is normally used internally by the graph
  16 function to get data from B<RRD>s. B<fetch> will analyze the B<RRD>
  17 and try to retrieve the data in the resolution requested.
  18 The data fetched is printed to stdout. I<*UNKNOWN*> data is often
  19 represented by the string "NaN" depending on your OS's printf
  20 function.
  21
  22 =over 8
  23
  24 =item I<filename>
  25
  26 the name of the B<RRD> you want to fetch the data from.
  27
  28 =item I<CF>
  29
  30 the consolidation function that is applied to the data you
  31 want to fetch (AVERAGE,MIN,MAX,LAST)
  32
  33 =item B<--resolution>|B<-r> I<resolution> (default is the highest resolution)
  34
  35 the interval you want the values to have (seconds per
  36 value). B<rrdfetch> will try to match your request, but it will return
  37 data even if no absolute match is possible. B<NB.> See note below.
  38
  39 =item B<--start>|B<-s> I<start> (default end-1day)
  40
  41 start of the time series. A time in seconds since epoch (1970-01-01)
  42 is required. Negative numbers are relative to the current time. By default,
  43 one day worth of data will be fetched. See also AT-STYLE TIME SPECIFICATION
  44 section for a detailed explanation on  ways to specify the start time.
  45
  46 =item B<--end>|B<-e> I<end> (default now)
  47
  48 the end of the time series in seconds since epoch. See also AT-STYLE
  49 TIME SPECIFICATION section for a detailed explanation of how to
  50 specify the end time.
  51
  52 =item B<--daemon> I<address>
  53
  54 Address of the L<rrdcached> daemon. If specified, a C<flush> command is sent
  55 to the server before reading the RRD files. This allows B<rrdtool> to return
  56 fresh data even if the daemon is configured to cache values for a long time.
  57 For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
  58
  59  rrdtool fetch --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd AVERAGE
  60
  61 =back
  62
  63 =head2 RESOLUTION INTERVAL
  64
  65 In order to get RRDtool to fetch anything other than the finest resolution RRA
  66 B<both> the start and end time must be specified on boundaries that are
  67 multiples of the desired resolution. Consider the following example:
  68
  69  rrdtool create subdata.rrd -s 10 DS:ds0:GAUGE:300:0:U \
  70   RRA:AVERAGE:0.5:30:3600 \
  71   RRA:AVERAGE:0.5:90:1200 \
  72   RRA:AVERAGE:0.5:360:1200 \
  73   RRA:MAX:0.5:360:1200 \
  74   RRA:AVERAGE:0.5:8640:600 \
  75   RRA:MAX:0.5:8640:600
  76
  77 This RRD collects data every 10 seconds and stores its averages over 5
  78 minutes, 15 minutes, 1 hour, and 1 day, as well as the maxima for 1 hour
  79 and 1 day.
  80
  81 Consider now that you want to fetch the 15 minute average data for the
  82 last hour.  You might try
  83
  84  rrdtool fetch subdata.rrd AVERAGE -r 900 -s -1h
  85
  86 However, this will almost always result in a time series that is
  87 B<NOT> in the 15 minute RRA. Therefore, the highest resolution RRA,
  88 i.e. 5 minute averages, will be chosen which in this case is not
  89 what you want.
  90
  91 Hence, make sure that
  92
  93 =over 3
  94
  95 =item 1.
  96
  97 both start and end time are a multiple of 900
  98
  99 =item 2.
 100
 101 both start and end time are within the desired RRA
 102
 103 =back
 104
 105 So, if time now is called "t", do
 106
 107  end time == int(t/900)*900,
 108  start time == end time - 1hour,
 109  resolution == 900.
 110
 111 Using the bash shell, this could look be:
 112
 113  TIME=$(date +%s)
 114  RRDRES=900
 115  rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
 116     -e $(($TIME/$RRDRES*$RRDRES)) -s e-1h
 117
 118 Or in Perl:
 119
 120  perl -e '$ctime = time; $rrdres = 900; \
 121           system "rrdtool fetch subdata.rrd AVERAGE \
 122                   -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
 123
 124
 125 =head2 AT-STYLE TIME SPECIFICATION
 126
 127 Apart from the traditional I<Seconds since epoch>, RRDtool does also
 128 understand at-style time specification. The specification is called
 129 "at-style" after the Unix command at(1) that has moderately complex
 130 ways to specify time to run your job at a certain date and time. The
 131 at-style specification consists of two parts: the B<TIME REFERENCE>
 132 specification and the B<TIME OFFSET> specification.
 133
 134 =head2 TIME REFERENCE SPECIFICATION
 135
 136 The time reference specification is used, well, to establish a reference
 137 moment in time (to which the time offset is then applied to). When present,
 138 it should come first, when omitted, it defaults to B<now>. On its own part,
 139 time reference consists of a I<time-of-day> reference (which should come
 140 first, if present) and a I<day> reference.
 141
 142 The I<time-of-day> can be specified as B<HH:MM>, B<HH.MM>,
 143 or just B<HH>. You can suffix it with B<am> or B<pm> or use
 144 24-hours clock. Some special times of day are understood as well,
 145 including B<midnight> (00:00), B<noon> (12:00) and British
 146 B<teatime> (16:00).
 147
 148 The I<day> can be specified as I<month-name> I<day-of-the-month> and
 149 optional a 2- or 4-digit I<year> number (e.g. March 8 1999). Alternatively,
 150 you can use I<day-of-week-name> (e.g. Monday), or one of the words:
 151 B<yesterday>, B<today>, B<tomorrow>. You can also specify the I<day> as a
 152 full date in several numerical formats, including B<MM/DD/[YY]YY>,
 153 B<DD.MM.[YY]YY>, or B<YYYYMMDD>.
 154
 155 I<NOTE1>: this is different from the original at(1) behavior, where a
 156 single-number date is interpreted as MMDD[YY]YY.
 157
 158 I<NOTE2>: if you specify the I<day> in this way, the I<time-of-day> is
 159 REQUIRED as well.
 160
 161 Finally, you can use the words B<now>, B<start>, B<end> or B<epoch> as your time
 162 reference. B<Now> refers to the current moment (and is also the default
 163 time reference). B<Start> (B<end>) can be used to specify a time
 164 relative to the start (end) time for those tools that use these
 165 categories (B<rrdfetch>, L<rrdgraph>) and B<epoch> indicates the
 166 *IX epoch (*IX timestamp 0 = 1970-01-01 00:00:00 UTC). B<epoch> is
 167 useful to disambiguate between a timestamp value and some forms
 168 of abbreviated date/time specifications, because it allows to use
 169 time offset specifications using units, eg. B<epoch>+19711205s unambiguously
 170 denotes timestamp 19711205 and not 1971-12-05 00:00:00 UTC.
 171
 172 Month and day of the week names can be used in their naturally
 173 abbreviated form (e.g., Dec for December, Sun for Sunday, etc.). The
 174 words B<now>, B<start>, B<end> can be abbreviated as B<n>, B<s>, B<e>.
 175
 176 =head2 TIME OFFSET SPECIFICATION
 177
 178 The time offset specification is used to add/subtract certain time
 179 intervals to/from the time reference moment. It consists of a I<sign>
 180 (S<B<+> or B<->>) and an I<amount>. The following time units can be
 181 used to specify the I<amount>: B<years>, B<months>, B<weeks>, B<days>,
 182 B<hours>, B<minutes>, or B<seconds>. These units can be used in
 183 singular or plural form, and abbreviated naturally or to a single
 184 letter (e.g. +3days, -1wk, -3y). Several time units can be combined
 185 (e.g., -5mon1w2d) or concatenated (e.g., -5h45min = -5h-45min =
 186 -6h+15min = -7h+1h30m-15min, etc.)
 187
 188 I<NOTE3>: If you specify time offset in days, weeks, months, or years,
 189 you will end with the time offset that may vary depending on your time
 190 reference, because all those time units have no single well defined
 191 time interval value (S<1 year> contains either 365 or 366 days, S<1 month>
 192 is 28 to 31 days long, and even S<1 day> may be not equal to 24 hours
 193 twice a year, when DST-related clock adjustments take place).
 194 To cope with this, when you use days, weeks, months, or years
 195 as your time offset units your time reference date is adjusted
 196 accordingly without too much further effort to ensure anything
 197 about it (in the hope that mktime(3) will take care of this later).
 198 This may lead to some surprising (or even invalid!) results,
 199 e.g. S<'May 31 -1month'> = S<'Apr 31'> (meaningless) = S<'May 1'>
 200 (after mktime(3) normalization); in the EET timezone
 201 '3:30am Mar 29 1999 -1 day' yields '3:30am Mar 28 1999' (Sunday)
 202 which is an invalid time/date combination (because of 3am -> 4am DST
 203 forward clock adjustment, see the below example).
 204
 205 In contrast, hours, minutes, and seconds are well defined time
 206 intervals, and these are guaranteed to always produce time offsets
 207 exactly as specified (e.g. for EET timezone, S<'8:00 Mar 27 1999 +2
 208 days'> = S<'8:00 Mar 29 1999'>, but since there is 1-hour DST forward
 209 clock adjustment that occurs around S<3:00 Mar 28 1999>, the actual
 210 time interval between S<8:00 Mar 27 1999> and S<8:00 Mar 29 1999>
 211 equals 47 hours; on the other hand, S<'8:00 Mar 27 1999 +48 hours'> =
 212 S<'9:00 Mar 29 1999'>, as expected)
 213
 214 I<NOTE4>: The single-letter abbreviation for both B<months> and B<minutes>
 215 is B<m>. To disambiguate them, the parser tries to read your S<mind :)>
 216 by applying the following two heuristics:
 217
 218 =over 3
 219
 220 =item 1
 221
 222 If B<m> is used in context of (i.e. right after the) years,
 223 months, weeks, or days it is assumed to mean B<months>, while
 224 in the context of hours, minutes, and seconds it means minutes.
 225 (e.g., in -1y6m or +3w1m B<m> is interpreted as B<months>, while in
 226 -3h20m or +5s2m B<m> the parser decides for B<minutes>).
 227
 228 =item 2
 229
 230 Out of context (i.e. right after the B<+> or B<-> sign) the
 231 meaning of B<m> is guessed from the number it directly follows.
 232 Currently, if the number's absolute value is below 25 it is assumed
 233 that B<m> means B<months>, otherwise it is treated as B<minutes>.
 234 (e.g., -25m == -25 minutes, while +24m == +24 months)
 235
 236 =back
 237
 238 I<Final NOTES>: Time specification is case-insensitive.
 239 Whitespace can be inserted freely or omitted altogether.
 240 There are, however, cases when whitespace is required
 241 (e.g., S<'midnight Thu'>). In this case you should either quote the
 242 whole phrase to prevent it from being taken apart by your shell or use
 243 '_' (underscore) or ',' (comma) which also count as whitespace
 244 (e.g., midnight_Thu or midnight,Thu).
 245
 246
 247 =head2 TIME SPECIFICATION EXAMPLES
 248
 249 I<Oct 12> -- October 12 this year
 250
 251 I<-1month> or I<-1m> -- current time of day, only a month before
 252 (may yield surprises, see NOTE3 above).
 253
 254 I<noon yesterday -3hours> -- yesterday morning; can also be specified
 255 as I<9am-1day>.
 256
 257 I<23:59 31.12.1999> -- 1 minute to the year 2000.
 258
 259 I<12/31/99 11:59pm> -- 1 minute to the year 2000 for imperialists.
 260
 261 I<12am 01/01/01> -- start of the new millennium
 262
 263 I<end-3weeks> or I<e-3w> -- 3 weeks before end time
 264 (may be used as start time specification).
 265
 266 I<start+6hours> or I<s+6h> -- 6 hours after start time
 267 (may be used as end time specification).
 268
 269 I<931225537> -- 18:45  July 5th, 1999
 270 (yes, seconds since 1970 are valid as well).
 271
 272 I<19970703 12:45> -- 12:45  July 3th, 1997
 273 (my favorite, and its even got an ISO number (8601)).
 274
 275 =head1 ENVIRONMENT VARIABLES
 276
 277 The following environment variables may be used to change the behavior of
 278 C<rrdtoolE<nbsp>fetch>:
 279
 280 =over 4
 281
 282 =item B<RRDCACHED_ADDRESS>
 283
 284 If this environment variable is set it will have the same effect as specifying
 285 the C<--daemon> option on the command line. If both are present, the command
 286 line argument takes precedence.
 287
 288 =back
 289
 290 =head1 AUTHOR
 291
 292 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 293