Code

Imported upstream version 1.4.8
[pkg-rrdtool.git] / doc / rrdinfo.txt
1 RRDINFO(1)                          rrdtool                         RRDINFO(1)
5 N\bNA\bAM\bME\bE
6        rrdinfo - extract header information from an RRD
8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
9        r\brr\brd\bdt\bto\boo\bol\bl i\bin\bnf\bfo\bo _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be [-\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs]
11 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
12        The i\bin\bnf\bfo\bo function prints the header information from an RRD in a
13        parsing friendly format.
15        Check rrdcreate if you are uncertain about the meaning of the
16        individual keys.
18        _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
19                The name of the R\bRR\bRD\bD you want to examine.
21        -\b--\b-d\bda\bae\bem\bmo\bon\bn _\ba_\bd_\bd_\br_\be_\bs_\bs
22                Address of the rrdcached daemon. If specified, a "flush"
23                command is sent to the server before reading the RRD files.
24                This allows r\brr\brd\bdt\bto\boo\bol\bl to return fresh data even if the daemon is
25                configured to cache values for a long time.  For a list of
26                accepted formats, see the -\b-l\bl option in the rrdcached manual.
28                 rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd
30 E\bEX\bXA\bAM\bMP\bPL\bLE\bE
31        This is the output generated by running i\bin\bnf\bfo\bo on a simple RRD which
32        contains two data sources and one RRA. Note that the number after the
33        _\bl_\ba_\bs_\bt_\b__\bu_\bp_\bd_\ba_\bt_\be keyword is in seconds since 1970. The string N\bNa\baN\bN stands for
34        _\b*_\bU_\bN_\bK_\bN_\bO_\bW_\bN_\b* data. In the example it means that this RRD has neither
35        minimum nor maximum values defined for either of its data sources.
37         filename = "random.rrd"
38         rrd_version = "0001"
39         step = 300
40         last_update = 955892996
41         header_size = 2872
42         ds[a].type = "GAUGE"
43         ds[a].minimal_heartbeat = 600
44         ds[a].min = NaN
45         ds[a].max = NaN
46         ds[a].last_ds = "UNKN"
47         ds[a].value = 2.1824421548e+04
48         ds[a].unknown_sec = 0
49         ds[b].type = "GAUGE"
50         ds[b].minimal_heartbeat = 600
51         ds[b].min = NaN
52         ds[b].max = NaN
53         ds[b].last_ds = "UNKN"
54         ds[b].value = 3.9620838224e+03
55         ds[b].unknown_sec = 0
56         rra[0].cf = "AVERAGE"
57         rra[0].pdp_per_row = 1
58         rra[0].cdp_prep[0].value = nan
59         rra[0].cdp_prep[0].unknown_datapoints = 0
60         rra[0].cdp_prep[1].value = nan
61         rra[0].cdp_prep[1].unknown_datapoints = 0
63 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT V\bVA\bAR\bRI\bIA\bAB\bBL\bLE\bES\bS
64        The following environment variables may be used to change the behavior
65        of "rrdtool info":
67        R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS
68            If this environment variable is set it will have the same effect as
69            specifying the "--daemon" option on the command line. If both are
70            present, the command line argument takes precedence.
72 A\bAU\bUT\bTH\bHO\bOR\bR
73        Tobias Oetiker <tobi@oetiker.ch>
77 1.4.8                             2013-05-23                        RRDINFO(1)