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