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