doc/rrdinfo.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <title>rrdinfo</title>
   5 <link rev="made" href="mailto:root@localhost" />
   6 </head>
   7
   8 <body style="background-color: white">
   9
  10 <p><a name="__index__"></a></p>
  11 <!-- INDEX BEGIN -->
  12 <!--
  13
  14 <ul>
  15
  16         <li><a href="#name">NAME</a></li>
  17         <li><a href="#synopsis">SYNOPSIS</a></li>
  18         <li><a href="#description">DESCRIPTION</a></li>
  19         <li><a href="#example">EXAMPLE</a></li>
  20         <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
  21         <li><a href="#author">AUTHOR</a></li>
  22 </ul>
  23 -->
  24 <!-- INDEX END -->
  25
  26 <p>
  27 </p>
  28 <h1><a name="name">NAME</a></h1>
  29 <p>rrdinfo - extract header information from an RRD</p>
  30 <p>
  31 </p>
  32 <hr />
  33 <h1><a name="synopsis">SYNOPSIS</a></h1>
  34 <p><strong>rrdtool</strong> <strong>info</strong> <em>filename</em>
  35 [<strong>--daemon</strong>&nbsp;<em>address</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 <dl>
  45 <dt><strong><a name="item_filename"><em>filename</em></a></strong><br />
  46 </dt>
  47 <dd>
  48 The name of the <strong>RRD</strong> you want to examine.
  49 </dd>
  50 <p></p>
  51 <dt><strong><a name="item__2d_2ddaemon_address"><strong>--daemon</strong> <em>address</em></a></strong><br />
  52 </dt>
  53 <dd>
  54 Address of the <a href="././rrdcached.html">the rrdcached manpage</a> daemon. If specified, a <code>flush</code> command is sent
  55 to the server before reading the RRD files. This allows <strong>rrdtool</strong> to return
  56 fresh data even if the daemon is configured to cache values for a long time.
  57 For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.
  58 </dd>
  59 <dd>
  60 <pre>
  61  rrdtool info --daemon unix:/var/run/rrdcached.sock /var/lib/rrd/foo.rrd</pre>
  62 </dd>
  63 <p></p></dl>
  64 <p>
  65 </p>
  66 <hr />
  67 <h1><a name="example">EXAMPLE</a></h1>
  68 <p>This is the output generated by running <strong>info</strong> on a simple RRD which
  69 contains two data sources and one RRA. Note that the number after the
  70 <em>last_update</em> keyword is in seconds since 1970. The string <strong>NaN</strong>
  71 stands for <em>*UNKNOWN*</em> data. In the example it means that this RRD
  72 has neither minimum nor maximum values defined for either of its
  73 data sources.</p>
  74 <pre>
  75  filename = &quot;random.rrd&quot;
  76  rrd_version = &quot;0001&quot;
  77  step = 300
  78  last_update = 955892996
  79  header_size = 2872
  80  ds[a].type = &quot;GAUGE&quot;
  81  ds[a].minimal_heartbeat = 600
  82  ds[a].min = NaN
  83  ds[a].max = NaN
  84  ds[a].last_ds = &quot;UNKN&quot;
  85  ds[a].value = 2.1824421548e+04
  86  ds[a].unknown_sec = 0
  87  ds[b].type = &quot;GAUGE&quot;
  88  ds[b].minimal_heartbeat = 600
  89  ds[b].min = NaN
  90  ds[b].max = NaN
  91  ds[b].last_ds = &quot;UNKN&quot;
  92  ds[b].value = 3.9620838224e+03
  93  ds[b].unknown_sec = 0
  94  rra[0].cf = &quot;AVERAGE&quot;
  95  rra[0].pdp_per_row = 1
  96  rra[0].cdp_prep[0].value = nan
  97  rra[0].cdp_prep[0].unknown_datapoints = 0
  98  rra[0].cdp_prep[1].value = nan
  99  rra[0].cdp_prep[1].unknown_datapoints = 0</pre>
 100 <p>
 101 </p>
 102 <hr />
 103 <h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
 104 <p>The following environment variables may be used to change the behavior of
 105 <code>rrdtoolinfo</code>:</p>
 106 <dl>
 107 <dt><strong><a name="item_rrdcached_address"><strong>RRDCACHED_ADDRESS</strong></a></strong><br />
 108 </dt>
 109 <dd>
 110 If this environment variable is set it will have the same effect as specifying
 111 the <code>--daemon</code> option on the command line. If both are present, the command
 112 line argument takes precedence.
 113 </dd>
 114 <p></p></dl>
 115 <p>
 116 </p>
 117 <hr />
 118 <h1><a name="author">AUTHOR</a></h1>
 119 <p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 120
 121 </body>
 122
 123 </html>