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