program/doc/rrdcached.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 rrdcached - Data caching daemon for rrdtool
   6
   7 =head1 SYNOPSIS
   8
   9 B<rrdcached> [B<-l/-L> I<address>] [B<-w> I<timeout>] [B<-z> I<delay>] [B<-f> I<timeout>] [B<-j> I<dir>] [-F] [B<-b> I<dir> [B<-B>]]
  10
  11 =head1 DESCRIPTION
  12
  13 B<rrdcached> is a daemon that receives updates to existing RRD files,
  14 accumulates them and, if enough have been received or a defined time has
  15 passed, writes the updates to the RRD file. A I<flush> command may be used to
  16 force writing of values to disk, so that graphing facilities and similar can
  17 work with up-to-date data.
  18
  19 The daemon was written with big setups in mind. Those setups usually run into
  20 IOE<nbsp>related problems sooner or later for reasons that are beyond the scope
  21 of this document. Check the wiki at the RRDTool homepage for details. Also
  22 check L<SECURITY CONSIDERATIONS> below before using this daemon! A detailed
  23 description of how the daemon operates can be found in the L<HOW IT WORKS>
  24 section below.
  25
  26 =head1 OPTIONS
  27
  28 =over 4
  29
  30 =item B<-l> I<address>
  31
  32 Tells the daemon to bind to I<address> and accept incoming connections on that
  33 socket. If I<address> begins with C<unix:>, everything following that prefix is
  34 interpreted as the path to a UNIX domain socket. Otherwise the address or node
  35 name are resolved using L<getaddrinfo>.
  36
  37 For network sockets, a port may be specified by using the form
  38 C<B<[>I<address>B<]:>I<port>>. If the address is an IPv4 address or a fully
  39 qualified domain name (i.E<nbsp>e. the address contains at least one dot
  40 (C<.>)), the square brackets can be omitted, resulting in the (simpler)
  41 C<I<address>B<:>I<port>> pattern.. The default port is B<42217/udp>.
  42
  43 The following formats are accepted. Please note that the address of the UNIX
  44 domain socket B<must> start with a slash in the second case!
  45
  46    unix:</path/to/unix.sock>
  47    /<path/to/unix.sock>
  48    <hostname-or-ip>
  49    [<hostname-or-ip>]:<port>
  50    <hostname-or-ipv4>:<port>
  51
  52 If the B<-l> option is not specified the default address,
  53 C<unix:/tmp/rrdcached.sock>, will be used.
  54
  55 =item B<-L> I<address>
  56
  57 Same as B<-l>, except creates a low-privilege socket.  See B<SECURITY
  58 CONSIDERATIONS> for more information.
  59
  60 =item B<-w> I<timeout>
  61
  62 Data is written to disk every I<timeout> seconds. If this option is not
  63 specified the default interval of 300E<nbsp>seconds will be used.
  64
  65 =item B<-z> I<delay>
  66
  67 If specified, rrdcached will delay writing of each RRD for a random number
  68 of seconds in the rangeE<nbsp>[0,I<delay>).  This will avoid too many
  69 writes being queued simultaneously.  This value should be no greater than
  70 the value specified in B<-w>.  By default, there is no delay.
  71
  72 =item B<-f> I<timeout>
  73
  74 Every I<timeout> seconds the entire cache is searched for old values which are
  75 written to disk. This only concerns files to which updates have stopped, so
  76 setting this to a high value, such as 3600E<nbsp>seconds, is acceptable in most
  77 cases. This timeout defaults to 3600E<nbsp>seconds.
  78
  79 =item B<-p> I<file>
  80
  81 Sets the name and location of the PID-file. If not specified, the default,
  82 C<I<$localststedir>/run/rrdcached.pid> will be used.
  83
  84 =item B<-j> I<dir>
  85
  86 Write updates to a journal in I<dir>.  In the event of a program or system
  87 crash, this will allow the daemon to write any updates that were pending
  88 at the time of the crash.
  89
  90 On startup, the daemon will check for journal files in this directory.  If
  91 found, all updates therein will be read into memory before the daemon
  92 starts accepting new connections.
  93
  94 The journal will be rotated with the same frequency as the flush timer
  95 given by B<-f>.
  96
  97 When journaling is enabled, the daemon will use a fast shutdown procedure.
  98 Rather than flushing all files to disk, it will make sure the journal is
  99 properly written and exit immediately.  Although the RRD data files are
 100 not fully up-to-date, no information is lost; all pending updates will be
 101 replayed from the journal next time the daemon starts up.
 102
 103 To disable fast shutdown, use the B<-F> option.
 104
 105 =item B<-F>
 106
 107 ALWAYS flush all updates to the RRD data files when the daemon is shut
 108 down, regardless of journal setting.
 109
 110 =item B<-b> I<dir>
 111
 112 The daemon will change into a specific directory at startup. All files passed
 113 to the daemon, that are specified by a B<relative> path, will be interpreted
 114 to be relative to this directory. If not given the default, C</tmp>, will be
 115 used.
 116
 117   +------------------------+------------------------+
 118   ! Command line           ! File updated           !
 119   +------------------------+------------------------+
 120   ! foo.rrd                ! /tmp/foo.rrd           !
 121   ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
 122   ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
 123   +------------------------+------------------------+
 124   Paths given on the command  line and paths actually
 125   updated by the daemon,  assuming the base directory
 126   "/tmp".
 127
 128 B<WARNING:> The paths up to and including the base directory B<MUST NOT BE>
 129 symbolic links.  In other words, if the base directory is
 130 specified as:
 131
 132     -b /base/dir/somewhere
 133
 134 ... then B<NONE> of the following should be symbolic links:
 135
 136     /base
 137     /base/dir
 138     /base/dir/somewhere
 139
 140 =item B<-B>
 141
 142 Only permit writes into the base directory specified in B<-b> (and any
 143 sub-directories).  This does B<NOT> detect symbolic links.  Paths
 144 containing C<../> will also be blocked.
 145
 146 =back
 147
 148 =head1 AFFECTED RRDTOOL COMMANDS
 149
 150 The following commands may be made aware of the B<rrdcached> using the command
 151 line argument B<--daemon> or the environment variable B<RRDCACHED_ADDRESS>:
 152
 153 =over 4
 154
 155 =item B<dump>
 156
 157 =item B<fetch>
 158
 159 =item B<flush>
 160
 161 =item B<graph>
 162
 163 =item B<graphv>
 164
 165 =item B<info>
 166
 167 =item B<last>
 168
 169 =item B<lastupdate>
 170
 171 =item B<update>
 172
 173 =item B<xport>
 174
 175 =back
 176
 177 The B<update> command can send values to the daemon instead of writing them to
 178 the disk itself. All other commands can send a B<FLUSH> command (see below) to
 179 the daemon before accessing the files, so they work with up-to-date data even
 180 if the cache timeout is large.
 181
 182 =head1 ERROR REPORTING
 183
 184 The daemon reports errors in one of two ways: During startup, error messages
 185 are printed to C<STDERR>. One of the steps when starting up is to fork to the
 186 background and closing C<STDERR> - after this writing directly to the user is
 187 no longer possible. Once this has happened, the daemon will send log messages
 188 to the system logging daemon using L<syslog(3)>. The facility used is
 189 C<LOG_DAEMON>.
 190
 191 =head1 HOW IT WORKS
 192
 193 When receiving an update, B<rrdcached> does not write to disk but looks for an
 194 entry for that file in its internal tree. If not found, an entry is created
 195 including the current time (called "First" in the diagram below). This time is
 196 B<not> the time specified on the command line but the time the operating system
 197 considers to be "now". The value and time of the value (called "Time" in the
 198 diagram below) are appended to the tree node.
 199
 200 When appending a value to a tree node, it is checked whether it's time to write
 201 the values to disk. Values are written to disk if
 202 S<C<now() - First E<gt>= timeout>>, where C<timeout> is the timeout specified
 203 using the B<-w> option, see L<OPTIONS>. If the values are "old enough" they
 204 will be enqueued in the "update queue", i.E<nbsp>e. they will be appended to
 205 the linked list shown below.  Because the tree nodes and the elements of the
 206 linked list are the same data structures in memory, any update to a file that
 207 has already been enqueued will be written with the next write to the RRD file,
 208 too.
 209
 210 A separate "update thread" constantly dequeues the first element in the update
 211 queue and writes all its values to the appropriate file. So as long as the
 212 update queue is not empty files are written at the highest possible rate.
 213
 214 Since the timeout of files is checked only when new values are added to the
 215 file, "dead" files, i.E<nbsp>e. files that are not updated anymore, would never
 216 be written to disk. Therefore, every now and then, controlled by the B<-f>
 217 option, the entire tree is walked and all "old" values are enqueued. Since this
 218 only affects "dead" files and walking the tree is relatively expensive, you
 219 should set the "flush interval" to a reasonably high value. The default is
 220 3600E<nbsp>seconds (one hour).
 221
 222 The downside of caching values is that they won't show up in graphs generated
 223 from the RRDE<nbsp>files. To get around this, the daemon provides the "flush
 224 command" to flush specific files. This means that the file is inserted at the
 225 B<head> of the update queue or moved there if it is already enqueued. The flush
 226 command will return only after the file's pending updates have been written
 227 to disk.
 228
 229  +------+   +------+                               +------+
 230  ! head !   ! root !                               ! tail !
 231  +---+--+   +---+--+                               +---+--+
 232      !         /\                                      !
 233      !        /  \                                     !
 234      !       /\  /\                                    !
 235      !      /\/\ \ `----------------- ... --------,    !
 236      V     /      `-------,                       !    V
 237  +---+----+---+    +------+-----+             +---+----+---+
 238  ! File:  foo !    ! File:  bar !             ! File:  qux !
 239  ! First: 101 !    ! First: 119 !             ! First: 180 !
 240  ! Next:&bar -+--->! Next:&... -+---> ... --->! Next:NULL  !
 241  | Prev:NULL  !<---+-Prev:&foo  !<--- ... ----+-Prev: &... !
 242  +============+    +============+             +============+
 243  ! Time:  100 !    ! Time:  120 !             ! Time:  180 !
 244  ! Value:  10 !    ! Value: 0.1 !             ! Value: 2,2 !
 245  +------------+    +------------+             +------------+
 246  ! Time:  110 !    ! Time:  130 !             ! Time:  190 !
 247  ! Value:  26 !    ! Value: 0.1 !             ! Value: 7,3 !
 248  +------------+    +------------+             +------------+
 249  :            :    :            :             :            :
 250  +------------+    +------------+             +------------+
 251  ! Time:  230 !    ! Time:  250 !             ! Time:  310 !
 252  ! Value:  42 !    ! Value: 0.2 !             ! Value: 1,2 !
 253  +------------+    +------------+             +------------+
 254
 255 The above diagram demonstrates:
 256
 257 =over
 258
 259 =item *
 260
 261 Files/values are stored in a (balanced) tree.
 262
 263 =item *
 264
 265 Tree nodes and entries in the update queue are the same data structure.
 266
 267 =item *
 268
 269 The local time ("First") and the time specified in updates ("Time") may differ.
 270
 271 =item *
 272
 273 Timed out values are inserted at the "tail".
 274
 275 =item *
 276
 277 Explicitly flushed values are inserted at the "head".
 278
 279 =item *
 280
 281 ASCII art rocks.
 282
 283 =back
 284
 285 =head1 SECURITY CONSIDERATIONS
 286
 287 The client/server protocol does not have any authentication or
 288 authorization mechanism.  Therefore, take care to restrict which users can
 289 connect to the daemon.
 290
 291 Control sockets are divided into high-privilege (B<-l>) and low-privilege
 292 (B<-L>) sockets.  High-privilege sockets accept all commands, whereas
 293 low-privilege sockets accept only B<FLUSH>, B<STATS>, and B<HELP>.
 294
 295 For a multi-user environment where only certain users require read/write
 296 access, the recommended configuration uses two sockets as follows:
 297
 298 =over
 299
 300 =item B<-l> I</protected/dir/rrd.sock>
 301
 302 Create a high-privilege unix-domain socket.  This should be protected with
 303 the same Unix permissions that are used to protect the RRD files.  Updates
 304 should be directed to this socket.
 305
 306 =item B<-L> I<127.0.0.1>
 307
 308 Create a low-privilege TCP socket listening on localhost.  All users on
 309 the local system may use this to trigger FLUSH of individual files.  Users
 310 with read-only access should be directed to this socket.
 311
 312 =back
 313
 314 If you (want to) use the network capability, i.E<nbsp>e. let the daemon bind to
 315 an IPv4 or IPv6 socket, it is B<your> job to install a packet filter or similar
 316 mechanism to prevent unauthorized connections. Unless you have a dedicated VLAN
 317 or VPN for this, using the network option is probably a bad idea!
 318
 319 The daemon will blindly write to any file it gets told, so you really should
 320 create a separate user just for this daemon. Also it does not do any sanity
 321 checks, so if it gets told to write values for a time far in the future, your
 322 files will be messed up good!
 323
 324 You have been warned.
 325
 326 =head1 PROTOCOL
 327
 328 The daemon communicates with clients using a line based ASCII protocol which is
 329 easy to read and easy to type. This makes it easy for scripts to implement the
 330 protocol and possible for users to use L<telnet> to connect to the daemon
 331 and test stuff "by hand".
 332
 333 The protocol is line based, this means that each record consists of one or more
 334 lines. A line is terminated by the line feed character C<0x0A>, commonly
 335 written as C<\n>. In the examples below, this character will be written as
 336 C<E<lt>LFE<gt>> ("line feed").
 337
 338 After the connection has been established, the client is expected to send a
 339 "command". A command consists of the command keyword, possibly some arguments,
 340 and a terminating newline character. For a list of commands, see
 341 L<Valid Commands> below.
 342
 343 Example:
 344
 345   FLUSH /tmp/foo.rrd<LF>
 346
 347 The daemon answers with a line consisting of a status code and a short status
 348 message, separated by one or more space characters. A negative status code
 349 signals an error, a positive status code or zero signal success. If the status
 350 code is greater than zero, it indicates the number of lines that follow the
 351 status line.
 352
 353 Examples:
 354
 355  0 Success<LF>
 356
 357  2 Two lines follow<LF>
 358  This is the first line<LF>
 359  And this is the second line<LF>
 360
 361 =head2 Valid Commands
 362
 363 The following commands are understood by the daemon:
 364
 365 =over 4
 366
 367 =item B<FLUSH> I<filename>
 368
 369 Causes the daemon to put I<filename> to the B<head> of the update queue
 370 (possibly moving it there if the node is already enqueued). The answer will be
 371 sent B<after> the node has been dequeued.
 372
 373 =item B<FLUSHALL>
 374
 375 Causes the daemon to start flushing ALL pending values to disk.  This
 376 returns immediately, even though the writes may take a long time.
 377
 378 =item B<PENDING> I<filename>
 379
 380 Shows any "pending" updates for a file, in order.  The updates shown have
 381 not yet been written to the underlying RRD file.
 382
 383 =item B<FORGET> I<filename>
 384
 385 Removes I<filename> from the cache.  Any pending updates B<WILL BE LOST>.
 386
 387 =item B<QUEUE>
 388
 389 Shows the files that are on the output queue.  Returns zero or more lines
 390 in the following format, where E<lt>num_valsE<gt> is the number of values
 391 to be written for the E<lt>fileE<gt>:
 392
 393     <num_vals> <file>
 394
 395 =item B<HELP> [I<command>]
 396
 397 Returns a short usage message. If no command is given, or I<command> is
 398 B<HELP>, a list of commands supported by the daemon is returned. Otherwise a
 399 short description, possibly containing a pointer to a manual page, is returned.
 400 Obviously, this is meant for interactive usage and the format in which the
 401 commands and usage summaries are returned is not well defined.
 402
 403 =item B<STATS>
 404
 405 Returns a list of metrics which can be used to measure the daemons performance
 406 and check its status. For a description of the values returned, see
 407 L<Performance Values> below.
 408
 409 The format in which the values are returned is similar to many other line based
 410 protocols: Each value is printed on a separate line, each consisting of the
 411 name of the value, a colon, one or more spaces and the actual value.
 412
 413 Example:
 414
 415  9 Statistics follow
 416  QueueLength: 0
 417  UpdatesReceived: 30
 418  FlushesReceived: 2
 419  UpdatesWritten: 13
 420  DataSetsWritten: 390
 421  TreeNodesNumber: 13
 422  TreeDepth: 4
 423  JournalBytes: 190
 424  JournalRotate: 0
 425
 426 =item B<UPDATE> I<filename> I<values> [I<values> ...]
 427
 428 Adds more data to a filename. This is B<the> operation the daemon was designed
 429 for, so describing the mechanism again is unnecessary. Read L<HOW IT WORKS>
 430 above for a detailed explanation.
 431
 432 Note that rrdcached only accepts absolute timestamps in the update values.
 433 Updates strings like "N:1:2:3" are automatically converted to absolute
 434 time by the RRD client library before sending to rrdcached.
 435
 436 =item B<WROTE> I<filename>
 437
 438 This command is written to the journal after a file is successfully
 439 written out to disk.  It is used during journal replay to determine which
 440 updates have already been applied.  It is I<only> valid in the journal; it
 441 is not accepted from the other command channels.
 442
 443 =item B<BATCH>
 444
 445 This command initiates the bulk load of multiple commands.  This is
 446 designed for installations with extremely high update rates, since it
 447 permits more than one command to be issued per read() and write().
 448
 449 All commands are executed just as they would be if given individually,
 450 except for output to the user.  Messages indicating success are
 451 suppressed, and error messages are delayed until the client is finished.
 452
 453 Command processing is finished when the client sends a dot (".") on its
 454 own line.  After the client has finished, the server responds with an
 455 error count and the list of error messages (if any).  Each error messages
 456 indicates the number of the command to which it corresponds, and the error
 457 message itself.  The first user command after B<BATCH> is command number one.
 458
 459     client:  BATCH
 460     server:  0 Go ahead.  End with dot '.' on its own line.
 461     client:  UPDATE x.rrd 1223661439:1:2:3            <--- command #1
 462     client:  UPDATE y.rrd 1223661440:3:4:5            <--- command #2
 463     client:  and so on...
 464     client:  .
 465     server:  2 Errors
 466     server:  1 message for command 1
 467     server:  12 message for command 12
 468
 469 =item B<QUIT>
 470
 471 Disconnect from rrdcached.
 472
 473 =back
 474
 475 =head2 Performance Values
 476
 477 The following counters are returned by the B<STATS> command:
 478
 479 =over 4
 480
 481 =item B<QueueLength> I<(unsigned 64bit integer)>
 482
 483 Number of nodes currently enqueued in the update queue.
 484
 485 =item B<UpdatesReceived> I<(unsigned 64bit integer)>
 486
 487 Number of UPDATE commands received.
 488
 489 =item B<FlushesReceived> I<(unsigned 64bit integer)>
 490
 491 Number of FLUSH commands received.
 492
 493 =item B<UpdatesWritten> I<(unsigned 64bit integer)>
 494
 495 Total number of updates, i.E<nbsp>e. calls to C<rrd_update_r>, since the
 496 daemon was started.
 497
 498 =item B<DataSetsWritten> I<(unsigned 64bit integer)>
 499
 500 Total number of "data sets" written to disk since the daemon was
 501 started. A data set is one or more values passed to the B<UPDATE>
 502 command. For example: C<1223661439:123:456> is one data set with two
 503 values. The term "data set" is used to prevent confusion whether
 504 individual values or groups of values are counted.
 505
 506 =item B<TreeNodesNumber> I<(unsigned 64bit integer)>
 507
 508 Number of nodes in the cache.
 509
 510 =item B<TreeDepth> I<(unsigned 64bit integer)>
 511
 512 Depth of the tree used for fast key lookup.
 513
 514 =item B<JournalBytes> I<(unsigned 64bit integer)>
 515
 516 Total number of bytes written to the journal since startup.
 517
 518 =item B<JournalRotate> I<(unsigned 64bit integer)>
 519
 520 Number of times the journal has been rotated since startup.
 521
 522 =back
 523
 524 =head1 SIGNALS
 525
 526 =over 4
 527
 528 =item SIGINT and SIGTERM
 529
 530 The daemon exits normally on receipt of either of these signals.  Pending
 531 updates are handled in accordance with the B<-j> and B<-F> options.
 532
 533 =item SIGUSR1
 534
 535 The daemon exits AFTER flushing all updates out to disk.  This may take a
 536 while.
 537
 538 =item SIGUSR2
 539
 540 The daemon exits immediately, without flushing updates out to disk.
 541 Pending updates will be replayed from the journal when the daemon starts
 542 up again.  B<WARNING: if journaling (-j) is NOT enabled, any pending
 543 updates WILL BE LOST>.
 544
 545 =back
 546
 547 =head1 BUGS
 548
 549 No known bugs at the moment.
 550
 551 =head1 SEE ALSO
 552
 553 L<rrdtool>, L<rrdgraph>
 554
 555 =head1 AUTHOR
 556
 557 B<rrdcached> and this manual page have been written by Florian Forster
 558 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
 559
 560 =head1 CONTRIBUTORS
 561
 562 kevin brintnall E<lt>kbrint@rufus.netE<gt>
 563
 564 =cut
 565