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