doc/rrdcached.txt

   1 RRDCACHED(1)                        rrdtool                       RRDCACHED(1)
   2
   3
   4
   5 N\bNA\bAM\bME\bE
   6        rrdcached - Data caching daemon for rrdtool
   7
   8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
   9        r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd [-\b-P\bP _\bp_\be_\br_\bm_\bi_\bs_\bs_\bi_\bo_\bn_\bs] [-\b-l\bl _\ba_\bd_\bd_\br_\be_\bs_\bs] [-\b-w\bw _\bt_\bi_\bm_\be_\bo_\bu_\bt] [-\b-z\bz _\bd_\be_\bl_\ba_\by]
  10        [-\b-f\bf _\bt_\bi_\bm_\be_\bo_\bu_\bt] [-\b-p\bp _\bp_\bi_\bd_\b__\bf_\bi_\bl_\be] [-\b-t\bt _\bw_\br_\bi_\bt_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\bs] [-\b-j\bj _\bj_\bo_\bu_\br_\bn_\ba_\bl_\b__\bd_\bi_\br] [-F]
  11        [-g] [-\b-b\bb _\bb_\ba_\bs_\be_\b__\bd_\bi_\br [-\b-B\bB]]
  12
  13 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  14        r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd is a daemon that receives updates to existing RRD files,
  15        accumulates them and, if enough have been received or a defined time
  16        has passed, writes the updates to the RRD file. A _\bf_\bl_\bu_\bs_\bh command may be
  17        used to force writing of values to disk, so that graphing facilities
  18        and similar can work with up-to-date data.
  19
  20        The daemon was written with big setups in mind. Those setups usually
  21        run into IO related problems sooner or later for reasons that are
  22        beyond the scope of this document. Check the wiki at the RRDTool
  23        homepage for details. Also check "SECURITY CONSIDERATIONS" below before
  24        using this daemon! A detailed description of how the daemon operates
  25        can be found in the "HOW IT WORKS" section below.
  26
  27 O\bOP\bPT\bTI\bIO\bON\bNS\bS
  28        -\b-l\bl _\ba_\bd_\bd_\br_\be_\bs_\bs
  29            Tells the daemon to bind to _\ba_\bd_\bd_\br_\be_\bs_\bs and accept incoming connections
  30            on that socket. If _\ba_\bd_\bd_\br_\be_\bs_\bs begins with "unix:", everything
  31            following that prefix is interpreted as the path to a UNIX domain
  32            socket. Otherwise the address or node name are resolved using
  33            getaddrinfo.
  34
  35            For network sockets, a port may be specified by using the form
  36            "[\b[_\ba_\bd_\bd_\br_\be_\bs_\bs]\b]:\b:_\bp_\bo_\br_\bt_\b". If the address is an IPv4 address or a fully
  37            qualified domain name (i. e. the address contains at least one dot
  38            (".")), the square brackets can be omitted, resulting in the
  39            (simpler) "_\ba_\bd_\bd_\br_\be_\bs_\bs:\b:_\bp_\bo_\br_\bt_\b" pattern. The default port is 4\b42\b22\b21\b17\b7/\b/u\bud\bdp\bp. If
  40            you specify a network socket, it is mandatory to read the "SECURITY
  41            CONSIDERATIONS" section.
  42
  43            The following formats are accepted. Please note that the address of
  44            the UNIX domain socket m\bmu\bus\bst\bt 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\bl option is not specified the default address,
  53            "unix:/tmp/rrdcached.sock", will be used.
  54
  55        -\b-P\bP _\bc_\bo_\bm_\bm_\ba_\bn_\bd[,_\bc_\bo_\bm_\bm_\ba_\bn_\bd[,...]]
  56            Specifies the commands accepted via a network socket. This allows
  57            administrators of _\bR_\bR_\bD_\bC_\ba_\bc_\bh_\be_\bD to control the actions accepted from
  58            various sources.
  59
  60            The arguments given to the -\b-P\bP option is a comma separated list of
  61            commands.  For example, to allow the "FLUSH" and "PENDING" commands
  62            one could specify:
  63
  64              rrdcached -P FLUSH,PENDING $MORE_ARGUMENTS
  65
  66            The -\b-P\bP option effects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg socket addresses (the following
  67            -\b-l\bl options). In the following example, only the IPv4 network socket
  68            (address 10.0.0.1) will be restricted to the "FLUSH" and "PENDING"
  69            commands:
  70
  71              rrdcached -l unix:/some/path -P FLUSH,PENDING -l 10.0.0.1
  72
  73            A complete list of available commands can be found in the section
  74            "Valid Commands" below. There are two minor special exceptions:
  75
  76            ·   The "HELP" and "QUIT" commands are always allowed.
  77
  78            ·   If the "BATCH" command is accepted, the .\b. command will
  79                automatically be accepted, too.
  80
  81            Please also read "SECURITY CONSIDERATIONS" below.
  82
  83        -\b-w\bw _\bt_\bi_\bm_\be_\bo_\bu_\bt
  84            Data is written to disk every _\bt_\bi_\bm_\be_\bo_\bu_\bt seconds. If this option is
  85            not specified the default interval of 300 seconds will be used.
  86
  87        -\b-z\bz _\bd_\be_\bl_\ba_\by
  88            If specified, rrdcached will delay writing of each RRD for a random
  89            number of seconds in the range [0,_\bd_\be_\bl_\ba_\by).  This will avoid too many
  90            writes being queued simultaneously.  This value should be no
  91            greater than the value specified in -\b-w\bw.  By default, there is no
  92            delay.
  93
  94        -\b-f\bf _\bt_\bi_\bm_\be_\bo_\bu_\bt
  95            Every _\bt_\bi_\bm_\be_\bo_\bu_\bt seconds the entire cache is searched for old values
  96            which are written to disk. This only concerns files to which
  97            updates have stopped, so setting this to a high value, such as
  98            3600 seconds, is acceptable in most cases. This timeout defaults to
  99            3600 seconds.
 100
 101        -\b-p\bp _\bf_\bi_\bl_\be
 102            Sets the name and location of the PID-file. If not specified, the
 103            default, "_\b$_\bl_\bo_\bc_\ba_\bl_\bs_\bt_\bs_\bt_\be_\bd_\bi_\br_\b/_\br_\bu_\bn_\b/_\br_\br_\bd_\bc_\ba_\bc_\bh_\be_\bd_\b._\bp_\bi_\bd_\b" will be used.
 104
 105        -\b-t\bt _\bw_\br_\bi_\bt_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\bs
 106            Specifies the number of threads used for writing RRD files.  The
 107            default is 4.  Increasing this number will allow rrdcached to have
 108            more simultaneous I/O requests into the kernel.  This may allow the
 109            kernel to re-order disk writes, resulting in better disk
 110            throughput.
 111
 112        -\b-j\bj _\bd_\bi_\br
 113            Write updates to a journal in _\bd_\bi_\br.  In the event of a program or
 114            system crash, this will allow the daemon to write any updates that
 115            were pending at the time of the crash.
 116
 117            On startup, the daemon will check for journal files in this
 118            directory.  If found, all updates therein will be read into memory
 119            before the daemon starts accepting new connections.
 120
 121            The journal will be rotated with the same frequency as the flush
 122            timer given by -\b-f\bf.
 123
 124            When journaling is enabled, the daemon will use a fast shutdown
 125            procedure.  Rather than flushing all files to disk, it will make
 126            sure the journal is properly written and exit immediately.
 127            Although the RRD data files are not fully up-to-date, no
 128            information is lost; all pending updates will be replayed from the
 129            journal next time the daemon starts up.
 130
 131            To disable fast shutdown, use the -\b-F\bF option.
 132
 133        -\b-F\bF  ALWAYS flush all updates to the RRD data files when the daemon is
 134            shut down, regardless of journal setting.
 135
 136        -\b-g\bg  Run in the foreground.  The daemon will not _\bf_\bo_\br_\bk_\b(_\b).
 137
 138        -\b-b\bb _\bd_\bi_\br
 139            The daemon will change into a specific directory at startup. All
 140            files passed to the daemon, that are specified by a r\bre\bel\bla\bat\bti\biv\bve\be path,
 141            will be interpreted to be relative to this directory. If not given
 142            the default, "/tmp", will be used.
 143
 144              +------------------------+------------------------+
 145              ! Command line           ! File updated           !
 146              +------------------------+------------------------+
 147              ! foo.rrd                ! /tmp/foo.rrd           !
 148              ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
 149              ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
 150              +------------------------+------------------------+
 151              Paths given on the command  line and paths actually
 152              updated by the daemon,  assuming the base directory
 153              "/tmp".
 154
 155            W\bWA\bAR\bRN\bNI\bIN\bNG\bG:\b: The paths up to and including the base directory M\bMU\bUS\bST\bT N\bNO\bOT\bT
 156            B\bBE\bE symbolic links.  In other words, if the base directory is
 157            specified as:
 158
 159                -b /base/dir/somewhere
 160
 161            ... then N\bNO\bON\bNE\bE of the following should be symbolic links:
 162
 163                /base
 164                /base/dir
 165                /base/dir/somewhere
 166
 167        -\b-B\bB  Only permit writes into the base directory specified in -\b-b\bb (and any
 168            sub-directories).  This does N\bNO\bOT\bT detect symbolic links.  Paths
 169            containing "../" will also be blocked.
 170
 171 A\bAF\bFF\bFE\bEC\bCT\bTE\bED\bD R\bRR\bRD\bDT\bTO\bOO\bOL\bL C\bCO\bOM\bMM\bMA\bAN\bND\bDS\bS
 172        The following commands may be made aware of the r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd using the
 173        command line argument -\b--\b-d\bda\bae\bem\bmo\bon\bn or the environment variable
 174        R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS:
 175
 176        d\bdu\bum\bmp\bp
 177        f\bfe\bet\btc\bch\bh
 178        f\bfl\blu\bus\bsh\bh
 179        g\bgr\bra\bap\bph\bh
 180        g\bgr\bra\bap\bph\bhv\bv
 181        i\bin\bnf\bfo\bo
 182        l\bla\bas\bst\bt
 183        l\bla\bas\bst\btu\bup\bpd\bda\bat\bte\be
 184        u\bup\bpd\bda\bat\bte\be
 185        x\bxp\bpo\bor\brt\bt
 186
 187        The u\bup\bpd\bda\bat\bte\be command can send values to the daemon instead of writing
 188        them to the disk itself. All other commands can send a F\bFL\bLU\bUS\bSH\bH command
 189        (see below) to the daemon before accessing the files, so they work with
 190        up-to-date data even if the cache timeout is large.
 191
 192 E\bER\bRR\bRO\bOR\bR R\bRE\bEP\bPO\bOR\bRT\bTI\bIN\bNG\bG
 193        The daemon reports errors in one of two ways: During startup, error
 194        messages are printed to "STDERR". One of the steps when starting up is
 195        to fork to the background and closing "STDERR" - after this writing
 196        directly to the user is no longer possible. Once this has happened, the
 197        daemon will send log messages to the system logging daemon using
 198        _\bs_\by_\bs_\bl_\bo_\bg(3). The facility used is "LOG_DAEMON".
 199
 200 H\bHO\bOW\bW I\bIT\bT W\bWO\bOR\bRK\bKS\bS
 201        When receiving an update, r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd does not write to disk but looks
 202        for an entry for that file in its internal tree. If not found, an entry
 203        is created including the current time (called "First" in the diagram
 204        below). This time is n\bno\bot\bt the time specified on the command line but the
 205        time the operating system considers to be "now". The value and time of
 206        the value (called "Time" in the diagram below) are appended to the tree
 207        node.
 208
 209        When appending a value to a tree node, it is checked whether it's time
 210        to write the values to disk. Values are written to disk if
 211        "now() - First >= timeout", where "timeout" is the timeout specified
 212        using the -\b-w\bw option, see OPTIONS. If the values are "old enough" they
 213        will be enqueued in the "update queue", i. e. they will be appended to
 214        the linked list shown below.  Because the tree nodes and the elements
 215        of the linked list are the same data structures in memory, any update
 216        to a file that has already been enqueued will be written with the next
 217        write to the RRD file, too.
 218
 219        A separate "update thread" constantly dequeues the first element in the
 220        update queue and writes all its values to the appropriate file. So as
 221        long as the update queue is not empty files are written at the highest
 222        possible rate.
 223
 224        Since the timeout of files is checked only when new values are added to
 225        the file, "dead" files, i. e. files that are not updated anymore, would
 226        never be written to disk. Therefore, every now and then, controlled by
 227        the -\b-f\bf option, the entire tree is walked and all "old" values are
 228        enqueued. Since this only affects "dead" files and walking the tree is
 229        relatively expensive, you should set the "flush interval" to a
 230        reasonably high value. The default is 3600 seconds (one hour).
 231
 232        The downside of caching values is that they won't show up in graphs
 233        generated from the RRD files. To get around this, the daemon provides
 234        the "flush command" to flush specific files. This means that the file
 235        is inserted at the h\bhe\bea\bad\bd of the update queue or moved there if it is
 236        already enqueued. The flush command will return only after the file's
 237        pending updates have been written to disk.
 238
 239         +------+   +------+                               +------+
 240         ! head !   ! root !                               ! tail !
 241         +---+--+   +---+--+                               +---+--+
 242             !         /\                                      !
 243             !        /  \                                     !
 244             !       /\  /\                                    !
 245             !      /\/\ \ `----------------- ... --------,    !
 246             V     /      `-------,                       !    V
 247         +---+----+---+    +------+-----+             +---+----+---+
 248         ! File:  foo !    ! File:  bar !             ! File:  qux !
 249         ! First: 101 !    ! First: 119 !             ! First: 180 !
 250         ! Next:&bar -+--->! Next:&... -+---> ... --->! Next:NULL  !
 251         | Prev:NULL  !<---+-Prev:&foo  !<--- ... ----+-Prev: &... !
 252         +============+    +============+             +============+
 253         ! Time:  100 !    ! Time:  120 !             ! Time:  180 !
 254         ! Value:  10 !    ! Value: 0.1 !             ! Value: 2,2 !
 255         +------------+    +------------+             +------------+
 256         ! Time:  110 !    ! Time:  130 !             ! Time:  190 !
 257         ! Value:  26 !    ! Value: 0.1 !             ! Value: 7,3 !
 258         +------------+    +------------+             +------------+
 259         :            :    :            :             :            :
 260         +------------+    +------------+             +------------+
 261         ! Time:  230 !    ! Time:  250 !             ! Time:  310 !
 262         ! Value:  42 !    ! Value: 0.2 !             ! Value: 1,2 !
 263         +------------+    +------------+             +------------+
 264
 265        The above diagram demonstrates:
 266
 267        ·   Files/values are stored in a (balanced) tree.
 268
 269        ·   Tree nodes and entries in the update queue are the same data
 270            structure.
 271
 272        ·   The local time ("First") and the time specified in updates ("Time")
 273            may differ.
 274
 275        ·   Timed out values are inserted at the "tail".
 276
 277        ·   Explicitly flushed values are inserted at the "head".
 278
 279        ·   ASCII art rocks.
 280
 281 S\bSE\bEC\bCU\bUR\bRI\bIT\bTY\bY C\bCO\bON\bNS\bSI\bID\bDE\bER\bRA\bAT\bTI\bIO\bON\bNS\bS
 282    A\bAu\but\bth\bhe\ben\bnt\bti\bic\bca\bat\bti\bio\bon\bn
 283        There is no authentication.
 284
 285        The client/server protocol does not yet have any authentication
 286        mechanism. It is likely that authentication and encryption will be
 287        added in a future version, but for the time being it is the
 288        administrator's responsibility to secure the traffic from/to the
 289        daemon!
 290
 291        It is highly recommended to install a packet filter or similar
 292        mechanism to prevent unauthorized connections. Unless you have a
 293        dedicated VLAN or VPN for this, using network sockets is probably a bad
 294        idea!
 295
 296    A\bAu\but\bth\bho\bor\bri\biz\bza\bat\bti\bio\bon\bn
 297        There is minimal per-socket authorization.
 298
 299        Authorization is currently done on a per-socket basis. That means each
 300        socket has a list of commands it will accept and it will accept. It
 301        will accept only those commands explicitly listed but it will
 302        (currently) accept these commands from anyone reaching the socket.
 303
 304        If the networking sockets are to be used, it is necessary to restrict
 305        the accepted commands to those needed by external clients. If, for
 306        example, external clients want to draw graphs of the cached data, they
 307        should only be allowed to use the "FLUSH" command.
 308
 309    E\bEn\bnc\bcr\bry\byp\bpt\bti\bio\bon\bn
 310        There is no encryption.
 311
 312        Again, this may be added in the future, but for the time being it is
 313        your job to keep your private data private. Install a VPN or an
 314        encrypted tunnel if you statistics are confidential!
 315
 316    S\bSa\ban\bni\bit\bty\by c\bch\bhe\bec\bck\bki\bin\bng\bg
 317        There is no sanity checking.
 318
 319        The daemon will blindly write to any file it gets told, so you really
 320        should create a separate user just for this daemon. Also it does not do
 321        any sanity checks, so if it gets told to write values for a time far in
 322        the future, your files will be messed up good!
 323
 324    C\bCo\bon\bnc\bcl\blu\bus\bsi\bio\bon\bn
 325        ·   Security is the job of the administrator.
 326
 327        ·   We recommend to allow write access via UNIX domain sockets only.
 328
 329        ·   You have been warned.
 330
 331 P\bPR\bRO\bOT\bTO\bOC\bCO\bOL\bL
 332        The daemon communicates with clients using a line based ASCII protocol
 333        which is easy to read and easy to type. This makes it easy for scripts
 334        to implement the protocol and possible for users to use telnet to
 335        connect to the daemon and test stuff "by hand".
 336
 337        The protocol is line based, this means that each record consists of one
 338        or more lines. A line is terminated by the line feed character 0x0A,
 339        commonly written as "\n". In the examples below, this character will be
 340        written as "<LF>" ("line feed").
 341
 342        After the connection has been established, the client is expected to
 343        send a "command". A command consists of the command keyword, possibly
 344        some arguments, and a terminating newline character. For a list of
 345        commands, see "Valid Commands" below.
 346
 347        Example:
 348
 349          FLUSH /tmp/foo.rrd<LF>
 350
 351        The daemon answers with a line consisting of a status code and a short
 352        status message, separated by one or more space characters. A negative
 353        status code signals an error, a positive status code or zero signal
 354        success. If the status code is greater than zero, it indicates the
 355        number of lines that follow the status line.
 356
 357        Examples:
 358
 359         0 Success<LF>
 360
 361         2 Two lines follow<LF>
 362         This is the first line<LF>
 363         And this is the second line<LF>
 364
 365    V\bVa\bal\bli\bid\bd C\bCo\bom\bmm\bma\ban\bnd\bds\bs
 366        The following commands are understood by the daemon:
 367
 368        F\bFL\bLU\bUS\bSH\bH _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
 369            Causes the daemon to put _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be to the h\bhe\bea\bad\bd of the update queue
 370            (possibly moving it there if the node is already enqueued). The
 371            answer will be sent a\baf\bft\bte\ber\br the node has been dequeued.
 372
 373        F\bFL\bLU\bUS\bSH\bHA\bAL\bLL\bL
 374            Causes the daemon to start flushing ALL pending values to disk.
 375            This returns immediately, even though the writes may take a long
 376            time.
 377
 378        P\bPE\bEN\bND\bDI\bIN\bNG\bG _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
 379            Shows any "pending" updates for a file, in order.  The updates
 380            shown have not yet been written to the underlying RRD file.
 381
 382        F\bFO\bOR\bRG\bGE\bET\bT _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
 383            Removes _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be from the cache.  Any pending updates W\bWI\bIL\bLL\bL B\bBE\bE L\bLO\bOS\bST\bT.
 384
 385        Q\bQU\bUE\bEU\bUE\bE
 386            Shows the files that are on the output queue.  Returns zero or more
 387            lines in the following format, where <num_vals> is the number of
 388            values to be written for the <file>:
 389
 390                <num_vals> <file>
 391
 392        H\bHE\bEL\bLP\bP [_\bc_\bo_\bm_\bm_\ba_\bn_\bd]
 393            Returns a short usage message. If no command is given, or _\bc_\bo_\bm_\bm_\ba_\bn_\bd
 394            is H\bHE\bEL\bLP\bP, a list of commands supported by the daemon is returned.
 395            Otherwise a short description, possibly containing a pointer to a
 396            manual page, is returned.  Obviously, this is meant for interactive
 397            usage and the format in which the commands and usage summaries are
 398            returned is not well defined.
 399
 400        S\bST\bTA\bAT\bTS\bS
 401            Returns a list of metrics which can be used to measure the daemons
 402            performance and check its status. For a description of the values
 403            returned, see "Performance Values" below.
 404
 405            The format in which the values are returned is similar to many
 406            other line based protocols: Each value is printed on a separate
 407            line, each consisting of the name of the value, a colon, one or
 408            more spaces and the actual value.
 409
 410            Example:
 411
 412             9 Statistics follow
 413             QueueLength: 0
 414             UpdatesReceived: 30
 415             FlushesReceived: 2
 416             UpdatesWritten: 13
 417             DataSetsWritten: 390
 418             TreeNodesNumber: 13
 419             TreeDepth: 4
 420             JournalBytes: 190
 421             JournalRotate: 0
 422
 423        U\bUP\bPD\bDA\bAT\bTE\bE _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be _\bv_\ba_\bl_\bu_\be_\bs [_\bv_\ba_\bl_\bu_\be_\bs ...]
 424            Adds more data to a filename. This is t\bth\bhe\be operation the daemon was
 425            designed for, so describing the mechanism again is unnecessary.
 426            Read "HOW IT WORKS" above for a detailed explanation.
 427
 428            Note that rrdcached only accepts absolute timestamps in the update
 429            values.  Updates strings like "N:1:2:3" are automatically converted
 430            to absolute time by the RRD client library before sending to
 431            rrdcached.
 432
 433        W\bWR\bRO\bOT\bTE\bE _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
 434            This command is written to the journal after a file is successfully
 435            written out to disk.  It is used during journal replay to determine
 436            which updates have already been applied.  It is _\bo_\bn_\bl_\by valid in the
 437            journal; it is not accepted from the other command channels.
 438
 439        B\bBA\bAT\bTC\bCH\bH
 440            This command initiates the bulk load of multiple commands.  This is
 441            designed for installations with extremely high update rates, since
 442            it permits more than one command to be issued per _\br_\be_\ba_\bd_\b(_\b) and
 443            _\bw_\br_\bi_\bt_\be_\b(_\b).
 444
 445            All commands are executed just as they would be if given
 446            individually, except for output to the user.  Messages indicating
 447            success are suppressed, and error messages are delayed until the
 448            client is finished.
 449
 450            Command processing is finished when the client sends a dot (".") on
 451            its own line.  After the client has finished, the server responds
 452            with an error count and the list of error messages (if any).  Each
 453            error messages indicates the number of the command to which it
 454            corresponds, and the error message itself.  The first user command
 455            after B\bBA\bAT\bTC\bCH\bH is command number one.
 456
 457                client:  BATCH
 458                server:  0 Go ahead.  End with dot '.' on its own line.
 459                client:  UPDATE x.rrd 1223661439:1:2:3            <--- command #1
 460                client:  UPDATE y.rrd 1223661440:3:4:5            <--- command #2
 461                client:  and so on...
 462                client:  .
 463                server:  2 Errors
 464                server:  1 message for command 1
 465                server:  12 message for command 12
 466
 467        Q\bQU\bUI\bIT\bT
 468            Disconnect from rrdcached.
 469
 470    P\bPe\ber\brf\bfo\bor\brm\bma\ban\bnc\bce\be V\bVa\bal\blu\bue\bes\bs
 471        The following counters are returned by the S\bST\bTA\bAT\bTS\bS command:
 472
 473        Q\bQu\bue\beu\bue\beL\bLe\ben\bng\bgt\bth\bh _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 474            Number of nodes currently enqueued in the update queue.
 475
 476        U\bUp\bpd\bda\bat\bte\bes\bsR\bRe\bec\bce\bei\biv\bve\bed\bd _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 477            Number of UPDATE commands received.
 478
 479        F\bFl\blu\bus\bsh\bhe\bes\bsR\bRe\bec\bce\bei\biv\bve\bed\bd _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 480            Number of FLUSH commands received.
 481
 482        U\bUp\bpd\bda\bat\bte\bes\bsW\bWr\bri\bit\btt\bte\ben\bn _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 483            Total number of updates, i. e. calls to "rrd_update_r", since the
 484            daemon was started.
 485
 486        D\bDa\bat\bta\baS\bSe\bet\bts\bsW\bWr\bri\bit\btt\bte\ben\bn _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 487            Total number of "data sets" written to disk since the daemon was
 488            started. A data set is one or more values passed to the U\bUP\bPD\bDA\bAT\bTE\bE
 489            command. For example: "1223661439:123:456" is one data set with two
 490            values. The term "data set" is used to prevent confusion whether
 491            individual values or groups of values are counted.
 492
 493        T\bTr\bre\bee\beN\bNo\bod\bde\bes\bsN\bNu\bum\bmb\bbe\ber\br _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 494            Number of nodes in the cache.
 495
 496        T\bTr\bre\bee\beD\bDe\bep\bpt\bth\bh _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 497            Depth of the tree used for fast key lookup.
 498
 499        J\bJo\bou\bur\brn\bna\bal\blB\bBy\byt\bte\bes\bs _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 500            Total number of bytes written to the journal since startup.
 501
 502        J\bJo\bou\bur\brn\bna\bal\blR\bRo\bot\bta\bat\bte\be _\b(_\bu_\bn_\bs_\bi_\bg_\bn_\be_\bd _\b6_\b4_\bb_\bi_\bt _\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 503            Number of times the journal has been rotated since startup.
 504
 505 S\bSI\bIG\bGN\bNA\bAL\bLS\bS
 506        SIGINT and SIGTERM
 507            The daemon exits normally on receipt of either of these signals.
 508            Pending updates are handled in accordance with the -\b-j\bj and -\b-F\bF
 509            options.
 510
 511        SIGUSR1
 512            The daemon exits AFTER flushing all updates out to disk.  This may
 513            take a while.
 514
 515        SIGUSR2
 516            The daemon exits immediately, without flushing updates out to disk.
 517            Pending updates will be replayed from the journal when the daemon
 518            starts up again.  W\bWA\bAR\bRN\bNI\bIN\bNG\bG:\b: i\bif\bf j\bjo\bou\bur\brn\bna\bal\bli\bin\bng\bg (\b(-\b-j\bj)\b) i\bis\bs N\bNO\bOT\bT e\ben\bna\bab\bbl\ble\bed\bd,\b, a\ban\bny\by
 519            p\bpe\ben\bnd\bdi\bin\bng\bg u\bup\bpd\bda\bat\bte\bes\bs W\bWI\bIL\bLL\bL B\bBE\bE L\bLO\bOS\bST\bT.
 520
 521 B\bBU\bUG\bGS\bS
 522        No known bugs at the moment.
 523
 524 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 525        rrdtool, rrdgraph
 526
 527 A\bAU\bUT\bTH\bHO\bOR\bR
 528        r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd and this manual page have been written by Florian Forster
 529        <octo at verplant.org>.
 530
 531 C\bCO\bON\bNT\bTR\bRI\bIB\bBU\bUT\bTO\bOR\bRS\bS
 532        kevin brintnall <kbrint@rufus.net>
 533
 534
 535
 536 1.3.999                           2009-09-24                      RRDCACHED(1)