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