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] [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs]
  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 std-
  16        out. _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data is often represented by the string "NaN" depending
  17        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        -\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs
  43                Address of the rrdcached daemon. If specified, a "flush" com-
  44                mand is sent to the server before reading the RRD files. This
  45                allows r\brr\brd\bdt\bto\boo\bol\bl to return fresh data even if the daemon is con-
  46                figured to cache values for a long time.  For a list of
  47                accepted formats, see the -\b-l\bl option in the rrdcached manual.
  48
  49                 rrdtool fetch --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd AVERAGE
  50
  51        R\bRE\bES\bSO\bOL\bLU\bUT\bTI\bIO\bON\bN I\bIN\bNT\bTE\bER\bRV\bVA\bAL\bL
  52
  53        In order to get RRDtool to fetch anything other than the finest resolu-
  54        tion RRA b\bbo\bot\bth\bh the start and end time must be specified on boundaries
  55        that are multiples of the desired resolution. Consider the following
  56        example:
  57
  58         rrdtool create subdata.rrd -s 10 DS:ds0:GAUGE:300:0:U \
  59          RRA:AVERAGE:0.5:30:3600 \
  60          RRA:AVERAGE:0.5:90:1200 \
  61          RRA:AVERAGE:0.5:360:1200 \
  62          RRA:MAX:0.5:360:1200 \
  63          RRA:AVERAGE:0.5:8640:600 \
  64          RRA:MAX:0.5:8640:600
  65
  66        This RRD collects data every 10 seconds and stores its averages over 5
  67        minutes, 15 minutes, 1 hour, and 1 day, as well as the maxima for 1
  68        hour and 1 day.
  69
  70        Consider now that you want to fetch the 15 minute average data for the
  71        last hour.  You might try
  72
  73         rrdtool fetch subdata.rrd AVERAGE -r 900 -s -1h
  74
  75        However, this will almost always result in a time series that is N\bNO\bOT\bT in
  76        the 15 minute RRA. Therefore, the highest resolution RRA, i.e. 5 minute
  77        averages, will be chosen which in this case is not what you want.
  78
  79        Hence, make sure that
  80
  81        1. both start and end time are a multiple of 900
  82
  83        2. both start and end time are within the desired RRA
  84
  85        So, if time now is called "t", do
  86
  87         end time == int(t/900)*900,
  88         start time == end time - 1hour,
  89         resolution == 900.
  90
  91        Using the bash shell, this could look be:
  92
  93         TIME=$(date +%s)
  94         RRDRES=900
  95         rrdtool fetch subdata.rrd AVERAGE -r $RRDRES \
  96            -e $(($TIME/$RRDRES*$RRDRES)) -s e-1h
  97
  98        Or in Perl:
  99
 100         perl -e '$ctime = time; $rrdres = 900; \
 101                  system "rrdtool fetch subdata.rrd AVERAGE \
 102                          -r $rrdres -e @{[int($ctime/$rrdres)*$rrdres]} -s e-1h"'
 103
 104        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
 105
 106        Apart from the traditional _\bS_\be_\bc_\bo_\bn_\bd_\bs _\bs_\bi_\bn_\bc_\be _\be_\bp_\bo_\bc_\bh, RRDtool does also
 107        understand at-style time specification. The specification is called
 108        "at-style" after the Unix command _\ba_\bt(1) that has moderately complex
 109        ways to specify time to run your job at a certain date and time. The
 110        at-style specification consists of two parts: the T\bTI\bIM\bME\bE R\bRE\bEF\bFE\bER\bRE\bEN\bNC\bCE\bE speci-
 111        fication and the T\bTI\bIM\bME\bE O\bOF\bFF\bFS\bSE\bET\bT specification.
 112
 113        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
 114
 115        The time reference specification is used, well, to establish a refer-
 116        ence moment in time (to which the time offset is then applied to). When
 117        present, it should come first, when omitted, it defaults to n\bno\bow\bw. On its
 118        own part, time reference consists of a _\bt_\bi_\bm_\be_\b-_\bo_\bf_\b-_\bd_\ba_\by reference (which
 119        should come first, if present) and a _\bd_\ba_\by reference.
 120
 121        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
 122        suffix it with a\bam\bm or p\bpm\bm or use 24-hours clock. Some special times of
 123        day are understood as well, including m\bmi\bid\bdn\bni\big\bgh\bht\bt (00:00), n\bno\boo\bon\bn (12:00)
 124        and British t\bte\bea\bat\bti\bim\bme\be (16:00).
 125
 126        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
 127        2- or 4-digit _\by_\be_\ba_\br number (e.g. March 8 1999). Alternatively, you can
 128        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,
 129        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
 130        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.
 131
 132        _\bN_\bO_\bT_\bE_\b1: this is different from the original _\ba_\bt(1) behavior, where a
 133        single-number date is interpreted as MMDD[YY]YY.
 134
 135        _\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
 136        as well.
 137
 138        Finally, you can use the words n\bno\bow\bw, s\bst\bta\bar\brt\bt, or e\ben\bnd\bd as your time refer-
 139        ence. N\bNo\bow\bw refers to the current moment (and is also the default time
 140        reference). S\bSt\bta\bar\brt\bt (e\ben\bnd\bd) can be used to specify a time relative to the
 141        start (end) time for those tools that use these categories (r\brr\brd\bdf\bfe\bet\btc\bch\bh,
 142        rrdgraph).
 143
 144        Month and day of the week names can be used in their naturally abbrevi-
 145        ated form (e.g., Dec for December, Sun for Sunday, etc.). The words
 146        n\bno\bow\bw, s\bst\bta\bar\brt\bt, e\ben\bnd\bd can be abbreviated as n\bn, s\bs, e\be.
 147
 148        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
 149
 150        The time offset specification is used to add/subtract certain time
 151        intervals to/from the time reference moment. It consists of a _\bs_\bi_\bg_\bn
 152        (+\b+ or -\b-) and an _\ba_\bm_\bo_\bu_\bn_\bt. The following time units can be used to specify
 153        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.
 154        These units can be used in singular or plural form, and abbreviated
 155        naturally or to a single letter (e.g. +3days, -1wk, -3y). Several time
 156        units can be combined (e.g., -5mon1w2d) or concatenated (e.g., -5h45min
 157        = -5h-45min = -6h+15min = -7h+1h30m-15min, etc.)
 158
 159        _\bN_\bO_\bT_\bE_\b3: If you specify time offset in days, weeks, months, or years, you
 160        will end with the time offset that may vary depending on your time ref-
 161        erence, because all those time units have no single well defined time
 162        interval value (1 year contains either 365 or 366 days, 1 month is 28
 163        to 31 days long, and even 1 day may be not equal to 24 hours twice a
 164        year, when DST-related clock adjustments take place).  To cope with
 165        this, when you use days, weeks, months, or years as your time offset
 166        units your time reference date is adjusted accordingly without too much
 167        further effort to ensure anything about it (in the hope that _\bm_\bk_\bt_\bi_\bm_\be(3)
 168        will take care of this later).  This may lead to some surprising (or
 169        even invalid!) results, e.g. 'May 31 -1month' = 'Apr 31' (meaningless)
 170        = 'May 1' (after _\bm_\bk_\bt_\bi_\bm_\be(3) normalization); in the EET timezone '3:30am
 171        Mar 29 1999 -1 day' yields '3:30am Mar 28 1999' (Sunday) which is an
 172        invalid time/date combination (because of 3am -> 4am DST forward clock
 173        adjustment, see the below example).
 174
 175        In contrast, hours, minutes, and seconds are well defined time inter-
 176        vals, and these are guaranteed to always produce time offsets exactly
 177        as specified (e.g. for EET timezone, '8:00 Mar 27 1999 +2 days' =
 178        '8:00 Mar 29 1999', but since there is 1-hour DST forward clock adjust-
 179        ment that occurs around 3:00 Mar 28 1999, the actual time interval
 180        between 8:00 Mar 27 1999 and 8:00 Mar 29 1999 equals 47 hours; on the
 181        other hand, '8:00 Mar 27 1999 +48 hours' = '9:00 Mar 29 1999', as
 182        expected)
 183
 184        _\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.
 185        To disambiguate them, the parser tries to read your mind :) by applying
 186        the following two heuristics:
 187
 188        1  If m\bm is used in context of (i.e. right after the) years, months,
 189           weeks, or days it is assumed to mean m\bmo\bon\bnt\bth\bhs\bs, while in the context of
 190           hours, minutes, and seconds it means minutes.  (e.g., in -1y6m or
 191           +3w1m m\bm is interpreted as m\bmo\bon\bnt\bth\bhs\bs, while in -3h20m or +5s2m m\bm the
 192           parser decides for m\bmi\bin\bnu\but\bte\bes\bs).
 193
 194        2  Out of context (i.e. right after the +\b+ or -\b- sign) the meaning of m\bm
 195           is guessed from the number it directly follows.  Currently, if the
 196           number's absolute value is below 25 it is assumed that m\bm means
 197           m\bmo\bon\bnt\bth\bhs\bs, otherwise it is treated as m\bmi\bin\bnu\but\bte\bes\bs.  (e.g., -25m == -25 min-
 198           utes, while +24m == +24 months)
 199
 200        _\bF_\bi_\bn_\ba_\bl _\bN_\bO_\bT_\bE_\bS: Time specification is case-insensitive.  Whitespace can be
 201        inserted freely or omitted altogether.  There are, however, cases when
 202        whitespace is required (e.g., 'midnight Thu'). In this case you should
 203        either quote the whole phrase to prevent it from being taken apart by
 204        your shell or use '_' (underscore) or ',' (comma) which also count as
 205        whitespace (e.g., midnight_Thu or midnight,Thu).
 206
 207        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
 208
 209        _\bO_\bc_\bt _\b1_\b2 -- October 12 this year
 210
 211        _\b-_\b1_\bm_\bo_\bn_\bt_\bh or _\b-_\b1_\bm -- current time of day, only a month before (may yield
 212        surprises, see NOTE3 above).
 213
 214        _\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
 215        _\b9_\ba_\bm_\b-_\b1_\bd_\ba_\by.
 216
 217        _\b2_\b3_\b:_\b5_\b9 _\b3_\b1_\b._\b1_\b2_\b._\b1_\b9_\b9_\b9 -- 1 minute to the year 2000.
 218
 219        _\b1_\b2_\b/_\b3_\b1_\b/_\b9_\b9 _\b1_\b1_\b:_\b5_\b9_\bp_\bm -- 1 minute to the year 2000 for imperialists.
 220
 221        _\b1_\b2_\ba_\bm _\b0_\b1_\b/_\b0_\b1_\b/_\b0_\b1 -- start of the new millennium
 222
 223        _\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
 224        time specification).
 225
 226        _\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
 227        time specification).
 228
 229        _\b9_\b3_\b1_\b2_\b2_\b5_\b5_\b3_\b7 -- 18:45  July 5th, 1999 (yes, seconds since 1970 are valid
 230        as well).
 231
 232        _\b1_\b9_\b9_\b7_\b0_\b7_\b0_\b3 _\b1_\b2_\b:_\b4_\b5 -- 12:45  July 3th, 1997 (my favorite, and its even got
 233        an ISO number (8601)).
 234
 235 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
 236        The following environment variables may be used to change the behavior
 237        of "rrdtool fetch":
 238
 239        R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS
 240            If this environment variable is set it will have the same effect as
 241            specifying the "--daemon" option on the command line. If both are
 242            present, the command line argument takes precedence.
 243
 244 A\bAU\bUT\bTH\bHO\bOR\bR
 245        Tobias Oetiker <tobi@oetiker.ch>
 246
 247
 248
 249 1.3.99909060808                   2008-09-25                       RRDFETCH(1)