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