doc/rrdfetch.txt

   1 RRDFETCH(1)                         rrdtool                        RRDFETCH(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdfetch - Fetch data from an RRD.
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        r\brr\brd\bdt\bto\boo\bol\bl f\bfe\bet\btc\bch\bh _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be _\bC_\bF [-\b--\b-r\bre\bes\bso\bol\blu\but\bti\bio\bon\bn|-\b-r\br _\br_\be_\bs_\bo_\bl_\bu_\bt_\bi_\bo_\bn]
  10        [-\b--\b-s\bst\bta\bar\brt\bt|-\b-s\bs _\bs_\bt_\ba_\br_\bt] [-\b--\b-e\ben\bnd\bd|-\b-e\be _\be_\bn_\bd]
  11
  12 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  13        The f\bfe\bet\btc\bch\bh function is normally used internally by the graph function to
  14        get data from R\bRR\bRD\bDs. f\bfe\bet\btc\bch\bh will analyze the R\bRR\bRD\bD and try to retrieve the
  15        data in the resolution requested.  The data fetched is printed to
  16        stdout. _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data is often represented by the string "NaN"
  17        depending on your OS's printf function.
  18
  19        _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
  20                the name of the R\bRR\bRD\bD you want to fetch the data from.
  21
  22        _\bC_\bF      the consolidation function that is applied to the data you want
  23                to fetch (AVERAGE,MIN,MAX,LAST)
  24
  25        -\b--\b-r\bre\bes\bso\bol\blu\but\bti\bio\bon\bn|-\b-r\br _\br_\be_\bs_\bo_\bl_\bu_\bt_\bi_\bo_\bn (default is the highest resolution)
  26                the interval you want the values to have (seconds per value).
  27                r\brr\brd\bdf\bfe\bet\btc\bch\bh will try to match your request, but it will return
  28                data even if no absolute match is possible. N\bNB\bB.\b. See note below.
  29
  30        -\b--\b-s\bst\bta\bar\brt\bt|-\b-s\bs _\bs_\bt_\ba_\br_\bt (default end-1day)
  31                start of the time series. A time in seconds since epoch
  32                (1970-01-01) is required. Negative numbers are relative to the
  33                current time. By default, one day worth of data will be
  34                fetched. See also AT-STYLE TIME SPECIFICATION section for a
  35                detailed explanation on  ways to specify the start time.
  36
  37        -\b--\b-e\ben\bnd\bd|-\b-e\be _\be_\bn_\bd (default now)
  38                the end of the time series in seconds since epoch. See also AT-
  39                STYLE TIME SPECIFICATION section for a detailed explanation of
  40                how to specify the end time.
  41
  42    R\bRE\bES\bSO\bOL\bLU\bUT\bTI\bIO\bON\bN I\bIN\bNT\bTE\bER\bRV\bVA\bAL\bL
  43        In order to get RRDtool to fetch anything other than the finest
  44        resolution RRA b\bbo\bot\bth\bh the start and end time must be specified on
  45        boundaries that are multiples of the desired resolution. Consider the
  46        following example:
  47
  48         rrdtool create subdata.rrd -s 10 DS:ds0:GAUGE:300:0:U \
  49          RRA:AVERAGE:0.5:30:3600 \
  50          RRA:AVERAGE:0.5:90:1200 \
  51          RRA:AVERAGE:0.5:360:1200 \
  52          RRA:MAX:0.5:360:1200 \
  53          RRA:AVERAGE:0.5:8640:600 \
  54          RRA:MAX:0.5:8640:600
  55
  56        This RRD collects data every 10 seconds and stores its averages over 5
  57        minutes, 15 minutes, 1 hour, and 1 day, as well as the maxima for 1
  58        hour and 1 day.
  59
  60        Consider now that you want to fetch the 15 minute average data for the
  61        last hour.  You might try
  62
  63         rrdtool fetch subdata.rrd AVERAGE -r 900 -s -1h
  64
  65        However, this will almost always result in a time series that is N\bNO\bOT\bT in
  66        the 15 minute RRA. Therefore, the highest resolution RRA, i.e. 5 minute
  67        averages, will be chosen which in this case is not what you want.
  68
  69        Hence, make sure that
  70
  71        1. both start and end time are a multiple of 900
  72
  73        2. both start and end time are within the desired RRA
  74
  75        So, if time now is called "t", do
  76
  77         end time == int(t/900)*900,
  78         start time == end time - 1hour,
  79         resolution == 900.
  80
  81        Using the bash shell, this could look be:
  82
  83         TIME=$(date +%s)
  84         RRDRES=900
  85         rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
  86            -e $(($TIME/$RRDRES*$RRDRES)) -s e-1h
  87
  88        Or in Perl:
  89
  90         perl -e '$ctime = time; $rrdres = 900; \
  91                  system "rrdtool fetch subdata.rrd AVERAGE \
  92                          -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
  93
  94    A\bAT\bT-\b-S\bST\bTY\bYL\bLE\bE T\bTI\bIM\bME\bE S\bSP\bPE\bEC\bCI\bIF\bFI\bIC\bCA\bAT\bTI\bIO\bON\bN
  95        Apart from the traditional _\bS_\be_\bc_\bo_\bn_\bd_\bs _\bs_\bi_\bn_\bc_\be _\be_\bp_\bo_\bc_\bh, RRDtool does also
  96        understand at-style time specification. The specification is called
  97        "at-style" after the Unix command _\ba_\bt(1) that has moderately complex
  98        ways to specify time to run your job at a certain date and time. The
  99        at-style specification consists of two parts: the T\bTI\bIM\bME\bE R\bRE\bEF\bFE\bER\bRE\bEN\bNC\bCE\bE
 100        specification and the T\bTI\bIM\bME\bE O\bOF\bFF\bFS\bSE\bET\bT specification.
 101
 102    T\bTI\bIM\bME\bE R\bRE\bEF\bFE\bER\bRE\bEN\bNC\bCE\bE S\bSP\bPE\bEC\bCI\bIF\bFI\bIC\bCA\bAT\bTI\bIO\bON\bN
 103        The time reference specification is used, well, to establish a
 104        reference moment in time (to which the time offset is then applied to).
 105        When present, it should come first, when omitted, it defaults to n\bno\bow\bw.
 106        On its own part, time reference consists of a _\bt_\bi_\bm_\be_\b-_\bo_\bf_\b-_\bd_\ba_\by reference
 107        (which should come first, if present) and a _\bd_\ba_\by reference.
 108
 109        The _\bt_\bi_\bm_\be_\b-_\bo_\bf_\b-_\bd_\ba_\by can be specified as H\bHH\bH:\b:M\bMM\bM, H\bHH\bH.\b.M\bMM\bM, or just H\bHH\bH. You can
 110        suffix it with a\bam\bm or p\bpm\bm or use 24-hours clock. Some special times of
 111        day are understood as well, including m\bmi\bid\bdn\bni\big\bgh\bht\bt (00:00), n\bno\boo\bon\bn (12:00)
 112        and British t\bte\bea\bat\bti\bim\bme\be (16:00).
 113
 114        The _\bd_\ba_\by can be specified as _\bm_\bo_\bn_\bt_\bh_\b-_\bn_\ba_\bm_\be _\bd_\ba_\by_\b-_\bo_\bf_\b-_\bt_\bh_\be_\b-_\bm_\bo_\bn_\bt_\bh and optional a
 115        2- or 4-digit _\by_\be_\ba_\br number (e.g. March 8 1999). Alternatively, you can
 116        use _\bd_\ba_\by_\b-_\bo_\bf_\b-_\bw_\be_\be_\bk_\b-_\bn_\ba_\bm_\be (e.g. Monday), or one of the words: y\bye\bes\bst\bte\ber\brd\bda\bay\by,
 117        t\bto\bod\bda\bay\by, t\bto\bom\bmo\bor\brr\bro\bow\bw. You can also specify the _\bd_\ba_\by as a full date in several
 118        numerical formats, including M\bMM\bM/\b/D\bDD\bD/\b/[\b[Y\bYY\bY]\b]Y\bYY\bY, D\bDD\bD.\b.M\bMM\bM.\b.[\b[Y\bYY\bY]\b]Y\bYY\bY, or Y\bYY\bYY\bYY\bYM\bMM\bMD\bDD\bD.
 119
 120        _\bN_\bO_\bT_\bE_\b1: this is different from the original _\ba_\bt(1) behavior, where a
 121        single-number date is interpreted as MMDD[YY]YY.
 122
 123        _\bN_\bO_\bT_\bE_\b2: if you specify the _\bd_\ba_\by in this way, the _\bt_\bi_\bm_\be_\b-_\bo_\bf_\b-_\bd_\ba_\by is REQUIRED
 124        as well.
 125
 126        Finally, you can use the words n\bno\bow\bw, s\bst\bta\bar\brt\bt, or e\ben\bnd\bd as your time
 127        reference. N\bNo\bow\bw refers to the current moment (and is also the default
 128        time reference). S\bSt\bta\bar\brt\bt (e\ben\bnd\bd) can be used to specify a time relative to
 129        the start (end) time for those tools that use these categories
 130        (r\brr\brd\bdf\bfe\bet\btc\bch\bh, rrdgraph).
 131
 132        Month and day of the week names can be used in their naturally
 133        abbreviated form (e.g., Dec for December, Sun for Sunday, etc.). The
 134        words n\bno\bow\bw, s\bst\bta\bar\brt\bt, e\ben\bnd\bd can be abbreviated as n\bn, s\bs, e\be.
 135
 136    T\bTI\bIM\bME\bE O\bOF\bFF\bFS\bSE\bET\bT S\bSP\bPE\bEC\bCI\bIF\bFI\bIC\bCA\bAT\bTI\bIO\bON\bN
 137        The time offset specification is used to add/subtract certain time
 138        intervals to/from the time reference moment. It consists of a _\bs_\bi_\bg_\bn
 139        (+\b+ or -\b-) and an _\ba_\bm_\bo_\bu_\bn_\bt. The following time units can be used to specify
 140        the _\ba_\bm_\bo_\bu_\bn_\bt: y\bye\bea\bar\brs\bs, m\bmo\bon\bnt\bth\bhs\bs, w\bwe\bee\bek\bks\bs, d\bda\bay\bys\bs, h\bho\bou\bur\brs\bs, m\bmi\bin\bnu\but\bte\bes\bs, or s\bse\bec\bco\bon\bnd\bds\bs.
 141        These units can be used in singular or plural form, and abbreviated
 142        naturally or to a single letter (e.g. +3days, -1wk, -3y). Several time
 143        units can be combined (e.g., -5mon1w2d) or concatenated (e.g., -5h45min
 144        = -5h-45min = -6h+15min = -7h+1h30m-15min, etc.)
 145
 146        _\bN_\bO_\bT_\bE_\b3: If you specify time offset in days, weeks, months, or years, you
 147        will end with the time offset that may vary depending on your time
 148        reference, because all those time units have no single well defined
 149        time interval value (1 year contains either 365 or 366 days, 1 month is
 150        28 to 31 days long, and even 1 day may be not equal to 24 hours twice a
 151        year, when DST-related clock adjustments take place).  To cope with
 152        this, when you use days, weeks, months, or years as your time offset
 153        units your time reference date is adjusted accordingly without too much
 154        further effort to ensure anything about it (in the hope that _\bm_\bk_\bt_\bi_\bm_\be(3)
 155        will take care of this later).  This may lead to some surprising (or
 156        even invalid!) results, e.g. 'May 31 -1month' = 'Apr 31' (meaningless)
 157        = 'May 1' (after _\bm_\bk_\bt_\bi_\bm_\be(3) normalization); in the EET timezone '3:30am
 158        Mar 29 1999 -1 day' yields '3:30am Mar 28 1999' (Sunday) which is an
 159        invalid time/date combination (because of 3am -> 4am DST forward clock
 160        adjustment, see the below example).
 161
 162        In contrast, hours, minutes, and seconds are well defined time
 163        intervals, and these are guaranteed to always produce time offsets
 164        exactly as specified (e.g. for EET timezone, '8:00 Mar 27 1999 +2 days'
 165        = '8:00 Mar 29 1999', but since there is 1-hour DST forward clock
 166        adjustment that occurs around 3:00 Mar 28 1999, the actual time
 167        interval between 8:00 Mar 27 1999 and 8:00 Mar 29 1999 equals 47 hours;
 168        on the other hand, '8:00 Mar 27 1999 +48 hours' = '9:00 Mar 29 1999',
 169        as expected)
 170
 171        _\bN_\bO_\bT_\bE_\b4: The single-letter abbreviation for both m\bmo\bon\bnt\bth\bhs\bs and m\bmi\bin\bnu\but\bte\bes\bs is m\bm.
 172        To disambiguate them, the parser tries to read your mind :) by applying
 173        the following two heuristics:
 174
 175        1. If m\bm is used in context of (i.e. right after the) years, months,
 176           weeks, or days it is assumed to mean m\bmo\bon\bnt\bth\bhs\bs, while in the context of
 177           hours, minutes, and seconds it means minutes.  (e.g., in -1y6m or
 178           +3w1m m\bm is interpreted as m\bmo\bon\bnt\bth\bhs\bs, while in -3h20m or +5s2m m\bm the
 179           parser decides for m\bmi\bin\bnu\but\bte\bes\bs).
 180
 181        2. Out of context (i.e. right after the +\b+ or -\b- sign) the meaning of m\bm
 182           is guessed from the number it directly follows.  Currently, if the
 183           number's absolute value is below 25 it is assumed that m\bm means
 184           m\bmo\bon\bnt\bth\bhs\bs, otherwise it is treated as m\bmi\bin\bnu\but\bte\bes\bs.  (e.g., -25m == -25
 185           minutes, while +24m == +24 months)
 186
 187        _\bF_\bi_\bn_\ba_\bl _\bN_\bO_\bT_\bE_\bS: Time specification is case-insensitive.  Whitespace can be
 188        inserted freely or omitted altogether.  There are, however, cases when
 189        whitespace is required (e.g., 'midnight Thu'). In this case you should
 190        either quote the whole phrase to prevent it from being taken apart by
 191        your shell or use '_' (underscore) or ',' (comma) which also count as
 192        whitespace (e.g., midnight_Thu or midnight,Thu).
 193
 194    T\bTI\bIM\bME\bE S\bSP\bPE\bEC\bCI\bIF\bFI\bIC\bCA\bAT\bTI\bIO\bON\bN E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
 195        _\bO_\bc_\bt _\b1_\b2 -- October 12 this year
 196
 197        _\b-_\b1_\bm_\bo_\bn_\bt_\bh or _\b-_\b1_\bm -- current time of day, only a month before (may yield
 198        surprises, see NOTE3 above).
 199
 200        _\bn_\bo_\bo_\bn _\by_\be_\bs_\bt_\be_\br_\bd_\ba_\by _\b-_\b3_\bh_\bo_\bu_\br_\bs -- yesterday morning; can also be specified as
 201        _\b9_\ba_\bm_\b-_\b1_\bd_\ba_\by.
 202
 203        _\b2_\b3_\b:_\b5_\b9 _\b3_\b1_\b._\b1_\b2_\b._\b1_\b9_\b9_\b9 -- 1 minute to the year 2000.
 204
 205        _\b1_\b2_\b/_\b3_\b1_\b/_\b9_\b9 _\b1_\b1_\b:_\b5_\b9_\bp_\bm -- 1 minute to the year 2000 for imperialists.
 206
 207        _\b1_\b2_\ba_\bm _\b0_\b1_\b/_\b0_\b1_\b/_\b0_\b1 -- start of the new millennium
 208
 209        _\be_\bn_\bd_\b-_\b3_\bw_\be_\be_\bk_\bs or _\be_\b-_\b3_\bw -- 3 weeks before end time (may be used as start
 210        time specification).
 211
 212        _\bs_\bt_\ba_\br_\bt_\b+_\b6_\bh_\bo_\bu_\br_\bs or _\bs_\b+_\b6_\bh -- 6 hours after start time (may be used as end
 213        time specification).
 214
 215        _\b9_\b3_\b1_\b2_\b2_\b5_\b5_\b3_\b7 -- 18:45  July 5th, 1999 (yes, seconds since 1970 are valid
 216        as well).
 217
 218        _\b1_\b9_\b9_\b7_\b0_\b7_\b0_\b3 _\b1_\b2_\b:_\b4_\b5 -- 12:45  July 3th, 1997 (my favorite, and its even got
 219        an ISO number (8601)).
 220
 221 A\bAU\bUT\bTH\bHO\bOR\bR
 222        Tobias Oetiker <tobi@oetiker.ch>
 223
 224
 225
 226 1.3.8                             2008-03-15                       RRDFETCH(1)