Maintaining a System Log Book

Maintaining a System Log Book

It is important to keep a complete set of records about each system you administer. A system log book is a useful tool when troubleshooting transient problems or when trying to establish system operating characteristics over a period of time. Keeping a hardcopy book is important, since you won't be able to refer to an online log if you have trouble starting the system.

Some of the things that you should consider entering into the log book are:

maintenance records (dates and actions)
printouts of error messages and diagnostic phases
equipment and system configuration changes (dates and actions), including serial numbers of various parts (if applicable)
copies of important configuration files
the output of prtvtoc(1M) for each disk on the system
the /etc/passwd file
the /etc/group file
the /etc/fstab file
the /etc/exports file

The format of the system log and the types of items noted in the log should follow a logical structure. Think of the log as a diary that you update periodically. To a large measure, how you use your system will dictate the form and importance of maintaining a system log.

In addition to the system log, you may find it helpful to keep a user trouble log. The problems that users encounter fall into patterns. If you keep a record of how problems are resolved, you do not have to start from scratch when a problem recurs. Also, a user trouble log can be very useful for training new administrators in the specifics of your local system, and for helping them learn what to expect.