Code

Imported upstream version 1.4.3.
[pkg-rrdtool.git] / doc / rrdcached.txt
1 RRDCACHED(1)                        rrdtool                       RRDCACHED(1)
5 N\bNA\bAM\bME\bE
6        rrdcached - Data caching daemon for rrdtool
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-s\bs _\bg_\br_\bo_\bu_\bp] [-\b-w\bw _\bt_\bi_\bm_\be_\bo_\bu_\bt]
10        [-\b-z\bz _\bd_\be_\bl_\ba_\by] [-\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]
11        [-\b-j\bj _\bj_\bo_\bu_\br_\bn_\ba_\bl_\b__\bd_\bi_\br] [-F] [-g] [-\b-b\bb _\bb_\ba_\bs_\be_\b__\bd_\bi_\br [-\b-B\bB]]
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.
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.
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()".
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.
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!
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>
52            If the -\b-l\bl option is not specified the default address,
53            "unix:/tmp/rrdcached.sock", will be used.
55        -\b-s\bs _\bg_\br_\bo_\bu_\bp_\b__\bn_\ba_\bm_\be|_\bg_\bi_\bd
56            Set the group permissions of a UNIX domain socket. The option
57            accepts either a numeric group id or group name. That group will
58            then have both read and write permissions (the socket will have
59            file permissions 0750) for the socket and, therefore, is able to
60            send commands to the daemon. This may be useful in cases where you
61            cannot easily run all RRD processes with the same user privileges
62            (e.g. graph generating CGI scripts that typically run in the
63            permission context of the web server).
65            This option affects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg UNIX socket addresses (the
66            following -\b-l\bl options), i.e., you may specify different settings for
67            different sockets.
69            The default is not to change ownership or permissions of the socket
70            and, thus, use the system default.
72        -\b-m\bm _\bm_\bo_\bd_\be
73            Set the file permissions of a UNIX domain socket. The option
74            accepts an octal number representing the bit pattern for the mode
75            (see _\bc_\bh_\bm_\bo_\bd(1) for details).
77            Please note that not all systems honor this setting. On Linux,
78            read/write permissions are required to connect to a UNIX socket.
79            However, many BSD-derived systems ignore permissions for UNIX
80            sockets. See _\bu_\bn_\bi_\bx(7) for details.
82            This option affects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg UNIX socket addresses (the
83            following -\b-l\bl options), i.e., you may specify different settings for
84            different sockets.
86            The default is not to change ownership or permissions of the socket
87            and, thus, use the system default.
89        -\b-P\bP _\bc_\bo_\bm_\bm_\ba_\bn_\bd[,_\bc_\bo_\bm_\bm_\ba_\bn_\bd[,...]]
90            Specifies the commands accepted via a network socket. This allows
91            administrators of _\bR_\bR_\bD_\bC_\ba_\bc_\bh_\be_\bD to control the actions accepted from
92            various sources.
94            The arguments given to the -\b-P\bP option is a comma separated list of
95            commands.  For example, to allow the "FLUSH" and "PENDING" commands
96            one could specify:
98              rrdcached -P FLUSH,PENDING $MORE_ARGUMENTS
100            The -\b-P\bP option affects the _\bf_\bo_\bl_\bl_\bo_\bw_\bi_\bn_\bg socket addresses (the following
101            -\b-l\bl options). In the following example, only the IPv4 network socket
102            (address 10.0.0.1) will be restricted to the "FLUSH" and "PENDING"
103            commands:
105              rrdcached -l unix:/some/path -P FLUSH,PENDING -l 10.0.0.1
107            A complete list of available commands can be found in the section
108            "Valid Commands" below. There are two minor special exceptions:
110            ·   The "HELP" and "QUIT" commands are always allowed.
112            ·   If the "BATCH" command is accepted, the .\b. command will
113                automatically be accepted, too.
115            Please also read "SECURITY CONSIDERATIONS" below.
117        -\b-w\bw _\bt_\bi_\bm_\be_\bo_\bu_\bt
118            Data is written to disk every _\bt_\bi_\bm_\be_\bo_\bu_\bt seconds. If this option is
119            not specified the default interval of 300 seconds will be used.
121        -\b-z\bz _\bd_\be_\bl_\ba_\by
122            If specified, rrdcached will delay writing of each RRD for a random
123            number of seconds in the range [0,_\bd_\be_\bl_\ba_\by).  This will avoid too many
124            writes being queued simultaneously.  This value should be no
125            greater than the value specified in -\b-w\bw.  By default, there is no
126            delay.
128        -\b-f\bf _\bt_\bi_\bm_\be_\bo_\bu_\bt
129            Every _\bt_\bi_\bm_\be_\bo_\bu_\bt seconds the entire cache is searched for old values
130            which are written to disk. This only concerns files to which
131            updates have stopped, so setting this to a high value, such as
132            3600 seconds, is acceptable in most cases. This timeout defaults to
133            3600 seconds.
135        -\b-p\bp _\bf_\bi_\bl_\be
136            Sets the name and location of the PID-file. If not specified, the
137            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.
139        -\b-t\bt _\bw_\br_\bi_\bt_\be_\b__\bt_\bh_\br_\be_\ba_\bd_\bs
140            Specifies the number of threads used for writing RRD files.  The
141            default is 4.  Increasing this number will allow rrdcached to have
142            more simultaneous I/O requests into the kernel.  This may allow the
143            kernel to re-order disk writes, resulting in better disk
144            throughput.
146        -\b-j\bj _\bd_\bi_\br
147            Write updates to a journal in _\bd_\bi_\br.  In the event of a program or
148            system crash, this will allow the daemon to write any updates that
149            were pending at the time of the crash.
151            On startup, the daemon will check for journal files in this
152            directory.  If found, all updates therein will be read into memory
153            before the daemon starts accepting new connections.
155            The journal will be rotated with the same frequency as the flush
156            timer given by -\b-f\bf.
158            When journaling is enabled, the daemon will use a fast shutdown
159            procedure.  Rather than flushing all files to disk, it will make
160            sure the journal is properly written and exit immediately.
161            Although the RRD data files are not fully up-to-date, no
162            information is lost; all pending updates will be replayed from the
163            journal next time the daemon starts up.
165            To disable fast shutdown, use the -\b-F\bF option.
167        -\b-F\bF  ALWAYS flush all updates to the RRD data files when the daemon is
168            shut down, regardless of journal setting.
170        -\b-g\bg  Run in the foreground.  The daemon will not _\bf_\bo_\br_\bk_\b(_\b).
172        -\b-b\bb _\bd_\bi_\br
173            The daemon will change into a specific directory at startup. All
174            files passed to the daemon, that are specified by a r\bre\bel\bla\bat\bti\biv\bve\be path,
175            will be interpreted to be relative to this directory. If not given
176            the default, "/tmp", will be used.
178              +------------------------+------------------------+
179              ! Command line           ! File updated           !
180              +------------------------+------------------------+
181              ! foo.rrd                ! /tmp/foo.rrd           !
182              ! foo/bar.rrd            ! /tmp/foo/bar.rrd       !
183              ! /var/lib/rrd/foo.rrd   ! /var/lib/rrd/foo.rrd   !
184              +------------------------+------------------------+
185              Paths given on the command  line and paths actually
186              updated by the daemon,  assuming the base directory
187              "/tmp".
189            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
190            B\bBE\bE symbolic links.  In other words, if the base directory is
191            specified as:
193                -b /base/dir/somewhere
195            ... then N\bNO\bON\bNE\bE of the following should be symbolic links:
197                /base
198                /base/dir
199                /base/dir/somewhere
201        -\b-B\bB  Only permit writes into the base directory specified in -\b-b\bb (and any
202            sub-directories).  This does N\bNO\bOT\bT detect symbolic links.  Paths
203            containing "../" will also be blocked.
205 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
206        The following commands may be made aware of the r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd using the
207        command line argument -\b--\b-d\bda\bae\bem\bmo\bon\bn or the environment variable
208        R\bRR\bRD\bDC\bCA\bAC\bCH\bHE\bED\bD_\b_A\bAD\bDD\bDR\bRE\bES\bSS\bS:
210        ·   dump
212        ·   fetch
214        ·   flush
216        ·   graph
218        ·   graphv
220        ·   info
222        ·   last
224        ·   lastupdate
226        ·   update
228        ·   xport
230        The u\bup\bpd\bda\bat\bte\be command can send values to the daemon instead of writing
231        them to the disk itself. All other commands can send a F\bFL\bLU\bUS\bSH\bH command
232        (see below) to the daemon before accessing the files, so they work with
233        up-to-date data even if the cache timeout is large.
235 E\bER\bRR\bRO\bOR\bR R\bRE\bEP\bPO\bOR\bRT\bTI\bIN\bNG\bG
236        The daemon reports errors in one of two ways: During startup, error
237        messages are printed to "STDERR". One of the steps when starting up is
238        to fork to the background and closing "STDERR" - after this writing
239        directly to the user is no longer possible. Once this has happened, the
240        daemon will send log messages to the system logging daemon using
241        _\bs_\by_\bs_\bl_\bo_\bg(3). The facility used is "LOG_DAEMON".
243 H\bHO\bOW\bW I\bIT\bT W\bWO\bOR\bRK\bKS\bS
244        When receiving an update, r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd does not write to disk but looks
245        for an entry for that file in its internal tree. If not found, an entry
246        is created including the current time (called "First" in the diagram
247        below). This time is n\bno\bot\bt the time specified on the command line but the
248        time the operating system considers to be "now". The value and time of
249        the value (called "Time" in the diagram below) are appended to the tree
250        node.
252        When appending a value to a tree node, it is checked whether it's time
253        to write the values to disk. Values are written to disk if
254        "now() - First >= timeout", where "timeout" is the timeout specified
255        using the -\b-w\bw option, see "OPTIONS". If the values are "old enough" they
256        will be enqueued in the "update queue", i. e. they will be appended to
257        the linked list shown below.  Because the tree nodes and the elements
258        of the linked list are the same data structures in memory, any update
259        to a file that has already been enqueued will be written with the next
260        write to the RRD file, too.
262        A separate "update thread" constantly dequeues the first element in the
263        update queue and writes all its values to the appropriate file. So as
264        long as the update queue is not empty files are written at the highest
265        possible rate.
267        Since the timeout of files is checked only when new values are added to
268        the file, "dead" files, i. e. files that are not updated anymore, would
269        never be written to disk. Therefore, every now and then, controlled by
270        the -\b-f\bf option, the entire tree is walked and all "old" values are
271        enqueued. Since this only affects "dead" files and walking the tree is
272        relatively expensive, you should set the "flush interval" to a
273        reasonably high value. The default is 3600 seconds (one hour).
275        The downside of caching values is that they won't show up in graphs
276        generated from the RRD files. To get around this, the daemon provides
277        the "flush command" to flush specific files. This means that the file
278        is inserted at the h\bhe\bea\bad\bd of the update queue or moved there if it is
279        already enqueued. The flush command will return only after the file's
280        pending updates have been written to disk.
282         +------+   +------+                               +------+
283         ! head !   ! root !                               ! tail !
284         +---+--+   +---+--+                               +---+--+
285             !         /\                                      !
286             !        /  \                                     !
287             !       /\  /\                                    !
288             !      /\/\ \ `----------------- ... --------,    !
289             V     /      `-------,                       !    V
290         +---+----+---+    +------+-----+             +---+----+---+
291         ! File:  foo !    ! File:  bar !             ! File:  qux !
292         ! First: 101 !    ! First: 119 !             ! First: 180 !
293         ! Next:&bar -+--->! Next:&... -+---> ... --->! Next:NULL  !
294         | Prev:NULL  !<---+-Prev:&foo  !<--- ... ----+-Prev: &... !
295         +============+    +============+             +============+
296         ! Time:  100 !    ! Time:  120 !             ! Time:  180 !
297         ! Value:  10 !    ! Value: 0.1 !             ! Value: 2,2 !
298         +------------+    +------------+             +------------+
299         ! Time:  110 !    ! Time:  130 !             ! Time:  190 !
300         ! Value:  26 !    ! Value: 0.1 !             ! Value: 7,3 !
301         +------------+    +------------+             +------------+
302         :            :    :            :             :            :
303         +------------+    +------------+             +------------+
304         ! Time:  230 !    ! Time:  250 !             ! Time:  310 !
305         ! Value:  42 !    ! Value: 0.2 !             ! Value: 1,2 !
306         +------------+    +------------+             +------------+
308        The above diagram demonstrates:
310        ·   Files/values are stored in a (balanced) tree.
312        ·   Tree nodes and entries in the update queue are the same data
313            structure.
315        ·   The local time ("First") and the time specified in updates ("Time")
316            may differ.
318        ·   Timed out values are inserted at the "tail".
320        ·   Explicitly flushed values are inserted at the "head".
322        ·   ASCII art rocks.
324 S\bSE\bEC\bCU\bUR\bRI\bIT\bTY\bY C\bCO\bON\bNS\bSI\bID\bDE\bER\bRA\bAT\bTI\bIO\bON\bNS\bS
325    A\bAu\but\bth\bhe\ben\bnt\bti\bic\bca\bat\bti\bio\bon\bn
326        There is no authentication.
328        The client/server protocol does not yet have any authentication
329        mechanism. It is likely that authentication and encryption will be
330        added in a future version, but for the time being it is the
331        administrator's responsibility to secure the traffic from/to the
332        daemon!
334        It is highly recommended to install a packet filter or similar
335        mechanism to prevent unauthorized connections. Unless you have a
336        dedicated VLAN or VPN for this, using network sockets is probably a bad
337        idea!
339    A\bAu\but\bth\bho\bor\bri\biz\bza\bat\bti\bio\bon\bn
340        There is minimal per-socket authorization.
342        Authorization is currently done on a per-socket basis. That means each
343        socket has a list of commands it will accept and it will accept. It
344        will accept only those commands explicitly listed but it will
345        (currently) accept these commands from anyone reaching the socket.
347        If the networking sockets are to be used, it is necessary to restrict
348        the accepted commands to those needed by external clients. If, for
349        example, external clients want to draw graphs of the cached data, they
350        should only be allowed to use the "FLUSH" command.
352    E\bEn\bnc\bcr\bry\byp\bpt\bti\bio\bon\bn
353        There is no encryption.
355        Again, this may be added in the future, but for the time being it is
356        your job to keep your private data private. Install a VPN or an
357        encrypted tunnel if you statistics are confidential!
359    S\bSa\ban\bni\bit\bty\by c\bch\bhe\bec\bck\bki\bin\bng\bg
360        There is no sanity checking.
362        The daemon will blindly write to any file it gets told, so you really
363        should create a separate user just for this daemon. Also it does not do
364        any sanity checks, so if it gets told to write values for a time far in
365        the future, your files will be messed up good!
367    C\bCo\bon\bnc\bcl\blu\bus\bsi\bio\bon\bn
368        ·   Security is the job of the administrator.
370        ·   We recommend to allow write access via UNIX domain sockets only.
372        ·   You have been warned.
374 P\bPR\bRO\bOT\bTO\bOC\bCO\bOL\bL
375        The daemon communicates with clients using a line based ASCII protocol
376        which is easy to read and easy to type. This makes it easy for scripts
377        to implement the protocol and possible for users to use telnet to
378        connect to the daemon and test stuff "by hand".
380        The protocol is line based, this means that each record consists of one
381        or more lines. A line is terminated by the line feed character 0x0A,
382        commonly written as "\n". In the examples below, this character will be
383        written as "<LF>" ("line feed").
385        After the connection has been established, the client is expected to
386        send a "command". A command consists of the command keyword, possibly
387        some arguments, and a terminating newline character. For a list of
388        commands, see "Valid Commands" below.
390        Example:
392          FLUSH /tmp/foo.rrd<LF>
394        The daemon answers with a line consisting of a status code and a short
395        status message, separated by one or more space characters. A negative
396        status code signals an error, a positive status code or zero signal
397        success. If the status code is greater than zero, it indicates the
398        number of lines that follow the status line.
400        Examples:
402         0 Success<LF>
404         2 Two lines follow<LF>
405         This is the first line<LF>
406         And this is the second line<LF>
408    V\bVa\bal\bli\bid\bd C\bCo\bom\bmm\bma\ban\bnd\bds\bs
409        The following commands are understood by the daemon:
411        F\bFL\bLU\bUS\bSH\bH _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
412            Causes the daemon to put _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be to the h\bhe\bea\bad\bd of the update queue
413            (possibly moving it there if the node is already enqueued). The
414            answer will be sent a\baf\bft\bte\ber\br the node has been dequeued.
416        F\bFL\bLU\bUS\bSH\bHA\bAL\bLL\bL
417            Causes the daemon to start flushing ALL pending values to disk.
418            This returns immediately, even though the writes may take a long
419            time.
421        P\bPE\bEN\bND\bDI\bIN\bNG\bG _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
422            Shows any "pending" updates for a file, in order.  The updates
423            shown have not yet been written to the underlying RRD file.
425        F\bFO\bOR\bRG\bGE\bET\bT _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
426            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.
428        Q\bQU\bUE\bEU\bUE\bE
429            Shows the files that are on the output queue.  Returns zero or more
430            lines in the following format, where <num_vals> is the number of
431            values to be written for the <file>:
433                <num_vals> <file>
435        H\bHE\bEL\bLP\bP [_\bc_\bo_\bm_\bm_\ba_\bn_\bd]
436            Returns a short usage message. If no command is given, or _\bc_\bo_\bm_\bm_\ba_\bn_\bd
437            is H\bHE\bEL\bLP\bP, a list of commands supported by the daemon is returned.
438            Otherwise a short description, possibly containing a pointer to a
439            manual page, is returned.  Obviously, this is meant for interactive
440            usage and the format in which the commands and usage summaries are
441            returned is not well defined.
443        S\bST\bTA\bAT\bTS\bS
444            Returns a list of metrics which can be used to measure the daemons
445            performance and check its status. For a description of the values
446            returned, see "Performance Values" below.
448            The format in which the values are returned is similar to many
449            other line based protocols: Each value is printed on a separate
450            line, each consisting of the name of the value, a colon, one or
451            more spaces and the actual value.
453            Example:
455             9 Statistics follow
456             QueueLength: 0
457             UpdatesReceived: 30
458             FlushesReceived: 2
459             UpdatesWritten: 13
460             DataSetsWritten: 390
461             TreeNodesNumber: 13
462             TreeDepth: 4
463             JournalBytes: 190
464             JournalRotate: 0
466        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 ...]
467            Adds more data to a filename. This is t\bth\bhe\be operation the daemon was
468            designed for, so describing the mechanism again is unnecessary.
469            Read "HOW IT WORKS" above for a detailed explanation.
471            Note that rrdcached only accepts absolute timestamps in the update
472            values.  Updates strings like "N:1:2:3" are automatically converted
473            to absolute time by the RRD client library before sending to
474            rrdcached.
476        W\bWR\bRO\bOT\bTE\bE _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
477            This command is written to the journal after a file is successfully
478            written out to disk.  It is used during journal replay to determine
479            which updates have already been applied.  It is _\bo_\bn_\bl_\by valid in the
480            journal; it is not accepted from the other command channels.
482        B\bBA\bAT\bTC\bCH\bH
483            This command initiates the bulk load of multiple commands.  This is
484            designed for installations with extremely high update rates, since
485            it permits more than one command to be issued per _\br_\be_\ba_\bd_\b(_\b) and
486            _\bw_\br_\bi_\bt_\be_\b(_\b).
488            All commands are executed just as they would be if given
489            individually, except for output to the user.  Messages indicating
490            success are suppressed, and error messages are delayed until the
491            client is finished.
493            Command processing is finished when the client sends a dot (".") on
494            its own line.  After the client has finished, the server responds
495            with an error count and the list of error messages (if any).  Each
496            error messages indicates the number of the command to which it
497            corresponds, and the error message itself.  The first user command
498            after B\bBA\bAT\bTC\bCH\bH is command number one.
500                client:  BATCH
501                server:  0 Go ahead.  End with dot '.' on its own line.
502                client:  UPDATE x.rrd 1223661439:1:2:3            <--- command #1
503                client:  UPDATE y.rrd 1223661440:3:4:5            <--- command #2
504                client:  and so on...
505                client:  .
506                server:  2 Errors
507                server:  1 message for command 1
508                server:  12 message for command 12
510        Q\bQU\bUI\bIT\bT
511            Disconnect from rrdcached.
513    P\bPe\ber\brf\bfo\bor\brm\bma\ban\bnc\bce\be V\bVa\bal\blu\bue\bes\bs
514        The following counters are returned by the S\bST\bTA\bAT\bTS\bS command:
516        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)
517            Number of nodes currently enqueued in the update queue.
519        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)
520            Number of UPDATE commands received.
522        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)
523            Number of FLUSH commands received.
525        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)
526            Total number of updates, i. e. calls to "rrd_update_r", since the
527            daemon was started.
529        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)
530            Total number of "data sets" written to disk since the daemon was
531            started. A data set is one or more values passed to the U\bUP\bPD\bDA\bAT\bTE\bE
532            command. For example: "1223661439:123:456" is one data set with two
533            values. The term "data set" is used to prevent confusion whether
534            individual values or groups of values are counted.
536        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)
537            Number of nodes in the cache.
539        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)
540            Depth of the tree used for fast key lookup.
542        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)
543            Total number of bytes written to the journal since startup.
545        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)
546            Number of times the journal has been rotated since startup.
548 S\bSI\bIG\bGN\bNA\bAL\bLS\bS
549        SIGINT and SIGTERM
550            The daemon exits normally on receipt of either of these signals.
551            Pending updates are handled in accordance with the -\b-j\bj and -\b-F\bF
552            options.
554        SIGUSR1
555            The daemon exits AFTER flushing all updates out to disk.  This may
556            take a while.
558        SIGUSR2
559            The daemon exits immediately, without flushing updates out to disk.
560            Pending updates will be replayed from the journal when the daemon
561            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
562            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.
564 B\bBU\bUG\bGS\bS
565        No known bugs at the moment.
567 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
568        rrdtool, rrdgraph
570 A\bAU\bUT\bTH\bHO\bOR\bR
571        Florian Forster <octo at verplant.org>
573        Both r\brr\brd\bdc\bca\bac\bch\bhe\bed\bd and this manual page have been written by Florian.
575 C\bCO\bON\bNT\bTR\bRI\bIB\bBU\bUT\bTO\bOR\bRS\bS
576        kevin brintnall <kbrint@rufus.net>
580 1.4.3                             2010-03-22                      RRDCACHED(1)