This patch introduces "fast shutdown" mode and two new signals.

[rrdtool.git] / doc / rrdcached.pod
diff --git a/doc/rrdcached.pod b/doc/rrdcached.pod

index 0f34dc2..8ed2979 100644 (file)
--- a/doc/rrdcached.pod
+++ b/doc/rrdcached.pod
@@ -6,7 +6,7 @@ rrdcached - Data caching daemon for rrdtool
  
  =head1 SYNOPSIS
  
  
  =head1 SYNOPSIS
  
-B<rrdcached> [B<-l> I<address>] [B<-w> I<timeout>] [B<-z> I<delay>] [B<-f> I<timeout>] [B<-j> I<dir>]
+B<rrdcached> [B<-l> I<address>] [B<-w> I<timeout>] [B<-z> I<delay>] [B<-f> I<timeout>] [B<-j> I<dir>] [-F]
  
  =head1 DESCRIPTION
  
  
  =head1 DESCRIPTION
  
@@ -35,7 +35,19 @@ interpreted as the path to a UNIX domain socket. Otherwise the address or node
  name are resolved using L<getaddrinfo>.
  
  For network sockets, a port may be specified by using the form
  name are resolved using L<getaddrinfo>.
  
  For network sockets, a port may be specified by using the form
-I<address>:I<port>.  The default port is 42217.
+C<B<[>I<address>B<]:>I<port>>. If the address is an IPv4 address or a fully
+qualified domain name (i.E<nbsp>e. the address contains at least one dot
+(C<.>)), the square brackets can be omitted, resulting in the (simpler)
+C<I<address>B<:>I<port>> pattern.. The default port is B<42217/udp>.
+
+The following formats are accepted. Please note that the address of the UNIX
+domain socket B<must> start with a slash in the second case!
+
+   unix:</path/to/unix.sock>
+   /<path/to/unix.sock>
+   <hostname-or-ip>
+   [<hostname-or-ip>]:<port>
+   <hostname-or-ipv4>:<port>
  
  If the B<-l> option is not specified the default address,
  C<unix:/tmp/rrdcached.sock>, will be used.
  
  If the B<-l> option is not specified the default address,
  C<unix:/tmp/rrdcached.sock>, will be used.
@@ -75,7 +87,20 @@ found, all updates therein will be read into memory before the daemon
  starts accepting new connections.
  
  The journal will be rotated with the same frequency as the flush timer
  starts accepting new connections.
  
  The journal will be rotated with the same frequency as the flush timer
-given by B<-f>.  On clean shutdown, the journal files are removed.
+given by B<-f>.
+
+When journaling is enabled, the daemon will use a fast shutdown procedure.
+Rather than flushing all files to disk, it will make sure the journal is
+properly written and exit immediately.  Although the RRD data files are
+not fully up-to-date, no information is lost; all pending updates will be
+replayed from the journal next time the daemon starts up.
+
+To disable fast shutdown, use the B<-F> option.
+
+=item B<-F>
+
+ALWAYS flush all updates to the RRD data files when the daemon is shut
+down, regardless of journal setting.
  
  =item B<-b> I<dir>
  
  
  =item B<-b> I<dir>
  
@@ -175,9 +200,8 @@ The downside of caching values is that they won't show up in graphs generated
  from the RRDE<nbsp>files. To get around this, the daemon provides the "flush
  command" to flush specific files. This means that the file is inserted at the
  B<head> of the update queue or moved there if it is already enqueued. The flush
  from the RRDE<nbsp>files. To get around this, the daemon provides the "flush
  command" to flush specific files. This means that the file is inserted at the
  B<head> of the update queue or moved there if it is already enqueued. The flush
-command will return after the update thread has dequeued the file, so there is
-a good chance that the file has been updated by the time the client receives
-the response from the daemon, but there is no guarantee.
+command will return only after the file's pending updates have been written
+to disk.
  
   +------+   +------+                               +------+
   ! head !   ! root !                               ! tail !
  
   +------+   +------+                               +------+
   ! head !   ! root !                               ! tail !
@@ -305,6 +329,11 @@ Causes the daemon to put I<filename> to the B<head> of the update queue
  (possibly moving it there if the node is already enqueued). The answer will be
  sent B<after> the node has been dequeued.
  
  (possibly moving it there if the node is already enqueued). The answer will be
  sent B<after> the node has been dequeued.
  
+=item B<FLUSHALL>
+
+Causes the daemon to start flushing ALL pending values to disk.  This
+returns immediately, even though the writes may take a long time.
+
  =item B<HELP> [I<command>]
  
  Returns a short usage message. If no command is given, or I<command> is
  =item B<HELP> [I<command>]
  
  Returns a short usage message. If no command is given, or I<command> is
@@ -399,6 +428,39 @@ Number of times the journal has been rotated since startup.
  
  =back
  
  
  =back
  
+=head1 SIGNALS
+
+=over 4
+
+=item SIGINT and SIGTERM
+
+The daemon exits normally on receipt of either of these signals.  Pending
+updates are handled in accordance with the B<-j> and B<-F> options.
+
+=item SIGUSR1
+
+The daemon exits AFTER flushing all updates out to disk.  This may take a
+while.
+
+=item SIGUSR2
+
+The daemon exits immediately, without flushing updates out to disk.
+Pending updates will be replayed from the journal when the daemon starts
+up again.  B<WARNING: if journaling (-j) is NOT enabled, any pending
+updates WILL BE LOST>.
+
+=back
+
+=head1 SIGNALS
+
+=over 4
+
+=item SIGINT and SIGTERM
+
+The daemon exits normally on receipt of either of these signals.
+
+=back
+
  =head1 BUGS
  
  No known bugs at the moment.
  =head1 BUGS
  
  No known bugs at the moment.