~ubuntu-branches/ubuntu/maverick/rrdtool/maverick

« back to all changes in this revision

Viewing changes to doc/rrdupdate.pod

  • 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:
6
6
 
7
7
B<rrdtool> {B<update> | B<updatev>} I<filename>
8
8
S<[B<--template>|B<-t> I<ds-name>[B<:>I<ds-name>]...]>
 
9
S<[B<--daemon> I<address>]> [B<-->]
9
10
S<B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]>
10
11
S<I<at-timestamp>B<@>I<value>[B<:>I<value>...]>
11
12
S<[I<timestamp>B<:>I<value>[B<:>I<value>...] ...]>
29
30
Note that depending on the arguments of the current and previous call to
30
31
update, the list may have no entries or a large number of entries.
31
32
 
 
33
Since B<updatev> requires direct disk access, the B<--daemon> option cannot be
 
34
used with this command.
 
35
 
32
36
=item I<filename>
33
37
 
34
38
The name of the B<RRD> you want to update.
56
60
using the template switch), B<RRDtool> will ignore the value specified
57
61
for the COMPUTE B<DST>.
58
62
 
 
63
=item B<--daemon> I<address>
 
64
 
 
65
If given, B<RRDTool> will try to connect to the caching daemon L<rrdcached>
 
66
at I<address> and will fail if the connection cannot be established. If the
 
67
connection is successfully established the values will be sent to the daemon
 
68
instead of accessing the files directly.
 
69
 
 
70
For a list of accepted formats, see the B<-l> option in the L<rrdcached> manual.
 
71
 
59
72
=item B<N>|I<timestamp>B<:>I<value>[B<:>I<value>...]
60
73
 
61
74
The data used for updating the RRD was acquired at a certain
69
82
working with data-sources of type B<COUNTER>, B<DERIVE> or
70
83
B<ABSOLUTE>.
71
84
 
 
85
When using negative time values, options and data have to be separated
 
86
by two dashes (B<-->), else the time value would be parsed as an option.
 
87
See below for an example.
 
88
 
 
89
When using negative time values, options and data have to be separated
 
90
by two dashes (B<-->), else the time value would be parsed as an option.
 
91
See below for an example.
 
92
 
72
93
The remaining elements of the argument are DS updates. The order of
73
94
this list is the same as the order the data sources were defined in
74
95
the RRA. If there is no data for a certain data-source, the letter
82
103
 
83
104
=back
84
105
 
85
 
=head1 EXAMPLE
 
106
=head1 ENVIRONMENT VARIABLES
 
107
 
 
108
The following environment variables may be used to change the behavior of
 
109
C<rrdtoolE<nbsp>update>:
 
110
 
 
111
=over
 
112
 
 
113
=item B<RRDCACHED_ADDRESS>
 
114
 
 
115
If this environment variable is set it will have the same effect as specifying
 
116
the C<--daemon> option on the command line. If both are present, the command
 
117
line argument takes precedence.
 
118
 
 
119
=back
 
120
 
 
121
=head1 EXAMPLES
 
122
 
 
123
=over
 
124
 
 
125
=item *
86
126
 
87
127
C<rrdtool update demo1.rrd N:3.44:3.15:U:23>
88
128
 
89
129
Update the database file demo1.rrd with 3 known and one I<*UNKNOWN*>
90
130
value. Use the current time as the update time.
91
131
 
 
132
=item *
 
133
 
92
134
C<rrdtool update demo2.rrd 887457267:U 887457521:22 887457903:2.7>
93
135
 
94
136
Update the database file demo2.rrd which expects data from a single
95
137
data-source, three times. First with an I<*UNKNOWN*> value then with two
96
138
regular readings. The update interval seems to be around 300 seconds.
97
139
 
98
 
=head1 AUTHOR
99
 
 
100
 
Tobias Oetiker <tobi@oetiker.ch>
 
140
=item *
 
141
 
 
142
C<rrdtool update demo3.rrd -- -5:21 N:42>
 
143
 
 
144
Update the database file demo3.rrd two times, using five seconds in the
 
145
past and the current time as the update times.
 
146
 
 
147
=item *
 
148
 
 
149
C<rrdtool update --cache /var/lib/rrd/demo3.rrd N:42>
 
150
 
 
151
Update the file C</var/lib/rrd/demo3.rrd> with a single data source, using the
 
152
current time. If the caching daemon cannot be reached, do B<not> fall back to
 
153
direct file access.
 
154
 
 
155
=item *
 
156
 
 
157
C<rrdtool update --daemon unix:/tmp/rrdd.sock demo4.rrd N:23>
 
158
 
 
159
Use the UNIX domain socket C</tmp/rrdd.sock> to contact the caching daemon. If
 
160
the caching daemon is not available, update the file C<demo4.rrd> directly.
 
161
B<WARNING:> Since a relative path is specified, the following disturbing effect
 
162
may occur: If the daemon is available, the file relative to the working
 
163
directory B<of the daemon> is used. If the daemon is not available, the file
 
164
relative to the current working directory of the invoking process is used.
 
165
B<This may update two different files depending on whether the daemon could be
 
166
reached or not.> Don't do relative paths, kids!
 
167
 
 
168
=back
 
169
 
 
170
=head1 AUTHORS
 
171
 
 
172
Tobias Oetiker <tobi@oetiker.ch>,
 
173
Florian Forster <octoE<nbsp>atE<nbsp>verplant.org>
101
174