~ubuntu-branches/ubuntu/saucy/rrdtool/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/rrdupdate.html

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2010-07-22 08:07:01 UTC
  • mfrom: (1.2.8 upstream) (3.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100722080701-k46mgdfz6euxwqsm
Tags: 1.4.3-1ubuntu1
* Merge from debian unstable, Remaining changes:
  - debian/control: Don't build against ruby1.9 as we don't want
    it in main.
* require libdbi >= 0.8.3 to prevent aborts when using dbi datasources

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
        <li><a href="#name">NAME</a></li>
21
21
        <li><a href="#synopsis">SYNOPSIS</a></li>
22
22
        <li><a href="#description">DESCRIPTION</a></li>
23
 
        <li><a href="#example">EXAMPLE</a></li>
24
 
        <li><a href="#author">AUTHOR</a></li>
 
23
        <li><a href="#environment_variables">ENVIRONMENT VARIABLES</a></li>
 
24
        <li><a href="#examples">EXAMPLES</a></li>
 
25
        <li><a href="#authors">AUTHORS</a></li>
25
26
</ul>
26
27
 
27
28
-->
40
41
<h1><a name="synopsis">SYNOPSIS</a></h1>
41
42
<p><strong>rrdtool</strong> {<strong>update</strong> | <strong>updatev</strong>} <em>filename</em>
42
43
[<strong>--template</strong>|<strong>-t</strong>&nbsp;<em>ds-name</em>[<strong>:</strong><em>ds-name</em>]...]
 
44
[<strong>--daemon</strong>&nbsp;<em>address</em>] [<strong>--</strong>]
43
45
<strong>N</strong>|<em>timestamp</em><strong>:</strong><em>value</em>[<strong>:</strong><em>value</em>...]
44
46
<em>at-timestamp</em><strong>@</strong><em>value</em>[<strong>:</strong><em>value</em>...]
45
47
[<em>timestamp</em><strong>:</strong><em>value</em>[<strong>:</strong><em>value</em>...]&nbsp;...]</p>
62
64
RRA (consolidation function and PDPs per CDP), and data source (name).
63
65
Note that depending on the arguments of the current and previous call to
64
66
update, the list may have no entries or a large number of entries.</p>
 
67
<p>Since <strong>updatev</strong> requires direct disk access, the <strong>--daemon</strong> option cannot be
 
68
used with this command.</p>
65
69
</dd>
66
70
<dt><strong><a name="filename" class="item"><em>filename</em></a></strong></dt>
67
71
 
89
93
using the template switch), <strong>RRDtool</strong> will ignore the value specified
90
94
for the COMPUTE <strong>DST</strong>.</p>
91
95
</dd>
 
96
<dt><strong><a name="daemon_address" class="item"><strong>--daemon</strong> <em>address</em></a></strong></dt>
 
97
 
 
98
<dd>
 
99
<p>If given, <strong>RRDTool</strong> will try to connect to the caching daemon <a href="././rrdcached.html">the rrdcached manpage</a>
 
100
at <em>address</em> and will fail if the connection cannot be established. If the
 
101
connection is successfully established the values will be sent to the daemon
 
102
instead of accessing the files directly.</p>
 
103
<p>For a list of accepted formats, see the <strong>-l</strong> option in the <a href="././rrdcached.html">the rrdcached manpage</a> manual.</p>
 
104
</dd>
92
105
<dt><strong><a name="n_timestamp_value_value" class="item"><strong>N</strong>|<em>timestamp</em><strong>:</strong><em>value</em>[<strong>:</strong><em>value</em>...]</a></strong></dt>
93
106
 
94
107
<dd>
102
115
timing right to the second is especially important when you are
103
116
working with data-sources of type <strong>COUNTER</strong>, <strong>DERIVE</strong> or
104
117
<strong>ABSOLUTE</strong>.</p>
 
118
<p>When using negative time values, options and data have to be separated
 
119
by two dashes (<strong>--</strong>), else the time value would be parsed as an option.
 
120
See below for an example.</p>
 
121
<p>When using negative time values, options and data have to be separated
 
122
by two dashes (<strong>--</strong>), else the time value would be parsed as an option.
 
123
See below for an example.</p>
105
124
<p>The remaining elements of the argument are DS updates. The order of
106
125
this list is the same as the order the data sources were defined in
107
126
the RRA. If there is no data for a certain data-source, the letter
116
135
<p>
117
136
</p>
118
137
<hr />
119
 
<h1><a name="example">EXAMPLE</a></h1>
 
138
<h1><a name="environment_variables">ENVIRONMENT VARIABLES</a></h1>
 
139
<p>The following environment variables may be used to change the behavior of
 
140
<code>rrdtoolupdate</code>:</p>
 
141
<dl>
 
142
<dt><strong><a name="rrdcached_address" class="item"><strong>RRDCACHED_ADDRESS</strong></a></strong></dt>
 
143
 
 
144
<dd>
 
145
<p>If this environment variable is set it will have the same effect as specifying
 
146
the <code>--daemon</code> option on the command line. If both are present, the command
 
147
line argument takes precedence.</p>
 
148
</dd>
 
149
</dl>
 
150
<p>
 
151
</p>
 
152
<hr />
 
153
<h1><a name="examples">EXAMPLES</a></h1>
 
154
<ul>
 
155
<li>
120
156
<p><code>rrdtool update demo1.rrd N:3.44:3.15:U:23</code></p>
121
157
<p>Update the database file demo1.rrd with 3 known and one <em>*UNKNOWN*</em>
122
158
value. Use the current time as the update time.</p>
 
159
</li>
 
160
<li>
123
161
<p><code>rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7</code></p>
124
162
<p>Update the database file demo2.rrd which expects data from a single
125
163
data-source, three times. First with an <em>*UNKNOWN*</em> value then with two
126
164
regular readings. The update interval seems to be around 300 seconds.</p>
 
165
</li>
 
166
<li>
 
167
<p><code>rrdtool update demo3.rrd -- -5:21 N:42</code></p>
 
168
<p>Update the database file demo3.rrd two times, using five seconds in the
 
169
past and the current time as the update times.</p>
 
170
</li>
 
171
<li>
 
172
<p><code>rrdtool update --cache /var/lib/rrd/demo3.rrd N:42</code></p>
 
173
<p>Update the file <code>/var/lib/rrd/demo3.rrd</code> with a single data source, using the
 
174
current time. If the caching daemon cannot be reached, do <strong>not</strong> fall back to
 
175
direct file access.</p>
 
176
</li>
 
177
<li>
 
178
<p><code>rrdtool update --daemon unix:/tmp/rrdd.sock demo4.rrd N:23</code></p>
 
179
<p>Use the UNIX domain socket <code>/tmp/rrdd.sock</code> to contact the caching daemon. If
 
180
the caching daemon is not available, update the file <code>demo4.rrd</code> directly.
 
181
<strong>WARNING:</strong> Since a relative path is specified, the following disturbing effect
 
182
may occur: If the daemon is available, the file relative to the working
 
183
directory <strong>of the daemon</strong> is used. If the daemon is not available, the file
 
184
relative to the current working directory of the invoking process is used.
 
185
<strong>This may update two different files depending on whether the daemon could be
 
186
reached or not.</strong> Don't do relative paths, kids!</p>
 
187
</li>
 
188
</ul>
127
189
<p>
128
190
</p>
129
191
<hr />
130
 
<h1><a name="author">AUTHOR</a></h1>
131
 
<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 
192
<h1><a name="authors">AUTHORS</a></h1>
 
193
<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;,
 
194
Florian Forster &lt;octo&nbsp;at&nbsp;verplant.org&gt;</p>
132
195
 
133
196
</body>
134
197