program/doc/rrdcached.pod

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