OSSP CVS Repository

ossp - Check-in [3630]
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [Patchset]  [Tagging/Branching

Check-in Number: 3630
Date: 2003-Sep-25 15:57:23 (local)
2003-Sep-25 13:57:23 (UTC)
User:thl
Branch:
Comment: document changes in jitter and new monitor option in file channel
Tickets:
Inspections:
Files:
ossp-pkg/fsl/ChangeLog      1.20 -> 1.21     8 inserted, 1 deleted
ossp-pkg/fsl/fsl.pod      1.31 -> 1.32     19 inserted, 11 deleted

ossp-pkg/fsl/ChangeLog 1.20 -> 1.21

--- ChangeLog    2003/09/15 08:24:02     1.20
+++ ChangeLog    2003/09/25 13:57:23     1.21
@@ -8,10 +8,17 @@
 
   CHANGELOG
 
+  Changes between 1.2.1 and 1.2.2 (25-Sep-2003)
+    *) change jitter option in file channel from flag to count.
+       [Thomas Lotterer <thomas@lotterer.net]
+
+    *) add monitor option to file channel.
+       [Thomas Lotterer <thomas@lotterer.net]
+
   Changes between 1.2.0 and 1.2.1 (15-Sep-2003)
 
     *) include updated lib_l2 v0.9.3 to make sure prefix channel does
-       atomar downstream writes
+       atomar downstream writes.
        [Thomas Lotterer <thomas@lotterer.net]
 
   Changes between 1.1.0 and 1.2.0 (30-Jun-2003)


ossp-pkg/fsl/fsl.pod 1.31 -> 1.32

--- fsl.pod      2003/06/30 12:54:05     1.31
+++ fsl.pod      2003/09/25 13:57:23     1.32
@@ -202,22 +202,30 @@
 The B<file> channel opens a file at the given I<path> and passes
 messages poured in from upper channels to this file. If the file at
 the given path already exists, additional data is either appended
-(I<append>=1 or I<trunc>=0>) or the existing file is truncated
-(I<append>=0 or I<trunc>=1>). If I<jitter> is set the logfile will be
-opened and closed for every write operation. This makes log file
-rotation easy at the price of performance. The desired permissions of
-the logfile can be set through I<perm>.
+(I<trunc>=0>) or the existing file is truncated (I<trunc>=1>). The
+desired permissions of the logfile can be set through I<perm>. If
+I<jitter> is set to a number n other than zero the logfile will be
+closed and reopened before every n'th write operation. In other words,
+a logfile moved away will receive a maximum of n additional messages,
+then a new file using the old name will be opened without truncation. If
+I<monitor> is set to n seconds other than zero a timer is set. For every
+write operation the time is checked. If n or more seconds have passed by
+the timer is reset and it is checked whether the logfile was moved or
+disappeard. In such case the logfile will be closed an reopened before
+the actual write. In other words, a logfile moved away will receive
+messages no longer than the timer is set to, then a new file using the
+old name will be opened without truncation. These options make external
+log file rotation easy at a controllable price of performance. It is
+possible to combine I<jitter> and I<monitor>.
 
-Note that both append and trunc work equally well but append is obsolete
-and might be removed in the future.  Both options can be specified
-together as long as they are set different. L2 versions which know the
-trunc option default to append mode while previous versions limited to
-support only the append option defaulted to truncate mode.
+Note that the append option is obsolete and might be removed in the
+future. Use the trunc option with inverse logic instead.
 
  o file   (STR path            m
            INT append          o [0=no|1=yes]          =1
            INT trunc           o [0=no|1=yes]          =0
-           INT jitter          o [0=no|1=yes]          =0
+           INT jitter          o [count]               =0 (disabled)
+           INT monitor         o [sec]                 =0 (disabled)
            INT perm            o [octal]               =0644
            )
 

CVSTrac 2.0.1