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