Document revision date: 19 July 1999

The Error Formatter (ERRFMT) process is started automatically at boot time. The following sections explain how to perform these tasks:

Task	Section
Restart the ERRFMT process, if necessary	Section 18.3.1
Maintain error log files	Section 18.3.2
Send mail if the ERRFMT process is deleted	Section 18.3.3

18.3.1 Restarting the ERRFMT Process

To restart the ERRFMT process, follow these steps:

1. Log in to the system manager's account so that you have the required privileges to perform the operation.
2. Execute the site-independent startup command procedure (STARTUP.COM), specifying ERRFMT as the command parameter, as follows:

   $ @SYS$SYSTEM:STARTUP ERRFMT

   Note If disk quotas are enabled on the system disk, ERRFMT starts only if UIC [1,4] has sufficient quotas.

Because the error log file, SYS$ERRORLOG:ERRLOG.SYS, is a shared file, ERRFMT can write new error log entries while the Error Log utility reads and reports on other entries in the same file.

ERRLOG.SYS increases in size and remains on the system disk until you explicitly rename or delete it. Therefore, devise a plan for regular maintenance of the error log file. One method is to rename ERRLOG.SYS on a daily basis. If you do this, the system creates a new error log file. You might, for example, rename the current copy of ERRLOG.SYS to ERRLOG.OLD every morning at 9:00. To free space on the system disk, you can then back up the renamed version of the error log file on a different volume and delete the file from the system disk.

Another method is to keep the error log file on a disk other than the system disk by defining the logical name SYS$ERRORLOG to be the device and directory where you want to keep error log files; for example:

$ DEFINE/SYSTEM/EXECUTIVE SYS$ERRORLOG DUA2:[ERRORLOG]

To define this logical name each time you start up the system, add the logical name definition to your SYLOGICALS.COM procedure. See Section 5.2.5 for details.

Be careful not to delete error log files inadvertently. You might also want to adopt a file-naming convention that includes a beginning or ending date for the data in the file name.

18.3.3 Using ERRFMT to Send Mail

The Error Formatter (ERRFMT) allows users to send mail to the system manager or to another designated user if the ERRFMT process encounters a fatal error and deletes itself.

Two system logical names, ERRFMT$_SEND_MAIL and ERRFMT$_SEND_TO, control this feature:

• ERRFMT$_SEND_MAIL
  To enable sending mail, must translate to the string TRUE, and is case insensitive. Any other value disables the sending of mail.
• ERRFMT$_SEND_TO
  Must translate to a user name (the current default is SYSTEM).
  Compaq recommends that you do not use distribution lists and multiple user names.

You can define these logical names in one of two ways:

• Dynamically, using DCL DEFINE/SYSTEM commands
  After you make the changes, you must stop and restart ERRFMT for the changes to take effect.
• Permanently, in SYS$STARTUP:SYLOGICAL.COM
  The logical names you define take effect the next time the system is rebooted. The following instructions use this method.

If ERRFMT$_SEND_MAIL is defined to be TRUE, you receive a mail message with a subject line saying that ERRFMT is about to delete itself. The operator log file and the output displayed at the system console, OPA0:, contain more detailed information about the failure encountered and instructions on how to restart ERRFMT; however, you are often not at the console to see this information.

If you are using ERRFMT in one mode, for example, with sending mail enabled, and you want to disable sending mail, use the system manager's account to edit SYS$STARTUP:SYLOGICAL.COM, adding the following command:

$ DEFINE/SYSTEM ERRFMT$_SEND_MAIL FALSE

To reenable sending mail, use the system manager's account to edit SYS$STARTUP:SYLOGICAL.COM, adding the following command:

$ DEFINE/SYSTEM ERRFMT$_SEND_MAIL TRUE

18.3.3.2 Sending Mail to Another User

Sending mail to the SYSTEM account is enabled by default. However, you can define ERRFMT$_SEND_TO to send mail to another user if ERRFMT is about to delete itself.

To change the user name to receive mail, use the system manager's account to edit SYS$STARTUP:SYLOGICAL.COM, adding an appropriate logical name DEFINE command. For example:

$ DEFINE/SYSTEM ERRFMT$_SEND_TO R_SMITH

Compaq recommends that you do not use distribution lists and multiple user names.

18.4 Using ERROR LOG

Use the Error Log utility (ERROR LOG) to report selectively on the contents of an error log file. You must have the SYSPRV privilege to run ERROR LOG. Starting with OpenVMS Version 7.2, before using the Error Log utility, you need to translate error log files using the Binary Error Log Translation utility, which is part of DECevent. For more information, refer to its documentation, which is included in the DECevent kit.

18.4.1 Understanding ERROR LOG

ERROR LOG supports most OpenVMS supported hardware, such as adapters, disks, tapes, CPUs, and memories, but not all communications devices. Some synchronous communications devices are supported.

The operating system automatically writes messages to the latest version of an error log file, SYS$ERRORLOG:ERRLOG.SYS, as the events shown in Table 18-3 occur.

Table 18-3 Types of Events Reported in the Error Log File

Event	Description
Errors	Device errors, device timeouts, machine checks, bus errors, memory errors (hard or soft error correcting code [ECC] errors), asynchronous write errors, and undefined interrupts
Volume changes	Volume mounts and dismounts
System events	System startups, messages from the Send Message to Error Logger ($SNDERR) system service, and time stamps

You can use ERROR LOG to process error log entries for the following forms of optional output:

• Full report of selected entries, which is the default
• Brief report of selected entries
• Summary report of selected entries
• Register dump report of selected device entries
• Binary copy of selected entries
• Binary copy of rejected entries

Section 18.4.2 explains how to produce error log reports. Refer to the OpenVMS System Management Utilities Reference Manual for examples of error log reports.

The error reports that ERROR LOG produces are useful in two ways:

• They aid preventive maintenance by identifying areas within the system that show potential for failure.
• They aid the diagnosis of a failure by documenting the errors and events that led up to it.

The detailed contents of the reports are most meaningful to Compaq support representatives. However, you can use the reports as an important indicator of the system's reliability. For example, using the DCL command SHOW ERROR, you might see that a particular device is producing a relatively high number of errors. You can then use ERROR LOG to obtain a more detailed report and decide whether to consult your support representative.

If a system component fails, a Compaq support representative can study the error reports of the system activity leading up to and including the failure. If a device fails, you can generate error reports immediately after the failure; for example:

• One report might describe in detail all errors associated with the device that occurred within the last 24 hours.
• Another report might summarize all types of errors for all devices that occurred within the same time period.
• The summary report can put the device errors into a systemwide context.

Your support representative can then run the appropriate diagnostic program for a thorough analysis of the failed device. Using the combined error logging and diagnostic information, your support representative can proceed to correct the device.

Error reports allow you to anticipate potential failures. Effective use of the Error Log utility in conjunction with diagnostic programs can significantly reduce the amount of system downtime.

18.4.2 Producing Error Log Reports

You enter the DCL command in the following format:
ANALYZE/ERROR_LOG [/qualifier(s)][filespec[,...]]

where:

qualifier	Specifies the function the ANALYZE/ERROR_LOG command is to perform.
filespec	Specifies one or more files that contain information to be interpreted for the error log report.

Refer to the OpenVMS System Management Utilities Reference Manual for details about the command and its parameters and for examples of error log reports.

ERROR LOG issues error messages for inconsistent error log entries. Use the Help Message facility to look up explanations and suggested user actions for these messages.

18.4.3 Producing a Full Error Log Report

The following steps show how to produce an error log report for all entries in the error log file and how to print the report:

1. Either log in to the SYSTEM account or ensure that you have the SYSPRV privilege. (You must have privilege to access the error log file.) For example:

   $ SET PROCESS/PRIVILEGE=SYSPRV

2. Set your default disk and directory to SYS$ERRORLOG:

   $ SET DEFAULT SYS$ERRORLOG

3. Examine the error log directory to see which error log file you want to analyze:

   $ DIRECTORY

4. To obtain a full report of the current error log file, enter the following command:

   $ ANALYZE/ERROR_LOG/OUTPUT=ERRORS.LIS

5. Print a copy of the report, using the file name you specified with the /OUTPUT qualifier:

   $ PRINT ERRORS.LIS

Example

$ SET PROCESS/PRIVILEGE=SYSPRV $ SET DEFAULT SYS$ERRORLOG $ DIRECTORY (1) Directory SYS$SYSROOT:[SYSERR] ERRLOG.OLD;2 ERRLOG.OLD;1 ERRLOG.SYS;1 Total of 3 files. $ ANALYZE/ERROR_LOG/OUTPUT=ERRORS.LIS ERRLOG.OLD (2) $ PRINT ERRORS.LIS (3)

The following list explains the commands in the example.

1. The DIRECTORY command lists all the files in the SYS$ERRORLOG directory. The directory contains three files: two old error log files and the current error log file, ERRLOG.SYS.
2. The ANALYZE/ERROR_LOG command writes a full report to a file called ERRORS.LIS, using the most recent ERRLOG.OLD file as input.
3. The PRINT command prints ERRORS.LIS.

This section briefly explains how to specify report formats and produce a report of selected entries.

Table 18-4 contains error log report options. For more details about options and examples of error log reports using options, refer to the OpenVMS System Management Utilities Reference Manual.

Table 18-4 Error Log Report Options

In Order To...	You Can...
Specify report formats	Change report formats by using qualifiers, including the following ones: /BINARY---to convert binary error log records to ASCII text or to copy error log records to a specified output file. /BRIEF---to create a brief report. /REGISTER_DUMP---to generate, in a hexadecimal longword format, a report that consists of device register information (used in conjunction with the /INCLUDE qualifier). /REJECTED---to specify the name of a file that will contain binary records for rejected entries.
Specify a display device for reports	Use the /OUTPUT qualifier to send reports to a terminal for display or to a disk or magnetic tape file. By default, the system sends the report to the SYS$OUTPUT device. Because error log reports are 72 columns wide, you can display them on the terminal screen.
Produce a report of selected entries	Use qualifiers to produce error log reports for specific types of events and for a specified time interval. For example, you can process error log entries by selecting a time interval using the /SINCE, /BEFORE, or /ENTRY qualifiers. You can specify error log entries for specific events by using the qualifiers /INCLUDE and /EXCLUDE. These qualifiers form a filter to determine which error log entries are selected or rejected. In addition, you can generate error log reports for one or more OpenVMS Cluster members by using the /NODE qualifier.
Exclude unknown error log entries	By default, when ANALYZE/ERROR_LOG encounters an unknown device, CPU, or error log entry, the utility produces the entry in hexadecimal longword format. Exclude these entries from the report by specifying /EXCLUDE=UNKNOWN_ENTRIES in the command line.

18.5 Using DECevent

The DECevent Event Management utility (DECevent) provides the interface between a system user and the operating system's event log files.

18.5.1 Understanding DECevent

DECevent allows system users to produce ASCII reports derived from system event entries. The format of the ASCII reports depends on the command entered on the command language interpreter (CLI) with a maximum character limit of 255 characters.

DECevent uses the error log file, SYS$ERRORLOG:ERRLOG.SYS, as the default input file, unless you specify another input file.

Event reports are useful for determining preventive maintenance by helping to identify areas within the system showing potential failure. Event reports also aid in the diagnosis of a failure by documenting events that led to the failure.

The contents of the event reports are most meaningful to your Compaq support representative. However, you can use the event reports as an indicator of system reliability. For example, while using the DCL command SHOW ERROR, you might see that a particular device is producing a higher than normal number of events. You can use DECevent to obtain various detailed reports and determine if you need to contact your Compaq support representative.

If a system component fails, your Compaq support representative can use the event reports to create a history of events leading up to and including the failure.

Used in conjunction with diagnostic programs, event reports significantly reduce the amount of system down time.

DECevent Report Types

DECevent produces five types of reports:

Report Type	Description
Full (default)	Provides a translation of all available information for each entry in the event log.
Brief	Provides a translation of key information for each entry in the event log.
Terse	Provides binary event information and displays register values and other ASCII messages in a condensed format.
Summary	Provides a statistical summary of the event entries in the event log.
Fast Error (FSTERR)	Provides a quick, one-line per-entry report of your event log for a variety of disk devices.

These report types are mutually exclusive; in other words, you can select only one report type in a command.

Section 18.5.5 contains examples of types of reports. The OpenVMS System Management Utilities Reference Manual contains additional examples of the types of reports produced by DECevent.

The following sections explain how to use DECevent:

Task	Section
Invoking and exiting DECevent	Section 18.5.2
Using DECevent qualifiers	Section 18.5.3
Using additional DECevent commands	Section 18.5.4
Producing DECevent reports	Section 18.5.5

In addition, restrictions are listed in Section 18.5.6.

18.5.2 Invoking and Exiting DECevent

To invoke DECevent, enter the following command:

$ DIAGNOSE/TRANSLATE [/qualifier(s)] [file-spec][,..]

DECevent does not prompt you. To exit from DECevent, press Ctrl/C and Return (otherwise, no prompt is returned).

18.5.3 Using DECevent Qualifiers

The DECevent qualifiers shown and described in Table 18-5 allow you to change the format of the reports that DECevent produces.

Table 18-5 DECevent Qualifiers

Qualifier	Description
/BEFORE	Specifies that only those entries dated earlier than the stated date and time are to be selected for the event report
/BINARY	Controls whether the binary error log records are converted to ASCII text or copied to the specified output file
/BRIEF	Generates a brief report
/CONTINUOUS	Specifies events are formatted in real time, as they are logged by the operating system event logger
/DUMP	Specifies the output to be a brief report followed by a dump of information from the input event log file
/ENTRY	Generates a report that includes the specified entry range or starts at the specified entry number
/EXCLUDE	Excludes events generated by the specified device class, device name, or error log entry type from the report
/FSTERR	Generates a quick, one-line-per-entry report for an event log entry for disks
/FULL	Generates a full report (default), which provides all available information for an event log entry
/INCLUDE	Includes events generated by the specified device class, device name, or error log entry type in the report
/INTERACTIVE	Allows users to exit from the command line interface and enter the DECevent interactive command shell
/LOG	Controls whether informational messages that specify the number of entries selected and rejected for each input file are sent to SYS$OUTPUT
/NODE	Generates a report consisting of event entries for specific nodes in a cluster
/OUTPUT	Specifies the output file for the report
/REJECTED	Allows you to specify the name of a file that will contain binary records for rejected entries
/SINCE	Specifies that only those entries dated later than the stated date and time are to be selected for the report
/SUMMARY	Generates an event report that consists of a statistical summary
/TERSE	Generates an event report consisting of binary event information, register values and ASCII messages in a condensed format
/TRANSLATE	Is the default qualifier for the DIAGNOSE command verb

Do not use the /BINARY qualifier with any report type qualifier (/FULL, /BRIEF, /TERSE, /SUMMARY, and /FSTERR) or with the /OUTPUT qualifier.

Privileges Required

• You must have SYSPRV privilege to run DECevent; however, only read access is required to access the ERRLOG.SYS file.
• You must have the DIAGNOSE privilege for the /CONTINUOUS qualifier to work, enabling the continuous display of events on a terminal screen.

	privacy and legal statement
6017PRO_080.HTML