Code

Imported upstream version 1.3.8.
[pkg-rrdtool.git] / doc / rrdinfo.html
1 <?xml version="1.0" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <title>rrdinfo</title>
6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
7 <link rev="made" href="mailto:root@localhost" />
8 </head>
10 <body style="background-color: white">
13 <!-- INDEX BEGIN -->
14 <div name="index">
15 <p><a name="__index__"></a></p>
16 <!--
18 <ul>
20         <li><a href="#name">NAME</a></li>
21         <li><a href="#synopsis">SYNOPSIS</a></li>
22         <li><a href="#description">DESCRIPTION</a></li>
23         <li><a href="#example">EXAMPLE</a></li>
24         <li><a href="#author">AUTHOR</a></li>
25 </ul>
27 -->
30 </div>
31 <!-- INDEX END -->
33 <p>
34 </p>
35 <h1><a name="name">NAME</a></h1>
36 <p>rrdinfo - extract header information from an RRD</p>
37 <p>
38 </p>
39 <hr />
40 <h1><a name="synopsis">SYNOPSIS</a></h1>
41 <p><strong>rrdtool</strong> <strong>info</strong> <em>filename.rrd</em></p>
42 <p>
43 </p>
44 <hr />
45 <h1><a name="description">DESCRIPTION</a></h1>
46 <p>The <strong>info</strong> function prints the header information from an RRD in
47 a parsing friendly format.</p>
48 <p>Check <a href="././rrdcreate.html">the rrdcreate manpage</a> if you are uncertain about the meaning of the
49 individual keys.</p>
50 <p>
51 </p>
52 <hr />
53 <h1><a name="example">EXAMPLE</a></h1>
54 <p>This is the output generated by running <strong>info</strong> on a simple RRD which
55 contains two data sources and one RRA. Note that the number after the
56 <em>last_update</em> keyword is in seconds since 1970. The string <strong>NaN</strong>
57 stands for <em>*UNKNOWN*</em> data. In the example it means that this RRD
58 has neither minimum nor maximum values defined for either of its
59 data sources.</p>
60 <pre>
61  filename = &quot;random.rrd&quot;
62  rrd_version = &quot;0001&quot;
63  step = 300
64  last_update = 955892996
65  ds[a].type = &quot;GAUGE&quot;
66  ds[a].minimal_heartbeat = 600
67  ds[a].min = NaN
68  ds[a].max = NaN
69  ds[a].last_ds = &quot;UNKN&quot;
70  ds[a].value = 2.1824421548e+04
71  ds[a].unknown_sec = 0
72  ds[b].type = &quot;GAUGE&quot;
73  ds[b].minimal_heartbeat = 600
74  ds[b].min = NaN
75  ds[b].max = NaN
76  ds[b].last_ds = &quot;UNKN&quot;
77  ds[b].value = 3.9620838224e+03
78  ds[b].unknown_sec = 0
79  rra[0].cf = &quot;AVERAGE&quot;
80  rra[0].pdp_per_row = 1
81  rra[0].cdp_prep[0].value = nan
82  rra[0].cdp_prep[0].unknown_datapoints = 0
83  rra[0].cdp_prep[1].value = nan
84  rra[0].cdp_prep[1].unknown_datapoints = 0</pre>
85 <dl>
86 <dt><strong><a name="filename_rrd" class="item"><em>filename.rrd</em></a></strong></dt>
88 <dd>
89 <p>The name of the <strong>RRD</strong> you want to examine.</p>
90 </dd>
91 </dl>
92 <p>
93 </p>
94 <hr />
95 <h1><a name="author">AUTHOR</a></h1>
96 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
98 </body>
100 </html>