Code

Add a "FETCH" command to RRDCacheD which behaves like a (simplified
[rrdtool-all.git] / program / doc / rrdcached.pod
1 =pod
3 =head1 NAME
5 rrdcached - Data caching daemon for rrdtool
7 =head1 SYNOPSIS
9 B<rrdcached>
10 [B<-P>E<nbsp>I<permissions>]
11 [B<-l>E<nbsp>I<address>]
12 [B<-s>E<nbsp>I<group>]
13 [B<-w>E<nbsp>I<timeout>]
14 [B<-z>E<nbsp>I<delay>]
15 [B<-f>E<nbsp>I<timeout>]
16 [B<-p>E<nbsp>I<pid_file>]
17 [B<-t>E<nbsp>I<write_threads>]
18 [B<-j>E<nbsp>I<journal_dir>]
19 [-F]
20 [-g]
21 [B<-b>E<nbsp>I<base_dir>E<nbsp>[B<-B>]]
22 [B<-a>E<nbsp>I<alloc_size>]
24 =head1 DESCRIPTION
26 B<rrdcached> is a daemon that receives updates to existing RRD files,
27 accumulates them and, if enough have been received or a defined time has
28 passed, writes the updates to the RRD file. A I<flush> command may be used to
29 force writing of values to disk, so that graphing facilities and similar can
30 work with up-to-date data.
32 The daemon was written with big setups in mind. Those setups usually run into
33 IOE<nbsp>related problems sooner or later for reasons that are beyond the scope
34 of this document. Check the wiki at the RRDtool homepage for details. Also
35 check L</"SECURITY CONSIDERATIONS"> below before using this daemon! A detailed
36 description of how the daemon operates can be found in the L</"HOW IT WORKS">
37 section below.
39 =head1 OPTIONS
41 =over 4
43 =item B<-l> I<address>
45 Tells the daemon to bind to I<address> and accept incoming connections on that
46 socket. If I<address> begins with C<unix:>, everything following that prefix is
47 interpreted as the path to a UNIX domain socket. Otherwise the address or node
48 name are resolved using C<getaddrinfo()>.
50 For network sockets, a port may be specified by using the form
51 C<B<[>I<address>B<]:>I<port>>. If the address is an IPv4 address or a fully
52 qualified domain name (i.E<nbsp>e. the address contains at least one dot
53 (C<.>)), the square brackets can be omitted, resulting in the (simpler)
54 C<I<address>B<:>I<port>> pattern. The default port is B<42217/udp>. If you
55 specify a network socket, it is mandatory to read the
56 L</"SECURITY CONSIDERATIONS"> section.
58 The following formats are accepted. Please note that the address of the UNIX
59 domain socket B<must> start with a slash in the second case!
61    unix:</path/to/unix.sock>
62    /<path/to/unix.sock>
63    <hostname-or-ip>
64    [<hostname-or-ip>]:<port>
65    <hostname-or-ipv4>:<port>
67 If the B<-l> option is not specified the default address,
68 C<unix:/tmp/rrdcached.sock>, will be used.
70 =item B<-s> I<group_name>|I<gid>
72 Set the group permissions of a UNIX domain socket. The option accepts either
73 a numeric group id or group name. That group will then have both read and write
74 permissions (the socket will have file permissions 0750) for the socket and,
75 therefore, is able to send commands to the daemon. This
76 may be useful in cases where you cannot easily run all RRD processes with the same
77 user privileges (e.g. graph generating CGI scripts that typically run in the
78 permission context of the web server).
80 This option affects the I<following> UNIX socket addresses (the following
81 B<-l> options), i.e., you may specify different settings for different
82 sockets.
84 The default is not to change ownership or permissions of the socket and, thus,
85 use the system default.
87 =item B<-m> I<mode>
89 Set the file permissions of a UNIX domain socket. The option accepts an octal
90 number representing the bit pattern for the mode (see L<chmod(1)> for
91 details).
93 Please note that not all systems honor this setting. On Linux, read/write
94 permissions are required to connect to a UNIX socket. However, many
95 BSD-derived systems ignore permissions for UNIX sockets. See L<unix(7)> for
96 details.
98 This option affects the I<following> UNIX socket addresses (the following
99 B<-l> options), i.e., you may specify different settings for different
100 sockets.
102 The default is not to change ownership or permissions of the socket and, thus,
103 use the system default.
105 =item B<-P> I<command>[,I<command>[,...]]
107 Specifies the commands accepted via a network socket. This allows
108 administrators of I<RRDCacheD> to control the actions accepted from various
109 sources.
111 The arguments given to the B<-P> option is a comma separated list of commands.
112 For example, to allow the C<FLUSH> and C<PENDING> commands one could specify:
114   rrdcached -P FLUSH,PENDING $MORE_ARGUMENTS
116 The B<-P> option affects the I<following> socket addresses (the following B<-l>
117 options). In the following example, only the IPv4 network socket (address
118 C<10.0.0.1>) will be restricted to the C<FLUSH> and C<PENDING> commands:
120   rrdcached -l unix:/some/path -P FLUSH,PENDING -l 10.0.0.1
122 A complete list of available commands can be found in the section
123 L</"Valid Commands"> below. There are two minor special exceptions:
125 =over 4
127 =item *
129 The C<HELP> and C<QUIT> commands are always allowed.
131 =item *
133 If the C<BATCH> command is accepted, the B<.>E<nbsp>command will automatically
134 be accepted, too.
136 =back
138 Please also read L</"SECURITY CONSIDERATIONS"> below.
140 =item B<-w> I<timeout>
142 Data is written to disk every I<timeout> seconds. If this option is not
143 specified the default interval of 300E<nbsp>seconds will be used.
145 =item B<-z> I<delay>
147 If specified, rrdcached will delay writing of each RRD for a random number
148 of seconds in the rangeE<nbsp>[0,I<delay>).  This will avoid too many
149 writes being queued simultaneously.  This value should be no greater than
150 the value specified in B<-w>.  By default, there is no delay.
152 =item B<-f> I<timeout>
154 Every I<timeout> seconds the entire cache is searched for old values which are
155 written to disk. This only concerns files to which updates have stopped, so
156 setting this to a high value, such as 3600E<nbsp>seconds, is acceptable in most
157 cases. This timeout defaults to 3600E<nbsp>seconds.
159 =item B<-p> I<file>
161 Sets the name and location of the PID-file. If not specified, the default,
162 C<I<$localststedir>/run/rrdcached.pid> will be used.
164 =item B<-t> I<write_threads>
166 Specifies the number of threads used for writing RRD files.  The default
167 isE<nbsp>4.  Increasing this number will allow rrdcached to have more
168 simultaneous I/O requests into the kernel.  This may allow the kernel to
169 re-order disk writes, resulting in better disk throughput.
171 =item B<-j> I<dir>
173 Write updates to a journal in I<dir>.  In the event of a program or system
174 crash, this will allow the daemon to write any updates that were pending
175 at the time of the crash.
177 On startup, the daemon will check for journal files in this directory.  If
178 found, all updates therein will be read into memory before the daemon
179 starts accepting new connections.
181 The journal will be rotated with the same frequency as the flush timer
182 given by B<-f>.
184 When journaling is enabled, the daemon will use a fast shutdown procedure.
185 Rather than flushing all files to disk, it will make sure the journal is
186 properly written and exit immediately.  Although the RRD data files are
187 not fully up-to-date, no information is lost; all pending updates will be
188 replayed from the journal next time the daemon starts up.
190 To disable fast shutdown, use the B<-F> option.
192 =item B<-F>
194 ALWAYS flush all updates to the RRD data files when the daemon is shut
195 down, regardless of journal setting.
197 =item B<-g>
199 Run in the foreground.  The daemon will not fork().
201 =item B<-b> I<dir>
203 The daemon will change into a specific directory at startup. All files passed
204 to the daemon, that are specified by a B<relative> path, will be interpreted
205 to be relative to this directory. If not given the default, C</tmp>, will be
206 used.
208   +------------------------+------------------------+
209   ! Command line           ! File updated           !
210   +------------------------+------------------------+
211   ! foo.rrd                ! /tmp/foo.rrd           !
212   ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
213   ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
214   +------------------------+------------------------+
215   Paths given on the command  line and paths actually
216   updated by the daemon,  assuming the base directory
217   "/tmp".
219 B<WARNING:> The paths up to and including the base directory B<MUST NOT BE>
220 symbolic links.  In other words, if the base directory is
221 specified as:
223     -b /base/dir/somewhere
225 ... then B<NONE> of the following should be symbolic links:
227     /base
228     /base/dir
229     /base/dir/somewhere
231 =item B<-B>
233 Only permit writes into the base directory specified in B<-b> (and any
234 sub-directories).  This does B<NOT> detect symbolic links.  Paths
235 containing C<../> will also be blocked.
237 =item B<-a> I<alloc_size>
239 Allocate value pointers in chunks of I<alloc_size>.  This may improve CPU
240 utilization on machines with slow C<realloc()> implementations, in
241 exchange for slightly higher memory utilization.  The default isE<nbsp>1.
242 Do not set this more than the B<-w> value divided by your average RRD step
243 size.
245 =back
247 =head1 AFFECTED RRDTOOL COMMANDS
249 The following commands may be made aware of the B<rrdcached> using the command
250 line argument B<--daemon> or the environment variable B<RRDCACHED_ADDRESS>:
252 =over
254 =item *
256 dump
258 =item *
260 fetch
262 =item *
264 flush
266 =item *
268 graph
270 =item *
272 graphv
274 =item *
276 info
278 =item *
280 last
282 =item *
284 lastupdate
286 =item *
288 update
290 =item *
292 xport
294 =back
296 The B<update> command can send values to the daemon instead of writing them to
297 the disk itself. All other commands can send a B<FLUSH> command (see below) to
298 the daemon before accessing the files, so they work with up-to-date data even
299 if the cache timeout is large.
301 =head1 ERROR REPORTING
303 The daemon reports errors in one of two ways: During startup, error messages
304 are printed to C<STDERR>. One of the steps when starting up is to fork to the
305 background and closing C<STDERR> - after this writing directly to the user is
306 no longer possible. Once this has happened, the daemon will send log messages
307 to the system logging daemon using syslog(3). The facility used is
308 C<LOG_DAEMON>.
310 =head1 HOW IT WORKS
312 When receiving an update, B<rrdcached> does not write to disk but looks for an
313 entry for that file in its internal tree. If not found, an entry is created
314 including the current time (called "First" in the diagram below). This time is
315 B<not> the time specified on the command line but the time the operating system
316 considers to be "now". The value and time of the value (called "Time" in the
317 diagram below) are appended to the tree node.
319 When appending a value to a tree node, it is checked whether it's time to write
320 the values to disk. Values are written to disk if
321 S<C<now() - First E<gt>= timeout>>, where C<timeout> is the timeout specified
322 using the B<-w> option, see L</OPTIONS>. If the values are "old enough" they
323 will be enqueued in the "update queue", i.E<nbsp>e. they will be appended to
324 the linked list shown below.  Because the tree nodes and the elements of the
325 linked list are the same data structures in memory, any update to a file that
326 has already been enqueued will be written with the next write to the RRD file,
327 too.
329 A separate "update thread" constantly dequeues the first element in the update
330 queue and writes all its values to the appropriate file. So as long as the
331 update queue is not empty files are written at the highest possible rate.
333 Since the timeout of files is checked only when new values are added to the
334 file, "dead" files, i.E<nbsp>e. files that are not updated anymore, would never
335 be written to disk. Therefore, every now and then, controlled by the B<-f>
336 option, the entire tree is walked and all "old" values are enqueued. Since this
337 only affects "dead" files and walking the tree is relatively expensive, you
338 should set the "flush interval" to a reasonably high value. The default is
339 3600E<nbsp>seconds (one hour).
341 The downside of caching values is that they won't show up in graphs generated
342 from the RRDE<nbsp>files. To get around this, the daemon provides the "flush
343 command" to flush specific files. This means that the file is inserted at the
344 B<head> of the update queue or moved there if it is already enqueued. The flush
345 command will return only after the file's pending updates have been written
346 to disk.
348  +------+   +------+                               +------+
349  ! head !   ! root !                               ! tail !
350  +---+--+   +---+--+                               +---+--+
351      !         /\                                      !
352      !        /  \                                     !
353      !       /\  /\                                    !
354      !      /\/\ \ `----------------- ... --------,    !
355      V     /      `-------,                       !    V
356  +---+----+---+    +------+-----+             +---+----+---+
357  ! File:  foo !    ! File:  bar !             ! File:  qux !
358  ! First: 101 !    ! First: 119 !             ! First: 180 !
359  ! Next:&bar -+--->! Next:&... -+---> ... --->! Next:NULL  !
360  | Prev:NULL  !<---+-Prev:&foo  !<--- ... ----+-Prev: &... !
361  +============+    +============+             +============+
362  ! Time:  100 !    ! Time:  120 !             ! Time:  180 !
363  ! Value:  10 !    ! Value: 0.1 !             ! Value: 2,2 !
364  +------------+    +------------+             +------------+
365  ! Time:  110 !    ! Time:  130 !             ! Time:  190 !
366  ! Value:  26 !    ! Value: 0.1 !             ! Value: 7,3 !
367  +------------+    +------------+             +------------+
368  :            :    :            :             :            :
369  +------------+    +------------+             +------------+
370  ! Time:  230 !    ! Time:  250 !             ! Time:  310 !
371  ! Value:  42 !    ! Value: 0.2 !             ! Value: 1,2 !
372  +------------+    +------------+             +------------+
374 The above diagram demonstrates:
376 =over
378 =item *
380 Files/values are stored in a (balanced) tree.
382 =item *
384 Tree nodes and entries in the update queue are the same data structure.
386 =item *
388 The local time ("First") and the time specified in updates ("Time") may differ.  
390 =item *
392 Timed out values are inserted at the "tail".
394 =item *
396 Explicitly flushed values are inserted at the "head".
398 =item *
400 ASCII art rocks.
402 =back
404 =head1 SECURITY CONSIDERATIONS
406 =head2 Authentication
408 There is no authentication.
410 The client/server protocol does not yet have any authentication mechanism. It
411 is likely that authentication and encryption will be added in a future version,
412 but for the time being it is the administrator's responsibility to secure the
413 traffic from/to the daemon!
415 It is highly recommended to install a packet filter or similar mechanism to
416 prevent unauthorized connections. Unless you have a dedicated VLAN or VPN for
417 this, using network sockets is probably a bad idea!
419 =head2 Authorization
421 There is minimal per-socket authorization.
423 Authorization is currently done on a per-socket basis. That means each socket
424 has a list of commands it will accept and it will accept. It will accept only
425 those commands explicitly listed but it will (currently) accept these commands
426 from anyone reaching the socket.
428 If the networking sockets are to be used, it is necessary to restrict the
429 accepted commands to those needed by external clients. If, for example,
430 external clients want to draw graphs of the cached data, they should only be
431 allowed to use the C<FLUSH> command.
433 =head2 Encryption
435 There is no encryption.
437 Again, this may be added in the future, but for the time being it is your job
438 to keep your private data private. Install a VPN or an encrypted tunnel if you
439 statistics are confidential!
441 =head2 Sanity checking
443 There is no sanity checking.
445 The daemon will blindly write to any file it gets told, so you really should
446 create a separate user just for this daemon. Also it does not do any sanity
447 checks, so if it gets told to write values for a time far in the future, your
448 files will be messed up good!
450 =head2 Conclusion
452 =over 4
454 =item *
456 Security is the job of the administrator.
458 =item *
460 We recommend to allow write access via UNIX domain sockets only.
462 =item *
464 You have been warned.
466 =back
468 =head1 PROTOCOL
470 The daemon communicates with clients using a line based ASCII protocol which is
471 easy to read and easy to type. This makes it easy for scripts to implement the
472 protocol and possible for users to use telnet to connect to the daemon
473 and test stuff "by hand".
475 The protocol is line based, this means that each record consists of one or more
476 lines. A line is terminated by the line feed character C<0x0A>, commonly
477 written as C<\n>. In the examples below, this character will be written as
478 C<E<lt>LFE<gt>> ("line feed").
480 After the connection has been established, the client is expected to send a
481 "command". A command consists of the command keyword, possibly some arguments,
482 and a terminating newline character. For a list of commands, see
483 L</"Valid Commands"> below.
485 Example:
487   FLUSH /tmp/foo.rrd<LF>
489 The daemon answers with a line consisting of a status code and a short status
490 message, separated by one or more space characters. A negative status code
491 signals an error, a positive status code or zero signal success. If the status
492 code is greater than zero, it indicates the number of lines that follow the
493 status line.
495 Examples:
497  0 Success<LF>
499  2 Two lines follow<LF>
500  This is the first line<LF>
501  And this is the second line<LF>
503 =head2 Valid Commands
505 The following commands are understood by the daemon:
507 =over 4
509 =item B<FLUSH> I<filename>
511 Causes the daemon to put I<filename> to the B<head> of the update queue
512 (possibly moving it there if the node is already enqueued). The answer will be
513 sent B<after> the node has been dequeued.
515 =item B<FLUSHALL>
517 Causes the daemon to start flushing ALL pending values to disk.  This
518 returns immediately, even though the writes may take a long time.
520 =item B<PENDING> I<filename>
522 Shows any "pending" updates for a file, in order.  The updates shown have
523 not yet been written to the underlying RRD file.
525 =item B<FETCH> I<filename> I<CF> [I<start> [I<end>]]
527 Calls C<rrd_fetch> with the specified arguments and returns the result in text
528 form. If necessary, the file is flushed to disk first. The client side function
529 C<rrdc_fetch> (declared in C<rrd_client.h>) parses the output and behaves just
530 like C<rrd_fetch_r> for easy integration of remote queries.
532 =item B<FORGET> I<filename>
534 Removes I<filename> from the cache.  Any pending updates B<WILL BE LOST>.
536 =item B<QUEUE>
538 Shows the files that are on the output queue.  Returns zero or more lines
539 in the following format, where E<lt>num_valsE<gt> is the number of values
540 to be written for the E<lt>fileE<gt>:
542     <num_vals> <file>
544 =item B<HELP> [I<command>]
546 Returns a short usage message. If no command is given, or I<command> is
547 B<HELP>, a list of commands supported by the daemon is returned. Otherwise a
548 short description, possibly containing a pointer to a manual page, is returned.
549 Obviously, this is meant for interactive usage and the format in which the
550 commands and usage summaries are returned is not well defined.
552 =item B<STATS>
554 Returns a list of metrics which can be used to measure the daemons performance
555 and check its status. For a description of the values returned, see
556 L</"Performance Values"> below.
558 The format in which the values are returned is similar to many other line based
559 protocols: Each value is printed on a separate line, each consisting of the
560 name of the value, a colon, one or more spaces and the actual value.
562 Example:
564  9 Statistics follow
565  QueueLength: 0
566  UpdatesReceived: 30
567  FlushesReceived: 2
568  UpdatesWritten: 13
569  DataSetsWritten: 390
570  TreeNodesNumber: 13
571  TreeDepth: 4
572  JournalBytes: 190
573  JournalRotate: 0
575 =item B<UPDATE> I<filename> I<values> [I<values> ...]
577 Adds more data to a filename. This is B<the> operation the daemon was designed
578 for, so describing the mechanism again is unnecessary. Read L</"HOW IT WORKS">
579 above for a detailed explanation.
581 Note that rrdcached only accepts absolute timestamps in the update values.
582 Updates strings like "N:1:2:3" are automatically converted to absolute
583 time by the RRD client library before sending to rrdcached.
585 =item B<WROTE> I<filename>
587 This command is written to the journal after a file is successfully
588 written out to disk.  It is used during journal replay to determine which
589 updates have already been applied.  It is I<only> valid in the journal; it
590 is not accepted from the other command channels.
592 =item B<BATCH>
594 This command initiates the bulk load of multiple commands.  This is
595 designed for installations with extremely high update rates, since it
596 permits more than one command to be issued per read() and write().
598 All commands are executed just as they would be if given individually,
599 except for output to the user.  Messages indicating success are
600 suppressed, and error messages are delayed until the client is finished.
602 Command processing is finished when the client sends a dot (".") on its
603 own line.  After the client has finished, the server responds with an
604 error count and the list of error messages (if any).  Each error messages
605 indicates the number of the command to which it corresponds, and the error
606 message itself.  The first user command after B<BATCH> is command number one.
608     client:  BATCH
609     server:  0 Go ahead.  End with dot '.' on its own line.
610     client:  UPDATE x.rrd 1223661439:1:2:3            <--- command #1
611     client:  UPDATE y.rrd 1223661440:3:4:5            <--- command #2
612     client:  and so on...
613     client:  .
614     server:  2 Errors
615     server:  1 message for command 1
616     server:  12 message for command 12
618 =item B<QUIT>
620 Disconnect from rrdcached.
622 =back
624 =head2 Performance Values
626 The following counters are returned by the B<STATS> command:
628 =over 4
630 =item B<QueueLength> I<(unsigned 64bit integer)>
632 Number of nodes currently enqueued in the update queue.
634 =item B<UpdatesReceived> I<(unsigned 64bit integer)>
636 Number of UPDATE commands received.
638 =item B<FlushesReceived> I<(unsigned 64bit integer)>
640 Number of FLUSH commands received.
642 =item B<UpdatesWritten> I<(unsigned 64bit integer)>
644 Total number of updates, i.E<nbsp>e. calls to C<rrd_update_r>, since the
645 daemon was started.
647 =item B<DataSetsWritten> I<(unsigned 64bit integer)>
649 Total number of "data sets" written to disk since the daemon was
650 started. A data set is one or more values passed to the B<UPDATE>
651 command. For example: C<1223661439:123:456> is one data set with two
652 values. The term "data set" is used to prevent confusion whether
653 individual values or groups of values are counted.
655 =item B<TreeNodesNumber> I<(unsigned 64bit integer)>
657 Number of nodes in the cache.
659 =item B<TreeDepth> I<(unsigned 64bit integer)>
661 Depth of the tree used for fast key lookup.
663 =item B<JournalBytes> I<(unsigned 64bit integer)>
665 Total number of bytes written to the journal since startup.
667 =item B<JournalRotate> I<(unsigned 64bit integer)>
669 Number of times the journal has been rotated since startup.
671 =back
673 =head1 SIGNALS
675 =over 4
677 =item SIGINT and SIGTERM
679 The daemon exits normally on receipt of either of these signals.  Pending
680 updates are handled in accordance with the B<-j> and B<-F> options.
682 =item SIGUSR1
684 The daemon exits AFTER flushing all updates out to disk.  This may take a
685 while.
687 =item SIGUSR2
689 The daemon exits immediately, without flushing updates out to disk.
690 Pending updates will be replayed from the journal when the daemon starts
691 up again.  B<WARNING: if journaling (-j) is NOT enabled, any pending
692 updates WILL BE LOST>.
694 =back
696 =head1 BUGS
698 No known bugs at the moment.
700 =head1 SEE ALSO
702 L<rrdtool>, L<rrdgraph>
704 =head1 AUTHOR
706 Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>
708 Both B<rrdcached> and this manual page have been written by Florian.
710 =head1 CONTRIBUTORS
712 kevin brintnall E<lt>kbrint@rufus.netE<gt>
714 =cut