Added SADC_OPTIONS to sysstat configuration file, and sysstat(5) manual page.

Mail from Ivana Varekova (20/09/2010):
SADC_OPTIONS is now the prefered way to pass args to sadc. It is read from
sa1 and sa2 shell scripts from /etc/sysconfig/sysstat configuration file.
Also add sysstat(5) manual page that describes the various environment
variables and their meanings.

diff --git a/.gitignore b/.gitignore
index 3b2f95e8466f9405db0dea71231bfe49e5528c16..84232ba49e73a7d9644d52cf9c36be6320fcab92 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -20,6 +20,7 @@ contrib/isag/isag
 man/sa1.8
 man/sa2.8
 man/sadc.8
+man/sysstat.5
 man/sadf.1
 man/sar.1
 man/iostat.1

diff --git a/CHANGES b/CHANGES
index b3e17835f2fa158673f53eb812257ff84d4d0ecf..440e835bf69a56faf32efafe3820d57170483c4d 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -5,6 +5,8 @@ xxxx/xx/xx: Version 9.1.6 - Sebastien Godard (sysstat <at> orange.fr)
        * [Ivana Varekova]: Moved manual pages to $prefix/share/man
          instead of $prefix/man.
        * [Ivana Varekova]: Fixed configure's --disable-man-group option.
+       * [Ivana Varekova]: Added SADC_OPTIONS to sysstat configuration file.
+       * [Ivana Varekova]: Added sysstat(5) manual page.
        * sar manual page updated.
        * DTD and XSD documents updated.
        * Made sysstat git aware.

diff --git a/Makefile.in b/Makefile.in
index f897d50389459212a329e35d619b267cbbf32172..5bcccbb8403ad1e2de00ee45310b02a3f314e96a 100644 (file)
--- a/Makefile.in
+++ b/Makefile.in
@@ -50,6 +50,7 @@ ifndef MAN_DIR
 MAN_DIR = @mandir@
 endif
 MAN1_DIR = $(MAN_DIR)/man1
+MAN5_DIR = $(MAN_DIR)/man5
 MAN8_DIR = $(MAN_DIR)/man8
 
 ifndef DOC_DIR
@@ -223,9 +224,10 @@ nls/sysstat.pot: $(wildcard *.c)
 .PHONY: clean distclean install install_base install_all uninstall \
        uninstall_base uninstall_all dist bdist
 
-install_man: man/sadc.8 man/sar.1 man/sadf.1 man/sa1.8 man/sa2.8
+install_man: man/sadc.8 man/sar.1 man/sadf.1 man/sa1.8 man/sa2.8 man/sysstat.5
 ifeq ($(INSTALL_DOC),y)
        mkdir -p $(DESTDIR)$(MAN1_DIR)
+       mkdir -p $(DESTDIR)$(MAN5_DIR)
        mkdir -p $(DESTDIR)$(MAN8_DIR)
        rm -f $(DESTDIR)$(MAN8_DIR)/sa1.8*
        $(INSTALL_DATA) $(MANGRPARG) man/sa1.8 $(DESTDIR)$(MAN8_DIR)
@@ -237,6 +239,8 @@ ifeq ($(INSTALL_DOC),y)
        $(INSTALL_DATA) $(MANGRPARG) man/sar.1 $(DESTDIR)$(MAN1_DIR)
        rm -f $(DESTDIR)$(MAN1_DIR)/sadf.1*
        $(INSTALL_DATA) $(MANGRPARG) man/sadf.1 $(DESTDIR)$(MAN1_DIR)
+       rm -f $(DESTDIR)$(MAN5_DIR)/sysstat.5*
+       $(INSTALL_DATA) $(MANGRPARG) man/sysstat.5 $(DESTDIR)$(MAN5_DIR)
        rm -f $(DESTDIR)$(MAN1_DIR)/iostat.1*
        $(INSTALL_DATA) $(MANGRPARG) man/iostat.1 $(DESTDIR)$(MAN1_DIR)
        rm -f $(DESTDIR)$(MAN1_DIR)/mpstat.1*
@@ -256,6 +260,7 @@ ifeq ($(COMPRESS_MANPG),y)
        $(ZIP) $(DESTDIR)$(MAN8_DIR)/sadc.8
        $(ZIP) $(DESTDIR)$(MAN1_DIR)/sar.1
        $(ZIP) $(DESTDIR)$(MAN1_DIR)/sadf.1
+       $(ZIP) $(DESTDIR)$(MAN5_DIR)/sysstat.5
        $(ZIP) $(DESTDIR)$(MAN1_DIR)/iostat.1
        $(ZIP) $(DESTDIR)$(MAN1_DIR)/mpstat.1
        $(ZIP) $(DESTDIR)$(MAN1_DIR)/pidstat.1
@@ -405,6 +410,7 @@ ifeq ($(INSTALL_DOC),y)
        rm -f $(DESTDIR)$(MAN8_DIR)/sa2.8*
        rm -f $(DESTDIR)$(MAN1_DIR)/sar.1*
        rm -f $(DESTDIR)$(MAN1_DIR)/sadf.1*
+       rm -f $(DESTDIR)$(MAN5_DIR)/sysstat.5*
        rm -f $(DESTDIR)$(MAN1_DIR)/iostat.1*
        rm -f $(DESTDIR)$(MAN1_DIR)/mpstat.1*
        rm -f $(DESTDIR)$(MAN1_DIR)/pidstat.1*
@@ -575,7 +581,7 @@ almost-distclean: clean nls/sysstat.pot
        rm -f sysstat.sysconfig sysstat.crond sysstat.cron.daily
        rm -f sysstat.cron.hourly sysstat.crond.sample sysstat.crond.sample.in
        rm -f contrib/isag/isag
-       rm -f man/sa1.8 man/sa2.8 man/sadc.8 man/sadf.1 man/sar.1 man/iostat.1
+       rm -f man/sa1.8 man/sa2.8 man/sadc.8 man/sadf.1 man/sar.1 man/iostat.1 man/sysstat.5
        rm -f *.log config.status
        rm -rf autom4te.cache
        rm -f *.save *.old .*.swp data

diff --git a/configure b/configure
index 0baebb9c40d0ad89467f91aac02de3b82cfe57c7..231a4d552f6d480542822ab746b2bb8920e531bc 100755 (executable)
--- a/configure
+++ b/configure
@@ -7786,6 +7786,8 @@ ac_config_files="$ac_config_files man/sadf.1:man/sadf.in"
        # File must be renamed
 ac_config_files="$ac_config_files man/sar.1:man/sar.in"
                # File must be renamed
+ac_config_files="$ac_config_files man/sysstat.5:man/sysstat.in"
+       # File must be renamed
 ac_config_files="$ac_config_files man/iostat.1:man/iostat.in"
        # File must be renamed
 ac_config_files="$ac_config_files contrib/isag/isag"
@@ -8417,6 +8419,7 @@ do
     "man/sadc.8") CONFIG_FILES="$CONFIG_FILES man/sadc.8:man/sadc.in" ;;
     "man/sadf.1") CONFIG_FILES="$CONFIG_FILES man/sadf.1:man/sadf.in" ;;
     "man/sar.1") CONFIG_FILES="$CONFIG_FILES man/sar.1:man/sar.in" ;;
+    "man/sysstat.5") CONFIG_FILES="$CONFIG_FILES man/sysstat.5:man/sysstat.in" ;;
     "man/iostat.1") CONFIG_FILES="$CONFIG_FILES man/iostat.1:man/iostat.in" ;;
     "contrib/isag/isag") CONFIG_FILES="$CONFIG_FILES contrib/isag/isag" ;;
     "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;;

diff --git a/configure.in b/configure.in
index 0b2febb8678f950cbd8c1204a3032909defec8fe..cc60a47025d00ca2891506ab5f75c3aed65cb7fb 100644 (file)
--- a/configure.in
+++ b/configure.in
@@ -506,6 +506,7 @@ AC_CONFIG_FILES([man/sa2.8:man/sa2.in])             # File must be renamed
 AC_CONFIG_FILES([man/sadc.8:man/sadc.in])      # File must be renamed
 AC_CONFIG_FILES([man/sadf.1:man/sadf.in])      # File must be renamed
 AC_CONFIG_FILES([man/sar.1:man/sar.in])                # File must be renamed
+AC_CONFIG_FILES([man/sysstat.5:man/sysstat.in])        # File must be renamed
 AC_CONFIG_FILES([man/iostat.1:man/iostat.in])  # File must be renamed
 AC_CONFIG_FILES([contrib/isag/isag], [chmod +x contrib/isag/isag]) # Permissions must be changed
 

diff --git a/man/sa1.in b/man/sa1.in
index 5e84424e357206b85cbd75fc2470476dab958c84..7da22287c3b9e871f64dc85a0f6a76cf9ca53ae1 100644 (file)
--- a/man/sa1.in
+++ b/man/sa1.in
@@ -1,4 +1,4 @@
-.TH SA1 8 "AUGUST 2010" Linux "Linux User's Manual" -*- nroff -*-
+.TH SA1 8 "SEPTEMBER 2010" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 sa1 \- Collect and store binary data in the system activity daily data file.
 .SH SYNOPSIS
@@ -63,6 +63,7 @@ Sebastien Godard (sysstat <at> orange.fr)
 .BR sar (1),
 .BR sadc (8),
 .BR sa2 (8),
-.BR sadf (1)
+.BR sadf (1),
+.BR sysstat (5)
 
 .I http://pagesperso-orange.fr/sebastien.godard/

diff --git a/man/sadc.in b/man/sadc.in
index a2d2679fb79f5aed5a682fb1fbe4923092a70dfd..360c3de596016b5e931801d27aacb7a585e99a53 100644 (file)
--- a/man/sadc.in
+++ b/man/sadc.in
@@ -1,4 +1,4 @@
-.TH SADC 8 "AUGUST 2010" Linux "Linux User's Manual" -*- nroff -*-
+.TH SADC 8 "SEPTEMBER 2010" Linux "Linux User's Manual" -*- nroff -*-
 .SH NAME
 sadc \- System activity data collector.
 .SH SYNOPSIS
@@ -203,6 +203,7 @@ Sebastien Godard (sysstat <at> orange.fr)
 .BR sar (1),
 .BR sa1 (8),
 .BR sa2 (8),
-.BR sadf (1)
+.BR sadf (1),
+.BR sysstat (5)
 
 .I http://pagesperso-orange.fr/sebastien.godard/

diff --git a/man/sysstat.in b/man/sysstat.in
new file mode 100644 (file)
index 0000000..5f40e25
--- /dev/null
+++ b/man/sysstat.in
@@ -0,0 +1,47 @@
+.TH SYSSTAT 5 "SEPTEMBER 2010" Linux "Linux User's Manual" -*- nroff -*-
+.SH NAME
+sysstat \- sysstat configuration file.
+.SH DESCRIPTION
+This file is read by
+.BR sa1 (8)
+and
+.BR sa2 (8)
+shell scripts from the sysstat's set of tools.
+It consists of a sequence of shell variable assignments used to
+configure sysstat logging.
+The variables and their meanings are:
+.TP
+.B HISTORY
+The number of days during which a daily data file or a report
+should be kept. Data files or reports older than this number of
+days will be removed by the
+.BR sa2 (8)
+shell script.
+
+.TP
+.B COMPRESSAFTER
+Number of days after which daily data files are to be compressed,
+either by gzip or bzip2.
+
+.TP
+.B SADC_OPTIONS
+Options that should be passed to
+.BR sadc (8).
+With these options (see
+.BR sadc (8)
+manual page), you can select some additional data which are going to be saved in
+daily data files.
+These options are used only when a new data file is created. They will be
+ignored with an already existing one.
+
+.SH FILES
+.IR @SYSCONFIG_DIR@/sysstat
+
+.SH AUTHOR
+Sebastien Godard (sysstat <at> orange.fr)
+.SH SEE ALSO
+.BR sadc (8),
+.BR sa1 (8),
+.BR sa2 (8)
+
+.I http://pagesperso-orange.fr/sebastien.godard/

diff --git a/sa1.in b/sa1.in
index dbaa322653c286d9bdb3597ac78c6470e0a033ee..e053b9b4a96e2e6b18567b69542844a5fb7e987f 100644 (file)
--- a/sa1.in
+++ b/sa1.in
@@ -6,6 +6,7 @@
 #@(#) sa1: Collect and store binary data in system activity data file.
 #
 HISTORY=0
+SADC_OPTIONS=""
 SYSCONFIG_DIR=@SYSCONFIG_DIR@
 [ -r ${SYSCONFIG_DIR}/sysstat ] && . ${SYSCONFIG_DIR}/sysstat
 if [ ${HISTORY} -gt 28 ]
@@ -38,8 +39,8 @@ then
 # Note: Stats are written at the end of previous file *and* at the
 # beginning of the new one (when there is a file rotation) only if
 # outfile has been specified as '-' on the command line...
-       exec ${ENDIR}/sadc -F -L 1 1 -
+       exec ${ENDIR}/sadc -F -L ${SADC_OPTIONS} 1 1 -
 else
-       exec ${ENDIR}/sadc -F -L $* -
+       exec ${ENDIR}/sadc -F -L ${SADC_OPTIONS} $* -
 fi
 

diff --git a/sysstat.in b/sysstat.in
index 8cb41d950ad0bef865b9b25ac2e9bb338b60bca8..a914ed8da429a1c377d97b78ff98f9b03f8b1fd4 100644 (file)
--- a/sysstat.in
+++ b/sysstat.in
@@ -17,16 +17,13 @@
 #@(#)   This indicates that the counters have restarted from 0.
 
 RETVAL=0
-SYSCONFIG_DIR=@SYSCONFIG_DIR@
-#SADC_OPTIONS="-S DISK"
-SADC_OPTIONS=""
 
 # See how we were called.
 case "$1" in
   start)
        exitCodeIndicator="$(mktemp /tmp/sysstat-XXXXXX)" || exit 1
        echo -n "Calling the system activity data collector (sadc): "
-       @SU_C_OWNER@ @QUOTE@ @SA_LIB_DIR@/sa1 --boot ${SADC_OPTIONS} || rm -f ${exitCodeIndicator} @QUOTE@
+       @SU_C_OWNER@ @QUOTE@ @SA_LIB_DIR@/sa1 --boot || rm -f ${exitCodeIndicator} @QUOTE@
 
        # Try to guess if sadc was successfully launched. The difficulty
        # here is that the exit code is lost when the above command is

diff --git a/sysstat.sysconfig.in b/sysstat.sysconfig.in
index b06b633749e160f4e3caa39a23a4174c718372f1..54dcef9019e9fc3ced855ae74fb9184e1581d187 100644 (file)
--- a/sysstat.sysconfig.in
+++ b/sysstat.sysconfig.in
@@ -8,3 +8,7 @@ HISTORY=@HISTORY@
 # Compress (using gzip or bzip2) sa and sar files older than (in days):
 COMPRESSAFTER=@COMPRESSAFTER@
 
+# Parameters for the system activity data collector (see sadc manual page)
+# which are used for the generation of log files.
+SADC_OPTIONS=""
+