Code

Imported upstream version 1.3rc9.
[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">
12 <p><a name="__index__"></a></p>
13 <!-- INDEX BEGIN -->
14 <!--
16 <ul>
18         <li><a href="#name">NAME</a></li>
19         <li><a href="#synopsis">SYNOPSIS</a></li>
20         <li><a href="#description">DESCRIPTION</a></li>
21         <li><a href="#example">EXAMPLE</a></li>
22         <li><a href="#author">AUTHOR</a></li>
23 </ul>
24 -->
25 <!-- INDEX END -->
27 <p>
28 </p>
29 <h1><a name="name">NAME</a></h1>
30 <p>rrdinfo - extract header information from an RRD</p>
31 <p>
32 </p>
33 <hr />
34 <h1><a name="synopsis">SYNOPSIS</a></h1>
35 <p><strong>rrdtool</strong> <strong>info</strong> <em>filename.rrd</em></p>
36 <p>
37 </p>
38 <hr />
39 <h1><a name="description">DESCRIPTION</a></h1>
40 <p>The <strong>info</strong> function prints the header information from an RRD in
41 a parsing friendly format.</p>
42 <p>Check <a href="././rrdcreate.html">the rrdcreate manpage</a> if you are uncertain about the meaning of the
43 individual keys.</p>
44 <p>
45 </p>
46 <hr />
47 <h1><a name="example">EXAMPLE</a></h1>
48 <p>This is the output generated by running <strong>info</strong> on a simple RRD which
49 contains two data sources and one RRA. Note that the number after the
50 <em>last_update</em> keyword is in seconds since 1970. The string <strong>NaN</strong>
51 stands for <em>*UNKNOWN*</em> data. In the example it means that this RRD
52 has neither minimum nor maximum values defined for either of its
53 data sources.</p>
54 <pre>
55  filename = &quot;random.rrd&quot;
56  rrd_version = &quot;0001&quot;
57  step = 300
58  last_update = 955892996
59  ds[a].type = &quot;GAUGE&quot;
60  ds[a].minimal_heartbeat = 600
61  ds[a].min = NaN
62  ds[a].max = NaN
63  ds[a].last_ds = &quot;UNKN&quot;
64  ds[a].value = 2.1824421548e+04
65  ds[a].unknown_sec = 0
66  ds[b].type = &quot;GAUGE&quot;
67  ds[b].minimal_heartbeat = 600
68  ds[b].min = NaN
69  ds[b].max = NaN
70  ds[b].last_ds = &quot;UNKN&quot;
71  ds[b].value = 3.9620838224e+03
72  ds[b].unknown_sec = 0
73  rra[0].cf = &quot;AVERAGE&quot;
74  rra[0].pdp_per_row = 1
75  rra[0].cdp_prep[0].value = nan
76  rra[0].cdp_prep[0].unknown_datapoints = 0
77  rra[0].cdp_prep[1].value = nan
78  rra[0].cdp_prep[1].unknown_datapoints = 0</pre>
79 <dl>
80 <dt><strong><a name="item_filename_2errd"><em>filename.rrd</em></a></strong></dt>
82 <dd>
83 <p>The name of the <strong>RRD</strong> you want to examine.</p>
84 </dd>
85 </dl>
86 <p>
87 </p>
88 <hr />
89 <h1><a name="author">AUTHOR</a></h1>
90 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
92 </body>
94 </html>