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