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