scc-log(1)



NAME


	scc-log - create a SCC-snapshot and compare with previous snapshot

RELEASE


	scc	1.9.28

SYNOPSIS


	scc-log [ -c <remark> ] [ -e <mod> ] [ -m <max> ] [ -r | -u ]
		[ -v <host> ]

DESCRIPTION


	This program calls scc-collect to create a SCC-snapshot and compares
	it with a previous snapshot. All differences are added to a logbook.
	Finally, both the new snapshot and the logbook are also written in
	HTML-format. Refer to scc(4) for a detailed description of the format
	of the snapshots and logbooks.

	scc-collect runs system and user modules. Each module collects
	specific configuration data. You can extend the "reach" of scc by
	writing and scheduling your own user modules. Refer to scc-collect(1)
	for a detailed description of modules and how to schedule and maintain
	them.

	The data in the snapshot can be split into several, partial snapshots. 
	This is done before comparing it with a previous snapshot. The mechanism
	can be used to provide Oracle DBA's with a snapshot for each Oracle 
	instance. It can also be used to separate each package in a ServiceGuard
	cluster. The partial snapshots of these packages can be compared on the
	scc-srv. This avoids many changes in the logbooks of a cluster, when a
	package "switches".
	Refer to the file /etc/opt/scc/newconfig/scc-split.conf for more details.

	The contents of the data generated by the modules are tested to 
	check their format. Lines with unknown formats are prefixed with the
	classification: "fix:messages::". The philosophy of scc is to collect
	data, not to interpret it. scc signals when it is unable to collect
	configuration data. Any interpretation of the correctness of the
	data can be done by the program scc-rules of scc-srv.

	In rare occasions, scc-collect "hangs". Use the following command
	to find the child processes of scc:
		UNIX95= ps -Hef
	This will show you the entire process-tree. On Solaris, you can use
	the ptree command from the proctools. Find the "deepest" descendant
	from scc-collect and kill this process. Then issue the command again
	to monitor the progress of scc-collect.

	On abnormal termination of scc-collect, the new snapshot probably is
	incomplete. When the cause of the problem is removed, a new run of
	scc can be started. This leads to large differences with the new,
	complete snapshot. To avoid this, use the -r option of scc-log to
	remove the current snapshot before making a new one.

	When the abnormal termination of scc-collect was not detected, the
	next run of scc will add many differences to the logbook. To reduce
	the size of the logbook, the log file can be edited by hand and the
	differences can be deleted.

LIMITATIONS


	As the rpm-database is locked during the install of scc, the snapshot 
	made during the install does not contain any rpm-data. The next time
	scc is run after the install, it will record the rpm-data in the
	snapshot. This added rpm-data will not be mentioned in the logbook. 
	Any further changes in the rpm-data will be added to the logbook. 

ARGUMENTS


	None.

OPTIONS


	-c <remark>     Add a remark to the logbook, indicating a "specific" 
	                reason to run scc. For instance to mark the successful
	                configuration/change of a system.
	-e <mod>        scc-collect runs user module <mod> when collecting data.
	-m <max>        Entries in the log-file, that are older than <max>
	                months, are deleted
	-r              Remove the current snapshot to avoid comparing it with
	                the new (incompatible/incomplete) snapshot.
	-u              Remove all snapshots, logbooks en html-files and exit
	-v <host>	Do not use the hostname of the system, as base for all
			scc-files, use <host> instead. This option should be
			used to run specific user modules with frequently
			changing data using the -e option. This avoids
			"changes" in the scc-data of the system itself.
			Note that no system modules run when the -v option is
			used. Requires the use of the -e option.

DIAGNOSTICS


	This program writes the following messages to stderr:

	Syntax error, use: scc-log [ -c <remark> ] [ -e <mod> ] [ -m <max> ]
		[ -r | -u ] [ -v <host> ]
	A syntax error has been detected and reported.

	scc-log: Syntax error, missing argument for option <option>
	The indicated option is missing argument(s).

	scc-log: another instance is active, check process ID in <lock>
	This program compares a new snapshot with a previous one. When more
	than one instance of this program is active, they use the same files
	to store their new version of the snapshot. Therefore only one 
	instance of scc-log should be active.
	In rare occasions, a system program, called by scc-collect, might hang.
	When that is the case, try to kill the child processes of scc-collect.
	The lock file contains the PID of scc-log. When the lock-file exists and
	the process with the PID does not exist, the lock file is removed and 
	scc-log continues to run. Remove the lock file only when you are
	certain that scc-collect is not running.

	scc-log: non-numeric argument for -m option: <max>
	Use only numeric arguments for -m option.

	scc-log: use -e option with -v option
	The -v option can only be used when the -e option is used.

EXTERNAL INFLUENCES


	During the pre- and post-install, the existence of the lock-file
	scc.<hostname>.lock is checked to find out whether scc is running.

	When diff is implemented via busybox, the logbook will be left empty
	and all compares should be done on the scc-srv.

RETURN VALUE


	Upon completion, the program returns one of the following values:

		0 successful completion
		1 Syntax error
		2 Runtime error

COPYRIGHT


	scc-log is free software under the terms of the GNU General Public 
	License. Copyright (C) 2001-2004 Open Challenge B.V.,
	2004-2005 OpenEyeT Professional Services, 2005-2009 QNH.

FILES


	/var/opt/scc/tmp - directory for temporary files
	/var/opt/scc/data - directory for data files
		scc.<hostname>.cur - current SCC-snapshot
		scc.<hostname>.html - current SCC-snapshot in HTML-format
		scc.<hostname>.old - previous SCC-snapshot
		scc.<hostname>.new - new (temporary) SCC-snapshot
		scc.<hostname>.lock - lock file to indicate that SCC runs
		scc.<hostname>.log - logbook for changes in SCC-snapshots
		scc.<hostname>.log.html - logbook in HTML-format
		scc.<hostname>.keep - data kept from a previous run
		cfg.log - symbolic link to scc.<hostname>.log
			This symbolic link is used to detect whether the
			name of the system has changed. When this is the
			case, all scc.<hostname>.* files are renamed.
		index.html - compatibility for snapshot on scc-srv
		plugin_data/ - directory with snapshots from plugins

	/etc/opt/scc/conf/scc-split.conf - specification to split the
		data of the snapshot into several files of pseudo hosts.
		This file can be used to provide each Oracle instance with
		its own snapshot. The file is installed in the subdirectory
		newconfig to avoid that your changes are erased by an upgrade.
		This file is ignored when the -v option is used.

SEE ALSO


	scc(1), scc-cmp(1), scc-collect(1), scc-log(1), scc-log2html(1),
	scc-plugin(1), scc-snap2html(1), scc(4), scc(5)

VERSION


	$Revision: 1.154 $