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> I<address>] [B<-w> I<timeout>] [B<-z> I<delay>] [B<-f> I<timeout>] [B<-j> I<dir>] [-F]
  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<-w> I<timeout>
  56
  57 Data is written to disk every I<timeout> seconds. If this option is not
  58 specified the default interval of 300E<nbsp>seconds will be used.
  59
  60 =item B<-z> I<delay>
  61
  62 If specified, rrdcached will delay writing of each RRD for a random number
  63 of seconds in the rangeE<nbsp>[0,I<delay>).  This will avoid too many
  64 writes being queued simultaneously.  This value should be no greater than
  65 the value specified in B<-w>.  By default, there is no delay.
  66
  67 =item B<-f> I<timeout>
  68
  69 Every I<timeout> seconds the entire cache is searched for old values which are
  70 written to disk. This only concerns files to which updates have stopped, so
  71 setting this to a high value, such as 3600E<nbsp>seconds, is acceptable in most
  72 cases. This timeout defaults to 3600E<nbsp>seconds.
  73
  74 =item B<-p> I<file>
  75
  76 Sets the name and location of the PID-file. If not specified, the default,
  77 C<I<$localststedir>/run/rrdcached.pid> will be used.
  78
  79 =item B<-j> I<dir>
  80
  81 Write updates to a journal in I<dir>.  In the event of a program or system
  82 crash, this will allow the daemon to write any updates that were pending
  83 at the time of the crash.
  84
  85 On startup, the daemon will check for journal files in this directory.  If
  86 found, all updates therein will be read into memory before the daemon
  87 starts accepting new connections.
  88
  89 The journal will be rotated with the same frequency as the flush timer
  90 given by B<-f>.
  91
  92 When journaling is enabled, the daemon will use a fast shutdown procedure.
  93 Rather than flushing all files to disk, it will make sure the journal is
  94 properly written and exit immediately.  Although the RRD data files are
  95 not fully up-to-date, no information is lost; all pending updates will be
  96 replayed from the journal next time the daemon starts up.
  97
  98 To disable fast shutdown, use the B<-F> option.
  99
 100 =item B<-F>
 101
 102 ALWAYS flush all updates to the RRD data files when the daemon is shut
 103 down, regardless of journal setting.
 104
 105 =item B<-b> I<dir>
 106
 107 The daemon will change into a specific directory at startup. All files passed
 108 to the daemon, that are specified by a B<relative> path, will be interpreted
 109 to be relative to this directory. If not given the default, C</tmp>, will be
 110 used.
 111
 112   +------------------------+------------------------+
 113   ! Command line           ! File updated           !
 114   +------------------------+------------------------+
 115   ! foo.rrd                ! /tmp/foo.rrd           !
 116   ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
 117   ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
 118   +------------------------+------------------------+
 119   Paths given on the command  line and paths actually
 120   updated by the daemon,  assuming the base directory
 121   "/tmp".
 122
 123 =back
 124
 125 =head1 EFFECTED RRDTOOL COMMANDS
 126
 127 The following commands may be made aware of the B<rrdcached> using the command
 128 line argument B<--daemon> or the environment variable B<RRDCACHED_ADDRESS>:
 129
 130 =over 4
 131
 132 =item B<dump>
 133
 134 =item B<fetch>
 135
 136 =item B<flush>
 137
 138 =item B<graph>
 139
 140 =item B<graphv>
 141
 142 =item B<info>
 143
 144 =item B<last>
 145
 146 =item B<lastupdate>
 147
 148 =item B<update>
 149
 150 =item B<xport>
 151
 152 =back
 153
 154 The B<update> command can send values to the daemon instead of writing them to
 155 the disk itself. All other commands can send a B<FLUSH> command (see below) to
 156 the daemon before accessing the files, so they work with up-to-date data even
 157 if the cache timeout is large.
 158
 159 =head1 ERROR REPORTING
 160
 161 The daemon reports errors in one of two ways: During startup, error messages
 162 are printed to C<STDERR>. One of the steps when starting up is to fork to the
 163 background and closing C<STDERR> - after this writing directly to the user is
 164 no longer possible. Once this has happened, the daemon will send log messages
 165 to the system logging daemon using L<syslog(3)>. The facility used it
 166 C<LOG_DAEMON>.
 167
 168 =head1 HOW IT WORKS
 169
 170 When receiving an update, B<rrdcached> does not write to disk but looks for an
 171 entry for that file in its internal tree. If not found, an entry is created
 172 including the current time (called "First" in the diagram below). This time is
 173 B<not> the time specified on the command line but the time the operating system
 174 considers to be "now". The value and time of the value (called "Time" in the
 175 diagram below) are appended to the tree node.
 176
 177 When appending a value to a tree node, it is checked whether it's time to write
 178 the values to disk. Values are written to disk if
 179 S<C<now() - First E<gt>= timeout>>, where C<timeout> is the timeout specified
 180 using the B<-w> option, see L<OPTIONS>. If the values are "old enough" they
 181 will be enqueued in the "update queue", i.E<nbsp>e. they will be appended to
 182 the linked list shown below.  Because the tree nodes and the elements of the
 183 linked list are the same data structures in memory, any update to a file that
 184 has already been enqueued will be written with the next write to the RRD file,
 185 too.
 186
 187 A separate "update thread" constantly dequeues the first element in the update
 188 queue and writes all its values to the appropriate file. So as long as the
 189 update queue is not empty files are written at the highest possible rate.
 190
 191 Since the timeout of files is checked only when new values are added to the
 192 file, "dead" files, i.E<nbsp>e. files that are not updated anymore, would never
 193 be written to disk. Therefore, every now and then, controlled by the B<-f>
 194 option, the entire tree is walked and all "old" values are enqueued. Since this
 195 only affects "dead" files and walking the tree is relatively expensive, you
 196 should set the "flush interval" to a reasonably high value. The default is
 197 3600E<nbsp>seconds (one hour).
 198
 199 The downside of caching values is that they won't show up in graphs generated
 200 from the RRDE<nbsp>files. To get around this, the daemon provides the "flush
 201 command" to flush specific files. This means that the file is inserted at the
 202 B<head> of the update queue or moved there if it is already enqueued. The flush
 203 command will return only after the file's pending updates have been written
 204 to disk.
 205
 206  +------+   +------+                               +------+
 207  ! head !   ! root !                               ! tail !
 208  +---+--+   +---+--+                               +---+--+
 209      !         /\                                      !
 210      !        /  \                                     !
 211      !       /\  /\                                    !
 212      !      /\/\ \ `----------------- ... --------,    !
 213      V     /      `-------,                       !    V
 214  +---+----+---+    +------+-----+             +---+----+---+
 215  ! File:  foo !    ! File:  bar !             ! File:  qux !
 216  ! First: 101 !    ! First: 119 !             ! First: 180 !
 217  ! Next:   ---+--->! Next:   ---+---> ... --->! Next:   -  !
 218  +============+    +============+             +============+
 219  ! Time:  100 !    ! Time:  120 !             ! Time:  180 !
 220  ! Value:  10 !    ! Value: 0.1 !             ! Value: 2,2 !
 221  +------------+    +------------+             +------------+
 222  ! Time:  110 !    ! Time:  130 !             ! Time:  190 !
 223  ! Value:  26 !    ! Value: 0.1 !             ! Value: 7,3 !
 224  +------------+    +------------+             +------------+
 225  :            :    :            :             :            :
 226  +------------+    +------------+             +------------+
 227  ! Time:  230 !    ! Time:  250 !             ! Time:  310 !
 228  ! Value:  42 !    ! Value: 0.2 !             ! Value: 1,2 !
 229  +------------+    +------------+             +------------+
 230
 231 The above diagram demonstrates:
 232
 233 =over
 234
 235 =item *
 236
 237 Files/values are stored in a (balanced) tree.
 238
 239 =item *
 240
 241 Tree nodes and entries in the update queue are the same data structure.
 242
 243 =item *
 244
 245 The local time ("First") and the time specified in updates ("Time") may differ.
 246
 247 =item *
 248
 249 Timed out values are inserted at the "tail".
 250
 251 =item *
 252
 253 Explicitly flushed values are inserted at the "head".
 254
 255 =item *
 256
 257 ASCII art rocks.
 258
 259 =back
 260
 261 =head1 SECURITY CONSIDERATIONS
 262
 263 This daemon is meant to improve IOE<nbsp>performance for setups with thousands
 264 of RRDE<nbsp>file to be updated. So security measures built into the daemon can
 265 be summarized easily: B<There is no security built in!>
 266
 267 There is no authentication and authorization, so B<you> will have to take care
 268 that only authorized clients can talk to the daemon. Since we assume that graph
 269 collection is done on a dedicated machine, i.E<nbsp>e. the box doesn't do
 270 anything else and especially does not have any interactive logins other than
 271 root, a UNIX domain socket should take care of that.
 272
 273 If you (want to) use the network capability, i.E<nbsp>e. let the daemon bind to
 274 an IPv4 or IPv6 socket, it is B<your> job to install a packet filter or similar
 275 mechanism to prevent unauthorized connections. Unless you have a dedicated VLAN
 276 or VPN for this, using the network option is probably a bad idea!
 277
 278 The daemon will blindly write to any file it gets told, so you really should
 279 create a separate user just for this daemon. Also it does not do any sanity
 280 checks, so if it gets told to write values for a time far in the future, your
 281 files will be messed up good!
 282
 283 You have been warned.
 284
 285 =head1 PROTOCOL
 286
 287 The daemon communicates with clients using a line based ASCII protocol which is
 288 easy to read and easy to type. This makes it easy for scripts to implement the
 289 protocol and possible for users to use L<telnet> to connect to the daemon
 290 and test stuff "by hand".
 291
 292 The protocol is line based, this means that each record consists of one or more
 293 lines. A line is terminated by the line feed character C<0x0A>, commonly
 294 written as C<\n>. In the examples below, this character will be written as
 295 C<E<lt>LFE<gt>> ("line feed").
 296
 297 After the connection has been established, the client is expected to send a
 298 "command". A command consists of the command keyword, possibly some arguments,
 299 and a terminating newline character. For a list of commands, see
 300 L<Valid Commands> below.
 301
 302 Example:
 303
 304   FLUSH /tmp/foo.rrd<LF>
 305
 306 The daemon answers with a line consisting of a status code and a short status
 307 message, separated by one or more space characters. A negative status code
 308 signals an error, a positive status code or zero signal success. If the status
 309 code is greater than zero, it indicates the number of lines that follow the
 310 status line.
 311
 312 Examples:
 313
 314  0 Success<LF>
 315
 316  2 Two lines follow<LF>
 317  This is the first line<LF>
 318  And this is the second line<LF>
 319
 320 =head2 Valid Commands
 321
 322 The following commands are understood by the daemon:
 323
 324 =over 4
 325
 326 =item B<FLUSH> I<filename>
 327
 328 Causes the daemon to put I<filename> to the B<head> of the update queue
 329 (possibly moving it there if the node is already enqueued). The answer will be
 330 sent B<after> the node has been dequeued.
 331
 332 =item B<FLUSHALL>
 333
 334 Causes the daemon to start flushing ALL pending values to disk.  This
 335 returns immediately, even though the writes may take a long time.
 336
 337 =item B<HELP> [I<command>]
 338
 339 Returns a short usage message. If no command is given, or I<command> is
 340 B<HELP>, a list of commands supported by the daemon is returned. Otherwise a
 341 short description, possibly containing a pointer to a manual page, is returned.
 342 Obviously, this is meant for interactive usage and the format in which the
 343 commands and usage summaries are returned is not well defined.
 344
 345 =item B<STATS>
 346
 347 Returns a list of metrics which can be used to measure the daemons performance
 348 and check its status. For a description of the values returned, see
 349 L<Performance Values> below.
 350
 351 The format in which the values are returned is similar to many other line based
 352 protocols: Each value is printed on a separate line, each consisting of the
 353 name of the value, a colon, one or more spaces and the actual value.
 354
 355 Example:
 356
 357  9 Statistics follow
 358  QueueLength: 0
 359  UpdatesReceived: 30
 360  FlushesReceived: 2
 361  UpdatesWritten: 13
 362  DataSetsWritten: 390
 363  TreeNodesNumber: 13
 364  TreeDepth: 4
 365  JournalBytes: 190
 366  JournalRotate: 0
 367
 368 =item B<UPDATE> I<filename> I<values> [I<values> ...]
 369
 370 Adds more data to a filename. This is B<the> operation the daemon was designed
 371 for, so describing the mechanism again is unnecessary. Read L<HOW IT WORKS>
 372 above for a detailed explanation.
 373
 374 =item B<WROTE> I<filename>
 375
 376 This command is written to the journal after a file is successfully
 377 written out to disk.  It is used during journal replay to determine which
 378 updates have already been applied.  It is I<only> valid in the journal; it
 379 is not accepted from the other command channels.
 380
 381 =back
 382
 383 =head2 Performance Values
 384
 385 The following counters are returned by the B<STATS> command:
 386
 387 =over 4
 388
 389 =item B<QueueLength> I<(unsigned 64bit integer)>
 390
 391 Number of nodes currently enqueued in the update queue.
 392
 393 =item B<UpdatesReceived> I<(unsigned 64bit integer)>
 394
 395 Number of UPDATE commands received.
 396
 397 =item B<FlushesReceived> I<(unsigned 64bit integer)>
 398
 399 Number of FLUSH commands received.
 400
 401 =item B<UpdatesWritten> I<(unsigned 64bit integer)>
 402
 403 Total number of updates, i.E<nbsp>e. calls to C<rrd_update_r>, since the
 404 daemon was started.
 405
 406 =item B<DataSetsWritten> I<(unsigned 64bit integer)>
 407
 408 Total number of "data sets" written to disk since the daemon was started. A
 409 data set is one or more values passed to the B<UPDATE> command. For example:
 410 C<N:123:456> is one data set with two values. The term "data set" is used to
 411 prevent confusion whether individual values or groups of values are counted.
 412
 413 =item B<TreeNodesNumber> I<(unsigned 64bit integer)>
 414
 415 Number of nodes in the cache.
 416
 417 =item B<TreeDepth> I<(unsigned 64bit integer)>
 418
 419 Depth of the tree used for fast key lookup.
 420
 421 =item B<JournalBytes> I<(unsigned 64bit integer)>
 422
 423 Total number of bytes written to the journal since startup.
 424
 425 =item B<JournalRotate> I<(unsigned 64bit integer)>
 426
 427 Number of times the journal has been rotated since startup.
 428
 429 =back
 430
 431 =head1 SIGNALS
 432
 433 =over 4
 434
 435 =item SIGINT and SIGTERM
 436
 437 The daemon exits normally on receipt of either of these signals.  Pending
 438 updates are handled in accordance with the B<-j> and B<-F> options.
 439
 440 =item SIGUSR1
 441
 442 The daemon exits AFTER flushing all updates out to disk.  This may take a
 443 while.
 444
 445 =item SIGUSR2
 446
 447 The daemon exits immediately, without flushing updates out to disk.
 448 Pending updates will be replayed from the journal when the daemon starts
 449 up again.  B<WARNING: if journaling (-j) is NOT enabled, any pending
 450 updates WILL BE LOST>.
 451
 452 =back
 453
 454 =head1 SIGNALS
 455
 456 =over 4
 457
 458 =item SIGINT and SIGTERM
 459
 460 The daemon exits normally on receipt of either of these signals.
 461
 462 =back
 463
 464 =head1 BUGS
 465
 466 No known bugs at the moment.
 467
 468 =head1 SEE ALSO
 469
 470 L<rrdtool>, L<rrdgraph>
 471
 472 =head1 AUTHOR
 473
 474 B<rrdcached> and this manual page have been written by Florian Forster
 475 E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
 476
 477 =head1 CONTRIBUTORS
 478
 479 kevin brintnall E<lt>kbrint@rufus.netE<gt>
 480
 481 =cut
 482