doc/rrdcached.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>rrdcached</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:root@localhost" />
   8 </head>
   9
  10 <body style="background-color: white">
  11
  12
  13 <!-- INDEX BEGIN -->
  14 <div name="index">
  15 <p><a name="__index__"></a></p>
  16 <!--
  17
  18 <ul>
  19
  20         <li><a href="#name">NAME</a></li>
  21         <li><a href="#synopsis">SYNOPSIS</a></li>
  22         <li><a href="#description">DESCRIPTION</a></li>
  23         <li><a href="#options">OPTIONS</a></li>
  24         <li><a href="#affected_rrdtool_commands">AFFECTED RRDTOOL COMMANDS</a></li>
  25         <li><a href="#error_reporting">ERROR REPORTING</a></li>
  26         <li><a href="#how_it_works">HOW IT WORKS</a></li>
  27         <li><a href="#security_considerations">SECURITY CONSIDERATIONS</a></li>
  28         <ul>
  29
  30                 <li><a href="#authentication">Authentication</a></li>
  31                 <li><a href="#authorization">Authorization</a></li>
  32                 <li><a href="#encryption">Encryption</a></li>
  33                 <li><a href="#sanity_checking">Sanity checking</a></li>
  34                 <li><a href="#conclusion">Conclusion</a></li>
  35         </ul>
  36
  37         <li><a href="#protocol">PROTOCOL</a></li>
  38         <ul>
  39
  40                 <li><a href="#valid_commands">Valid Commands</a></li>
  41                 <li><a href="#performance_values">Performance Values</a></li>
  42         </ul>
  43
  44         <li><a href="#signals">SIGNALS</a></li>
  45         <li><a href="#bugs">BUGS</a></li>
  46         <li><a href="#see_also">SEE ALSO</a></li>
  47         <li><a href="#author">AUTHOR</a></li>
  48         <li><a href="#contributors">CONTRIBUTORS</a></li>
  49 </ul>
  50
  51 -->
  52
  53
  54 </div>
  55 <!-- INDEX END -->
  56
  57 <p>
  58 </p>
  59 <hr />
  60 <h1><a name="name">NAME</a></h1>
  61 <p>rrdcached - Data caching daemon for rrdtool</p>
  62 <p>
  63 </p>
  64 <hr />
  65 <h1><a name="synopsis">SYNOPSIS</a></h1>
  66 <p><strong>rrdcached</strong>
  67 [<strong>-P</strong>&nbsp;<em>permissions</em>]
  68 [<strong>-l</strong>&nbsp;<em>address</em>]
  69 [<strong>-s</strong>&nbsp;<em>group</em>]
  70 [<strong>-w</strong>&nbsp;<em>timeout</em>]
  71 [<strong>-z</strong>&nbsp;<em>delay</em>]
  72 [<strong>-f</strong>&nbsp;<em>timeout</em>]
  73 [<strong>-p</strong>&nbsp;<em>pid_file</em>]
  74 [<strong>-t</strong>&nbsp;<em>write_threads</em>]
  75 [<strong>-j</strong>&nbsp;<em>journal_dir</em>]
  76 [-F]
  77 [-g]
  78 [<strong>-b</strong>&nbsp;<em>base_dir</em>&nbsp;[<strong>-B</strong>]]</p>
  79 <p>
  80 </p>
  81 <hr />
  82 <h1><a name="description">DESCRIPTION</a></h1>
  83 <p><strong>rrdcached</strong> is a daemon that receives updates to existing RRD files,
  84 accumulates them and, if enough have been received or a defined time has
  85 passed, writes the updates to the RRD file. A <em>flush</em> command may be used to
  86 force writing of values to disk, so that graphing facilities and similar can
  87 work with up-to-date data.</p>
  88 <p>The daemon was written with big setups in mind. Those setups usually run into
  89 IO&nbsp;related problems sooner or later for reasons that are beyond the scope
  90 of this document. Check the wiki at the RRDtool homepage for details. Also
  91 check <a href="#security_considerations">SECURITY CONSIDERATIONS</a> below before using this daemon! A detailed
  92 description of how the daemon operates can be found in the <a href="#how_it_works">HOW IT WORKS</a>
  93 section below.</p>
  94 <p>
  95 </p>
  96 <hr />
  97 <h1><a name="options">OPTIONS</a></h1>
  98 <dl>
  99 <dt><strong><a name="l_address" class="item"><strong>-l</strong> <em>address</em></a></strong></dt>
 100
 101 <dd>
 102 <p>Tells the daemon to bind to <em>address</em> and accept incoming connections on that
 103 socket. If <em>address</em> begins with <code>unix:</code>, everything following that prefix is
 104 interpreted as the path to a UNIX domain socket. Otherwise the address or node
 105 name are resolved using <code>getaddrinfo()</code>.</p>
 106 <p>For network sockets, a port may be specified by using the form
 107 <code>[address]:port</code>. If the address is an IPv4 address or a fully
 108 qualified domain name (i.&nbsp;e. the address contains at least one dot
 109 (<code>.</code>)), the square brackets can be omitted, resulting in the (simpler)
 110 <code>address:port</code> pattern. The default port is <strong>42217/tcp</strong>. If you
 111 specify a network socket, it is mandatory to read the
 112 <a href="#security_considerations">SECURITY CONSIDERATIONS</a> section.</p>
 113 <p>The following formats are accepted. Please note that the address of the UNIX
 114 domain socket <strong>must</strong> start with a slash in the second case!</p>
 115 <pre>
 116    unix:&lt;/path/to/unix.sock&gt;
 117    /&lt;path/to/unix.sock&gt;
 118    &lt;hostname-or-ip&gt;
 119    [&lt;hostname-or-ip&gt;]:&lt;port&gt;
 120    &lt;hostname-or-ipv4&gt;:&lt;port&gt;</pre>
 121 <p>If the <strong>-l</strong> option is not specified the default address,
 122 <code>unix:/tmp/rrdcached.sock</code>, will be used.</p>
 123 </dd>
 124 <dt><strong><a name="s_group_name_gid" class="item"><strong>-s</strong> <em>group_name</em>|<em>gid</em></a></strong></dt>
 125
 126 <dd>
 127 <p>Set the group permissions of a UNIX domain socket. The option accepts either
 128 a numeric group id or group name. That group will then have both read and write
 129 permissions (the socket will have file permissions 0750) for the socket and,
 130 therefore, is able to send commands to the daemon. This
 131 may be useful in cases where you cannot easily run all RRD processes with the same
 132 user privileges (e.g. graph generating CGI scripts that typically run in the
 133 permission context of the web server).</p>
 134 <p>This option affects the <em>following</em> UNIX socket addresses (the following
 135 <strong>-l</strong> options) or the default socket (if no <strong>-l</strong> options have been
 136 specified), i.e., you may specify different settings for different
 137 sockets.</p>
 138 <p>The default is not to change ownership or permissions of the socket and, thus,
 139 use the system default.</p>
 140 </dd>
 141 <dt><strong><a name="m_mode" class="item"><strong>-m</strong> <em>mode</em></a></strong></dt>
 142
 143 <dd>
 144 <p>Set the file permissions of a UNIX domain socket. The option accepts an octal
 145 number representing the bit pattern for the mode (see <em>chmod(1)</em> for
 146 details).</p>
 147 <p>Please note that not all systems honor this setting. On Linux, read/write
 148 permissions are required to connect to a UNIX socket. However, many
 149 BSD-derived systems ignore permissions for UNIX sockets. See <em>unix(7)</em> for
 150 details.</p>
 151 <p>This option affects the <em>following</em> UNIX socket addresses (the following
 152 <strong>-l</strong> options) or the default socket (if no <strong>-l</strong> options have been
 153 specified), i.e., you may specify different settings for different
 154 sockets.</p>
 155 <p>The default is not to change ownership or permissions of the socket and, thus,
 156 use the system default.</p>
 157 </dd>
 158 <dt><strong><a name="p_command_command" class="item"><strong>-P</strong> <em>command</em>[,<em>command</em>[,...]]</a></strong></dt>
 159
 160 <dd>
 161 <p>Specifies the commands accepted via a network socket. This allows
 162 administrators of <em>RRDCacheD</em> to control the actions accepted from various
 163 sources.</p>
 164 <p>The arguments given to the <strong>-P</strong> option is a comma separated list of commands.
 165 For example, to allow the <code>FLUSH</code> and <code>PENDING</code> commands one could specify:</p>
 166 <pre>
 167   rrdcached -P FLUSH,PENDING $MORE_ARGUMENTS</pre>
 168 <p>The <strong>-P</strong> option affects the <em>following</em> socket addresses (the following <strong>-l</strong>
 169 options) or the default socket (if no <strong>-l</strong> options have been
 170 specified). In the following example, only the IPv4 network socket (address
 171 <code>10.0.0.1</code>) will be restricted to the <code>FLUSH</code> and <code>PENDING</code> commands:</p>
 172 <pre>
 173   rrdcached -l unix:/some/path -P FLUSH,PENDING -l 10.0.0.1</pre>
 174 <p>A complete list of available commands can be found in the section
 175 <a href="#valid_commands">Valid Commands</a> below. There are two minor special exceptions:</p>
 176 <ul>
 177 <li>
 178 <p>The <code>HELP</code> and <a href="#quit"><code>QUIT</code></a> commands are always allowed.</p>
 179 </li>
 180 <li>
 181 <p>If the <a href="#batch"><code>BATCH</code></a> command is accepted, the <strong>.</strong>&nbsp;command will automatically
 182 be accepted, too.</p>
 183 </li>
 184 </ul>
 185 <p>Please also read <a href="#security_considerations">SECURITY CONSIDERATIONS</a> below.</p>
 186 </dd>
 187 <dt><strong><a name="w_timeout" class="item"><strong>-w</strong> <em>timeout</em></a></strong></dt>
 188
 189 <dd>
 190 <p>Data is written to disk every <em>timeout</em> seconds. If this option is not
 191 specified the default interval of 300&nbsp;seconds will be used.</p>
 192 </dd>
 193 <dt><strong><a name="z_delay" class="item"><strong>-z</strong> <em>delay</em></a></strong></dt>
 194
 195 <dd>
 196 <p>If specified, rrdcached will delay writing of each RRD for a random number
 197 of seconds in the range&nbsp;[0,<em>delay</em>).  This will avoid too many
 198 writes being queued simultaneously.  This value should be no greater than
 199 the value specified in <strong>-w</strong>.  By default, there is no delay.</p>
 200 </dd>
 201 <dt><strong><a name="f_timeout" class="item"><strong>-f</strong> <em>timeout</em></a></strong></dt>
 202
 203 <dd>
 204 <p>Every <em>timeout</em> seconds the entire cache is searched for old values which are
 205 written to disk. This only concerns files to which updates have stopped, so
 206 setting this to a high value, such as 3600&nbsp;seconds, is acceptable in most
 207 cases. This timeout defaults to 3600&nbsp;seconds.</p>
 208 </dd>
 209 <dt><strong><a name="p_file" class="item"><strong>-p</strong> <em>file</em></a></strong></dt>
 210
 211 <dd>
 212 <p>Sets the name and location of the PID-file. If not specified, the default,
 213 <code>$localststedir/run/rrdcached.pid</code> will be used.</p>
 214 </dd>
 215 <dt><strong><a name="t_write_threads" class="item"><strong>-t</strong> <em>write_threads</em></a></strong></dt>
 216
 217 <dd>
 218 <p>Specifies the number of threads used for writing RRD files.  The default
 219 is&nbsp;4.  Increasing this number will allow rrdcached to have more
 220 simultaneous I/O requests into the kernel.  This may allow the kernel to
 221 re-order disk writes, resulting in better disk throughput.</p>
 222 </dd>
 223 <dt><strong><a name="j_dir" class="item"><strong>-j</strong> <em>dir</em></a></strong></dt>
 224
 225 <dd>
 226 <p>Write updates to a journal in <em>dir</em>.  In the event of a program or system
 227 crash, this will allow the daemon to write any updates that were pending
 228 at the time of the crash.</p>
 229 <p>On startup, the daemon will check for journal files in this directory.  If
 230 found, all updates therein will be read into memory before the daemon
 231 starts accepting new connections.</p>
 232 <p>The journal will be rotated with the same frequency as the flush timer
 233 given by <strong>-f</strong>.</p>
 234 <p>When journaling is enabled, the daemon will use a fast shutdown procedure.
 235 Rather than flushing all files to disk, it will make sure the journal is
 236 properly written and exit immediately.  Although the RRD data files are
 237 not fully up-to-date, no information is lost; all pending updates will be
 238 replayed from the journal next time the daemon starts up.</p>
 239 <p>To disable fast shutdown, use the <strong>-F</strong> option.</p>
 240 </dd>
 241 <dt><strong><a name="f" class="item"><strong>-F</strong></a></strong></dt>
 242
 243 <dd>
 244 <p>ALWAYS flush all updates to the RRD data files when the daemon is shut
 245 down, regardless of journal setting.</p>
 246 </dd>
 247 <dt><strong><a name="g" class="item"><strong>-g</strong></a></strong></dt>
 248
 249 <dd>
 250 <p>Run in the foreground.  The daemon will not <code>fork()</code>.</p>
 251 </dd>
 252 <dt><strong><a name="b_dir" class="item"><strong>-b</strong> <em>dir</em></a></strong></dt>
 253
 254 <dd>
 255 <p>The daemon will change into a specific directory at startup. All files passed
 256 to the daemon, that are specified by a <strong>relative</strong> path, will be interpreted
 257 to be relative to this directory. If not given the default, <code>/tmp</code>, will be
 258 used.</p>
 259 <pre>
 260   +------------------------+------------------------+
 261   ! Command line           ! File updated           !
 262   +------------------------+------------------------+
 263   ! foo.rrd                ! /tmp/foo.rrd           !
 264   ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
 265   ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
 266   +------------------------+------------------------+
 267   Paths given on the command  line and paths actually
 268   updated by the daemon,  assuming the base directory
 269   &quot;/tmp&quot;.</pre>
 270 <p><strong>WARNING:</strong> The paths up to and including the base directory <strong>MUST NOT BE</strong>
 271 symbolic links.  In other words, if the base directory is
 272 specified as:</p>
 273 <pre>
 274     -b /base/dir/somewhere</pre>
 275 <p>... then <strong>NONE</strong> of the following should be symbolic links:</p>
 276 <pre>
 277     /base
 278     /base/dir
 279     /base/dir/somewhere</pre>
 280 </dd>
 281 <dt><strong><a name="b" class="item"><strong>-B</strong></a></strong></dt>
 282
 283 <dd>
 284 <p>Only permit writes into the base directory specified in <strong>-b</strong> (and any
 285 sub-directories).  This does <strong>NOT</strong> detect symbolic links.  Paths
 286 containing <code>../</code> will also be blocked.</p>
 287 </dd>
 288 </dl>
 289 <p>
 290 </p>
 291 <hr />
 292 <h1><a name="affected_rrdtool_commands">AFFECTED RRDTOOL COMMANDS</a></h1>
 293 <p>The following commands may be made aware of the <strong>rrdcached</strong> using the command
 294 line argument <strong>--daemon</strong> or the environment variable <strong>RRDCACHED_ADDRESS</strong>:</p>
 295 <ul>
 296 <li>
 297 <p>dump</p>
 298 </li>
 299 <li>
 300 <p>fetch</p>
 301 </li>
 302 <li>
 303 <p>flush</p>
 304 </li>
 305 <li>
 306 <p>graph</p>
 307 </li>
 308 <li>
 309 <p>graphv</p>
 310 </li>
 311 <li>
 312 <p>info</p>
 313 </li>
 314 <li>
 315 <p>last</p>
 316 </li>
 317 <li>
 318 <p>lastupdate</p>
 319 </li>
 320 <li>
 321 <p>update</p>
 322 </li>
 323 <li>
 324 <p>xport</p>
 325 </li>
 326 </ul>
 327 <p>The <strong>update</strong> command can send values to the daemon instead of writing them to
 328 the disk itself. All other commands can send a <strong>FLUSH</strong> command (see below) to
 329 the daemon before accessing the files, so they work with up-to-date data even
 330 if the cache timeout is large.</p>
 331 <p>
 332 </p>
 333 <hr />
 334 <h1><a name="error_reporting">ERROR REPORTING</a></h1>
 335 <p>The daemon reports errors in one of two ways: During startup, error messages
 336 are printed to <code>STDERR</code>. One of the steps when starting up is to fork to the
 337 background and closing <code>STDERR</code> - after this writing directly to the user is
 338 no longer possible. Once this has happened, the daemon will send log messages
 339 to the system logging daemon using <code>syslog(3)</code>. The facility used is
 340 <code>LOG_DAEMON</code>.</p>
 341 <p>
 342 </p>
 343 <hr />
 344 <h1><a name="how_it_works">HOW IT WORKS</a></h1>
 345 <p>When receiving an update, <strong>rrdcached</strong> does not write to disk but looks for an
 346 entry for that file in its internal tree. If not found, an entry is created
 347 including the current time (called &quot;First&quot; in the diagram below). This time is
 348 <strong>not</strong> the time specified on the command line but the time the operating system
 349 considers to be &quot;now&quot;. The value and time of the value (called &quot;Time&quot; in the
 350 diagram below) are appended to the tree node.</p>
 351 <p>When appending a value to a tree node, it is checked whether it's time to write
 352 the values to disk. Values are written to disk if
 353 <code>now()&nbsp;-&nbsp;First&nbsp;&gt;=&nbsp;timeout</code>, where <code>timeout</code> is the timeout specified
 354 using the <strong>-w</strong> option, see <a href="#options">OPTIONS</a>. If the values are &quot;old enough&quot; they
 355 will be enqueued in the &quot;update queue&quot;, i.&nbsp;e. they will be appended to
 356 the linked list shown below.  Because the tree nodes and the elements of the
 357 linked list are the same data structures in memory, any update to a file that
 358 has already been enqueued will be written with the next write to the RRD file,
 359 too.</p>
 360 <p>A separate &quot;update thread&quot; constantly dequeues the first element in the update
 361 queue and writes all its values to the appropriate file. So as long as the
 362 update queue is not empty files are written at the highest possible rate.</p>
 363 <p>Since the timeout of files is checked only when new values are added to the
 364 file, &quot;dead&quot; files, i.&nbsp;e. files that are not updated anymore, would never
 365 be written to disk. Therefore, every now and then, controlled by the <strong>-f</strong>
 366 option, the entire tree is walked and all &quot;old&quot; values are enqueued. Since this
 367 only affects &quot;dead&quot; files and walking the tree is relatively expensive, you
 368 should set the &quot;flush interval&quot; to a reasonably high value. The default is
 369 3600&nbsp;seconds (one hour).</p>
 370 <p>The downside of caching values is that they won't show up in graphs generated
 371 from the RRD&nbsp;files. To get around this, the daemon provides the &quot;flush
 372 command&quot; to flush specific files. This means that the file is inserted at the
 373 <strong>head</strong> of the update queue or moved there if it is already enqueued. The flush
 374 command will return only after the file's pending updates have been written
 375 to disk.</p>
 376 <pre>
 377  +------+   +------+                               +------+
 378  ! head !   ! root !                               ! tail !
 379  +---+--+   +---+--+                               +---+--+
 380      !         /\                                      !
 381      !        /  \                                     !
 382      !       /\  /\                                    !
 383      !      /\/\ \ `----------------- ... --------,    !
 384      V     /      `-------,                       !    V
 385  +---+----+---+    +------+-----+             +---+----+---+
 386  ! File:  foo !    ! File:  bar !             ! File:  qux !
 387  ! First: 101 !    ! First: 119 !             ! First: 180 !
 388  ! Next:&amp;bar -+---&gt;! Next:&amp;... -+---&gt; ... ---&gt;! Next:NULL  !
 389  | Prev:NULL  !&lt;---+-Prev:&amp;foo  !&lt;--- ... ----+-Prev: &amp;... !
 390  +============+    +============+             +============+
 391  ! Time:  100 !    ! Time:  120 !             ! Time:  180 !
 392  ! Value:  10 !    ! Value: 0.1 !             ! Value: 2,2 !
 393  +------------+    +------------+             +------------+
 394  ! Time:  110 !    ! Time:  130 !             ! Time:  190 !
 395  ! Value:  26 !    ! Value: 0.1 !             ! Value: 7,3 !
 396  +------------+    +------------+             +------------+
 397  :            :    :            :             :            :
 398  +------------+    +------------+             +------------+
 399  ! Time:  230 !    ! Time:  250 !             ! Time:  310 !
 400  ! Value:  42 !    ! Value: 0.2 !             ! Value: 1,2 !
 401  +------------+    +------------+             +------------+</pre>
 402 <p>The above diagram demonstrates:</p>
 403 <ul>
 404 <li>
 405 <p>Files/values are stored in a (balanced) tree.</p>
 406 </li>
 407 <li>
 408 <p>Tree nodes and entries in the update queue are the same data structure.</p>
 409 </li>
 410 <li>
 411 <p>The local time (&quot;First&quot;) and the time specified in updates (&quot;Time&quot;) may differ.</p>
 412 </li>
 413 <li>
 414 <p>Timed out values are inserted at the &quot;tail&quot;.</p>
 415 </li>
 416 <li>
 417 <p>Explicitly flushed values are inserted at the &quot;head&quot;.</p>
 418 </li>
 419 <li>
 420 <p>ASCII art rocks.</p>
 421 </li>
 422 </ul>
 423 <p>
 424 </p>
 425 <hr />
 426 <h1><a name="security_considerations">SECURITY CONSIDERATIONS</a></h1>
 427 <p>
 428 </p>
 429 <h2><a name="authentication">Authentication</a></h2>
 430 <p>If your rrdtool installation was built without libwrap there is no form of
 431 authentication for clients connecting to the rrdcache daemon!</p>
 432 <p>If your rrdtool installation was built with libwrap then you can use
 433 hosts_access to restrict client access to the rrdcache daemon (rrdcached).  For more
 434 information on how to use hosts_access to restrict access to the rrdcache
 435 daemon you should read the <code>hosts_access(5)</code> man pages.</p>
 436 <p>It is still highly recommended to install a packet filter or similar mechanism to
 437 prevent unauthorized connections. Unless you have a dedicated VLAN or VPN for
 438 this, using network sockets is probably a bad idea!</p>
 439 <p>
 440 </p>
 441 <h2><a name="authorization">Authorization</a></h2>
 442 <p>There is minimal per-socket authorization.</p>
 443 <p>Authorization is currently done on a per-socket basis. That means each socket
 444 has a list of commands it will accept and it will accept. It will accept only
 445 those commands explicitly listed but it will (currently) accept these commands
 446 from anyone reaching the socket.</p>
 447 <p>If the networking sockets are to be used, it is necessary to restrict the
 448 accepted commands to those needed by external clients. If, for example,
 449 external clients want to draw graphs of the cached data, they should only be
 450 allowed to use the <code>FLUSH</code> command.</p>
 451 <p>
 452 </p>
 453 <h2><a name="encryption">Encryption</a></h2>
 454 <p>There is no encryption.</p>
 455 <p>Again, this may be added in the future, but for the time being it is your job
 456 to keep your private data private. Install a VPN or an encrypted tunnel if you
 457 statistics are confidential!</p>
 458 <p>
 459 </p>
 460 <h2><a name="sanity_checking">Sanity checking</a></h2>
 461 <p>There is no sanity checking.</p>
 462 <p>The daemon will blindly write to any file it gets told, so you really should
 463 create a separate user just for this daemon. Also it does not do any sanity
 464 checks, so if it gets told to write values for a time far in the future, your
 465 files will be messed up good!</p>
 466 <p>
 467 </p>
 468 <h2><a name="conclusion">Conclusion</a></h2>
 469 <ul>
 470 <li>
 471 <p>Security is the job of the administrator.</p>
 472 </li>
 473 <li>
 474 <p>We recommend to allow write access via UNIX domain sockets only.</p>
 475 </li>
 476 <li>
 477 <p>You have been warned.</p>
 478 </li>
 479 </ul>
 480 <p>
 481 </p>
 482 <hr />
 483 <h1><a name="protocol">PROTOCOL</a></h1>
 484 <p>The daemon communicates with clients using a line based ASCII protocol which is
 485 easy to read and easy to type. This makes it easy for scripts to implement the
 486 protocol and possible for users to use telnet to connect to the daemon
 487 and test stuff &quot;by hand&quot;.</p>
 488 <p>The protocol is line based, this means that each record consists of one or more
 489 lines. A line is terminated by the line feed character <code>0x0A</code>, commonly
 490 written as <code>\n</code>. In the examples below, this character will be written as
 491 <code>&lt;LF&gt;</code> (&quot;line feed&quot;).</p>
 492 <p>After the connection has been established, the client is expected to send a
 493 &quot;command&quot;. A command consists of the command keyword, possibly some arguments,
 494 and a terminating newline character. For a list of commands, see
 495 <a href="#valid_commands">Valid Commands</a> below.</p>
 496 <p>Example:</p>
 497 <pre>
 498   FLUSH /tmp/foo.rrd&lt;LF&gt;</pre>
 499 <p>The daemon answers with a line consisting of a status code and a short status
 500 message, separated by one or more space characters. A negative status code
 501 signals an error, a positive status code or zero signal success. If the status
 502 code is greater than zero, it indicates the number of lines that follow the
 503 status line.</p>
 504 <p>Examples:</p>
 505 <pre>
 506  0 Success&lt;LF&gt;</pre>
 507 <pre>
 508  2 Two lines follow&lt;LF&gt;
 509  This is the first line&lt;LF&gt;
 510  And this is the second line&lt;LF&gt;</pre>
 511 <p>
 512 </p>
 513 <h2><a name="valid_commands">Valid Commands</a></h2>
 514 <p>The following commands are understood by the daemon:</p>
 515 <dl>
 516 <dt><strong><a name="flush_filename" class="item"><strong>FLUSH</strong> <em>filename</em></a></strong></dt>
 517
 518 <dd>
 519 <p>Causes the daemon to put <em>filename</em> to the <strong>head</strong> of the update queue
 520 (possibly moving it there if the node is already enqueued). The answer will be
 521 sent <strong>after</strong> the node has been dequeued.</p>
 522 </dd>
 523 <dt><strong><a name="flushall" class="item"><strong>FLUSHALL</strong></a></strong></dt>
 524
 525 <dd>
 526 <p>Causes the daemon to start flushing ALL pending values to disk.  This
 527 returns immediately, even though the writes may take a long time.</p>
 528 </dd>
 529 <dt><strong><a name="pending_filename" class="item"><strong>PENDING</strong> <em>filename</em></a></strong></dt>
 530
 531 <dd>
 532 <p>Shows any &quot;pending&quot; updates for a file, in order.  The updates shown have
 533 not yet been written to the underlying RRD file.</p>
 534 </dd>
 535 <dt><strong><a name="forget_filename" class="item"><strong>FORGET</strong> <em>filename</em></a></strong></dt>
 536
 537 <dd>
 538 <p>Removes <em>filename</em> from the cache.  Any pending updates <strong>WILL BE LOST</strong>.</p>
 539 </dd>
 540 <dt><strong><a name="queue" class="item"><strong>QUEUE</strong></a></strong></dt>
 541
 542 <dd>
 543 <p>Shows the files that are on the output queue.  Returns zero or more lines
 544 in the following format, where &lt;num_vals&gt; is the number of values
 545 to be written for the &lt;file&gt;:</p>
 546 <pre>
 547     &lt;num_vals&gt; &lt;file&gt;</pre>
 548 </dd>
 549 <dt><strong><a name="help_command" class="item"><strong>HELP</strong> [<em>command</em>]</a></strong></dt>
 550
 551 <dd>
 552 <p>Returns a short usage message. If no command is given, or <em>command</em> is
 553 <strong>HELP</strong>, a list of commands supported by the daemon is returned. Otherwise a
 554 short description, possibly containing a pointer to a manual page, is returned.
 555 Obviously, this is meant for interactive usage and the format in which the
 556 commands and usage summaries are returned is not well defined.</p>
 557 </dd>
 558 <dt><strong><a name="stats" class="item"><strong>STATS</strong></a></strong></dt>
 559
 560 <dd>
 561 <p>Returns a list of metrics which can be used to measure the daemons performance
 562 and check its status. For a description of the values returned, see
 563 <a href="#performance_values">Performance Values</a> below.</p>
 564 <p>The format in which the values are returned is similar to many other line based
 565 protocols: Each value is printed on a separate line, each consisting of the
 566 name of the value, a colon, one or more spaces and the actual value.</p>
 567 <p>Example:</p>
 568 <pre>
 569  9 Statistics follow
 570  QueueLength: 0
 571  UpdatesReceived: 30
 572  FlushesReceived: 2
 573  UpdatesWritten: 13
 574  DataSetsWritten: 390
 575  TreeNodesNumber: 13
 576  TreeDepth: 4
 577  JournalBytes: 190
 578  JournalRotate: 0</pre>
 579 </dd>
 580 <dt><strong><a name="update_filename_values_values" class="item"><strong>UPDATE</strong> <em>filename</em> <em>values</em> [<em>values</em> ...]</a></strong></dt>
 581
 582 <dd>
 583 <p>Adds more data to a filename. This is <strong>the</strong> operation the daemon was designed
 584 for, so describing the mechanism again is unnecessary. Read <a href="#how_it_works">HOW IT WORKS</a>
 585 above for a detailed explanation.</p>
 586 <p>Note that rrdcached only accepts absolute timestamps in the update values.
 587 Updates strings like &quot;N:1:2:3&quot; are automatically converted to absolute
 588 time by the RRD client library before sending to rrdcached.</p>
 589 </dd>
 590 <dt><strong><a name="wrote_filename" class="item"><strong>WROTE</strong> <em>filename</em></a></strong></dt>
 591
 592 <dd>
 593 <p>This command is written to the journal after a file is successfully
 594 written out to disk.  It is used during journal replay to determine which
 595 updates have already been applied.  It is <em>only</em> valid in the journal; it
 596 is not accepted from the other command channels.</p>
 597 </dd>
 598 <dt><strong><a name="batch" class="item"><strong>BATCH</strong></a></strong></dt>
 599
 600 <dd>
 601 <p>This command initiates the bulk load of multiple commands.  This is
 602 designed for installations with extremely high update rates, since it
 603 permits more than one command to be issued per <code>read()</code> and <code>write()</code>.</p>
 604 <p>All commands are executed just as they would be if given individually,
 605 except for output to the user.  Messages indicating success are
 606 suppressed, and error messages are delayed until the client is finished.</p>
 607 <p>Command processing is finished when the client sends a dot (&quot;.&quot;) on its
 608 own line.  After the client has finished, the server responds with an
 609 error count and the list of error messages (if any).  Each error messages
 610 indicates the number of the command to which it corresponds, and the error
 611 message itself.  The first user command after <strong>BATCH</strong> is command number one.</p>
 612 <pre>
 613     client:  BATCH
 614     server:  0 Go ahead.  End with dot '.' on its own line.
 615     client:  UPDATE x.rrd 1223661439:1:2:3            &lt;--- command #1
 616     client:  UPDATE y.rrd 1223661440:3:4:5            &lt;--- command #2
 617     client:  and so on...
 618     client:  .
 619     server:  2 Errors
 620     server:  1 message for command 1
 621     server:  12 message for command 12</pre>
 622 </dd>
 623 <dt><strong><a name="quit" class="item"><strong>QUIT</strong></a></strong></dt>
 624
 625 <dd>
 626 <p>Disconnect from rrdcached.</p>
 627 </dd>
 628 </dl>
 629 <p>
 630 </p>
 631 <h2><a name="performance_values">Performance Values</a></h2>
 632 <p>The following counters are returned by the <strong>STATS</strong> command:</p>
 633 <dl>
 634 <dt><strong><a name="queuelength" class="item"><strong>QueueLength</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 635
 636 <dd>
 637 <p>Number of nodes currently enqueued in the update queue.</p>
 638 </dd>
 639 <dt><strong><a name="updatesreceived" class="item"><strong>UpdatesReceived</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 640
 641 <dd>
 642 <p>Number of UPDATE commands received.</p>
 643 </dd>
 644 <dt><strong><a name="flushesreceived" class="item"><strong>FlushesReceived</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 645
 646 <dd>
 647 <p>Number of FLUSH commands received.</p>
 648 </dd>
 649 <dt><strong><a name="updateswritten" class="item"><strong>UpdatesWritten</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 650
 651 <dd>
 652 <p>Total number of updates, i.&nbsp;e. calls to <code>rrd_update_r</code>, since the
 653 daemon was started.</p>
 654 </dd>
 655 <dt><strong><a name="datasetswritten" class="item"><strong>DataSetsWritten</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 656
 657 <dd>
 658 <p>Total number of &quot;data sets&quot; written to disk since the daemon was
 659 started. A data set is one or more values passed to the <strong>UPDATE</strong>
 660 command. For example: <code>1223661439:123:456</code> is one data set with two
 661 values. The term &quot;data set&quot; is used to prevent confusion whether
 662 individual values or groups of values are counted.</p>
 663 </dd>
 664 <dt><strong><a name="treenodesnumber" class="item"><strong>TreeNodesNumber</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 665
 666 <dd>
 667 <p>Number of nodes in the cache.</p>
 668 </dd>
 669 <dt><strong><a name="treedepth" class="item"><strong>TreeDepth</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 670
 671 <dd>
 672 <p>Depth of the tree used for fast key lookup.</p>
 673 </dd>
 674 <dt><strong><a name="journalbytes" class="item"><strong>JournalBytes</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 675
 676 <dd>
 677 <p>Total number of bytes written to the journal since startup.</p>
 678 </dd>
 679 <dt><strong><a name="journalrotate" class="item"><strong>JournalRotate</strong> <em>(unsigned 64bit integer)</em></a></strong></dt>
 680
 681 <dd>
 682 <p>Number of times the journal has been rotated since startup.</p>
 683 </dd>
 684 </dl>
 685 <p>
 686 </p>
 687 <hr />
 688 <h1><a name="signals">SIGNALS</a></h1>
 689 <dl>
 690 <dt><strong><a name="sigint_and_sigterm" class="item">SIGINT and SIGTERM</a></strong></dt>
 691
 692 <dd>
 693 <p>The daemon exits normally on receipt of either of these signals.  Pending
 694 updates are handled in accordance with the <strong>-j</strong> and <strong>-F</strong> options.</p>
 695 </dd>
 696 <dt><strong><a name="sigusr1" class="item">SIGUSR1</a></strong></dt>
 697
 698 <dd>
 699 <p>The daemon exits AFTER flushing all updates out to disk.  This may take a
 700 while.</p>
 701 </dd>
 702 <dt><strong><a name="sigusr2" class="item">SIGUSR2</a></strong></dt>
 703
 704 <dd>
 705 <p>The daemon exits immediately, without flushing updates out to disk.
 706 Pending updates will be replayed from the journal when the daemon starts
 707 up again.  <strong>WARNING: if journaling (-j) is NOT enabled, any pending
 708 updates WILL BE LOST</strong>.</p>
 709 </dd>
 710 </dl>
 711 <p>
 712 </p>
 713 <hr />
 714 <h1><a name="bugs">BUGS</a></h1>
 715 <p>No known bugs at the moment.</p>
 716 <p>
 717 </p>
 718 <hr />
 719 <h1><a name="see_also">SEE ALSO</a></h1>
 720 <p><a href="././rrdtool.html">the rrdtool manpage</a>, <a href="././rrdgraph.html">the rrdgraph manpage</a></p>
 721 <p>
 722 </p>
 723 <hr />
 724 <h1><a name="author">AUTHOR</a></h1>
 725 <p>Florian Forster &lt;octo&nbsp;at&nbsp;verplant.org&gt;</p>
 726 <p>Both <strong>rrdcached</strong> and this manual page have been written by Florian.</p>
 727 <p>
 728 </p>
 729 <hr />
 730 <h1><a name="contributors">CONTRIBUTORS</a></h1>
 731 <p>kevin brintnall &lt;<a href="mailto:kbrint@rufus.net">kbrint@rufus.net</a>&gt;</p>
 732
 733 </body>
 734
 735 </html>