Chapter 3 - The DECevent Bit-to-Text Translation Feature
3.1 Introduction
The DECevent utility allows you to produce bit-to-text ASCII reports derived from system event entries or user supplied event logs. The format of the ASCII report is determined by commands with flags, parameters, and selection keywords appended, entered on the command line interface (CLI). The maximum command line allowed is 255 characters.
The DECevent bit-to-text feature performs the following:
Note
Refer to Appendix A for a list of all DECevent utility independent directory files.
3.2 Necessary Privileges
Digital UNIX users need superuser privileges to use the translation and reporting features of DECevent, unless the event log file protection privileges have been changed to allow all users to read the event log file.
3.3 Command Verb
The DECevent utility command verb that allows the translation of system event entries for Digital UNIX operating systems is the following:
% dia -a
The -a flag is the default translation flag and does not need to be typed on the command line. Simply typing dia performs the same function as typing dia -a on the command line.
3.4 Translating Event Files
The DECevent utility uses the system event log file as the default input file. For Digital UNIX systems, the default file is /usr/adm/binary.errlog.
To produce a translated event report using the built-in defaults, use the following command:
% dia
This command produces by default, a full report directed to the terminal screen, from the input event log file /usr/adm/binary.errlog. The -a flag is understood on the command line and does not need to be entered.
See Example 3-1 for an example of a full report.
3.4.1 Selecting an Alternate Input File
To select an alternate input file for translation other than the default system event log file, use the following command:
% dia -f errlog.sys
In the above example, errlog.sys has been selected as the alternate file to be translated. You must precede the name of the input file with the -f flag.
The file must be a valid Digital UNIX file name.
3.4.2 Translating Multiple Input Files
DECevent can translate multiple input files, as shown in the following example:
% dia -f errlog.sys my_error.sys
3.4.3 Using Wildcard Characters
You may use asterisks (*) as wildcards to specify multiple input files. For example, if you wish to translate all event log files located in the directory errlog, you could \ translate errlog_1.sys, errlog_2.sys, and errlog_3.sys with one file name, err*.sys, as shown in the following example:
% dia -f err*.sys
You may also use the wildcards to translate multiple event log files in multiple directories, as shown in the following example:
% dia -f errlog.sys my_error*.sys
3.4.4 Redirecting the Report to an Output File
To redirect the translated output to a file rather than to a terminal, enter the following command.
% dia > errlog_old.rpt
In the above example, errlog_old.rpt is the output file into which the translated event information is written.
3.4.5 Reversing the Order of Input Events
To reverse the order of the input event log file being read by the DECevent utility, use the following command:
% dia -R
This command allows events contained in the default system event log file to be displayed in reverse chronological order, with the most recent events displayed first. The default is to display events in forward chronological order. Note that when the -R command is used the entry numbers in the report are listed 1-N.
Use the following command to display events contained in the event log file errorlog.sys in reverse chronological order:
% dia -R -f errorlog.sys
3.4.6 Creating a Binary Output File
This command is used to create a smaller binary event log file from a larger event log file using selection criteria. The following command creates a binary output file:
% dia -b error_sublog.bin
With this command the binary file error_sublog.bin is created from the default input system event log file. No text report output is generated.
3.5 Filtering Input Events
There are times when you do not want all the information contained in the input event log file. The include (-i) and exclude (-x) flags allow you to filter input event log files to include or exclude event information.
3.5.1 Filtering Events by Event Types
To include only certain event types in the output report, use the -i flag, as shown in the following example:
% dia -i disk=rz disk=ra92 cpu
In the above example, only the RZ[TM] disks, RA92[TM] disks, and CPU entries are included in the output report.
To exclude certain event types in the output report, use the -x flag, as shown in the following example:
% dia -x mem
In the above example, memory entries are excluded from the output report.
Appendix D shows complete listings of all selection criteria for these flags.
3.5.2 Filtering Events by Date and Time
Date and time flags allow you to filter events by date and time occurrences.
The date and time value is specified in the following format and defined in Table 3-1.
dd-mmm-yyyy[,hh:mm:ss]
Table_3-1:_Date_and_Time_Code_Definitions______________________ Time Code______Meaning________________Example_____Required__________ dd Day of month 01 yes mmm Month Jan yes yyyy Year 1994 yes hh Hours 06 no mm Minutes 35 no ss________Seconds________________08__________no________________
To select events between a certain time period on Digital UNIX systems, use the -t flag with the s and e parameters. Both the s and e parameters are needed on the command line to select events between certain time periods, as shown in the following example:
% dia -t s:15-jan-1993 e:20-jan-1993
To include events starting at a certain time for Digital UNIX systems, enter:
% dia -t s:15-jan-1993, 10:00
In the above example, the output report will include all events that occurred after the date and time indicated.
To include events before a certain time, enter the following command:
% dia -t e:15-jan-1993, 10:00
If no time is specified with a date, the default start time is midnight (00:00), and the default end time is 23:59:59.
3.5.3 Filtering Events by Entry Number
If the entry position within the event log file is known, a range of entries can be specified. In the following example, only entries 20 through 60 inclusive are translated.
% dia -e s:20 e:60
Either the s or e parameter can be omitted, but not both. If the e parameter is omitted, all entries from the starting entry indicated to the end of file are processed. If the s parameter is omitted, all events from the beginning through the end entry are processed.
3.6 Selecting Alternative Reports
The following sections describe different ways to produce reports.
3.6.1 Producing a Full Report
To produce a full report, use the -o flag with the full report type, as shown in the following example:
% dia -o full
The full report format provides a translation of all available information for each entry in the event log. The full report is the default report type and the flag does not need to be typed on the command line.
Example 3-1 shows the format of a full report.
Example 3-1: Full Report Format _______________________________________________________________________ *************************** ENTRY 1 ******************************** Logging OS 2. Digital UNIX System Architecture 2. Alpha Event sequence number 838. Timestamp of occurrence 19-OCT-1993 23:30:47 Host name alpha System type register x00000003 DEC 7000 Number of CPUs (mpnum) x00000001 CPU logging event (mperr) x00000000 Event validity 1. O/S claims event is valid Event severity 3. High Priority Entry type 103. Tape Type Errors ---- Device Profile ---- Unit 30 Product Name TA81 DSA Tape ---- MSCP Logged Msg ---- Logged Message Type Code 2. Tape Message Command Reference number x00000000 Unit Number 30. MSCP Sequence number 7. Logged Message Format 7. STI Drive Error MSCP Flags x41 Sequence Number Reset Operation Continuing MSCP Unique Controller-ID x000000000000FE01 MSCP Controller Model 1. HSC50 MSCP Controller Class 1. Mass Storage Controller class Controller SW version 40. Controller HW version 0. MSCP Unique Unit-ID x0000000000000C7B MSCP Unit Model 4. TA81 MSCP Unit Class 3. Tape class Unit SW version 0. Unit HW version 0. HSC Tape Event Code xFF6B Tape Drive Requested Error Log Multiunit code x0022 Gap count 1. Formatter SW version 17. Formatter HW version 3. TA81 SUB-SYSTEM --------------- SPEED (IPS) 25. DENSITY x04 GCR-6250 MSCP UNIT NUMBER 30. GAP COUNT 0. TRANSFER DESC BYTE 1 x07 Write error TRANSFER DESC BYTE 2 x00 TRANSFER DESC BYTE 3 x00 TRANSFER DESC BYTE 4 x00 DRIVE EXT SENSE BYTE 1 x0A Unit check Data check DRIVE EXT SENSE BYTE 2 x00 DRIVE EXT SENSE BYTE 3 x01 Device interrupt check DRIVE EXT SENSE BYTE 4 x05 Tape moved Unrecoverable DRIVE EXT SENSE BYTE 5 x89 Formatter command code DRIVE EXT SENSE BYTE 6 xA4 Start/stop mode Auto speed mode GCR mode DRIVE EXT SENSE BYTE 7 x00 DRIVE EXT SENSE BYTE 8 x00 DRIVE EXT SENSE BYTE 9 x00 DRIVE EXT SENSE BYTE 10 x00 DRIVE EXT SENSE BYTE 11 x00 DRIVE EXT SENSE BYTE 12 xC2 BOT Online Ready DRIVE EXT SENSE BYTE 13 x14 S/S mode GCR DRIVE EXT SENSE BYTE 14 x00 DRIVE EXT SENSE BYTE 15 x00 Device command code DRIVE EXT SENSE BYTE 16 xFA Device marginal condition code DRIVE EXT SENSE BYTE 17 x00 Device flt/test completion code DRIVE EXT SENSE BYTE 18 x00 Device sub-flt/test completion code DRIVE EXT SENSE BYTE 19 x00 _______________________________________________________________________
3.6.2 Producing a Brief Report
To produce a brief report, use the -o flag with the brief report type, as shown in the following example:
% dia -o brief
The brief report format provides translation of key information for each entry in the event log.
Example 3-2 shows the format for a brief report.
Example 3-2: Brief Report Format _______________________________________________________________________ *************************** ENTRY 1 ******************************** Logging OS 2. Digital UNIX System Architecture 2. Alpha Event sequence number 838. Timestamp of occurrence 19-OCT-1993 23:30:47 Host name alpha System type register x00000003 DEC 7000 Number of CPUs (mpnum) x00000001 CPU logging event (mperr) x00000000 Event validity 1. O/S claims event is valid Event severity 3. High Priority ---- Device Profile ---- Unit 30 Product Name TA81 DSA Tape Logged Message Type Code 2. Tape Message MSCP Flags x41 Sequence Number Reset Operation Continuing HSC Tape Event Code xFF6B Tape Drive Requested Error Log _______________________________________________________________________
3.6.3 Producing a Terse Report
To produce a terse report, use the -o flag with the terse report type, as shown in the following example:
% dia -o terse
The terse report format provides binary event information and displays register values and other ASCII messages in a condensed format.
Example 3-3 shows the format for a terse report.
Example 3-3: Terse Report Format _______________________________________________________________________ *************************** ENTRY 1 ******************************** Logging OS 2. System Architecture 2. Event sequence number 838. Timestamp of occurrence 1993101923304700 Host name alpha System type register x00000003 Number of CPUs (mpnum) x00000001 CPU logging event (mperr) x00000000 Event validity 1. Event severity 3. Entry type 103. ---- Device Profile ---- Unit 30 Product Name TA81 DSA Tape ---- MSCP Logged Msg ---- Logged Message Type Code 2. Command Reference number x00000000 Unit Number 30. MSCP Sequence number 7. Logged Message Format 7. MSCP Flags x41 MSCP Unique Controller-ID x00 MSCP Controller Model 1. MSCP Controller Class 1. Controller SW version 40. Controller HW version 0. MSCP Unique Unit-ID x00 MSCP Unit Model 4. MSCP Unit Class 3. Unit SW version 0. Unit HW version 0. HSC Tape Event Code xFF6B Multiunit code x0022 Gap count 1. Formatter SW version 17. Formatter HW version 3. TA81 SUB-SYSTEM --------------- SPEED (IPS) 25. DENSITY x04 MSCP UNIT NUMBER 30. GAP COUNT 0. TRANSFER DESC BYTE 1 x07 TRANSFER DESC BYTE 2 x00 TRANSFER DESC BYTE 3 x00 TRANSFER DESC BYTE 4 x00 DRIVE EXT SENSE BYTE 1 x0A DRIVE EXT SENSE BYTE 2 x00 DRIVE EXT SENSE BYTE 3 x01 DRIVE EXT SENSE BYTE 4 x05 DRIVE EXT SENSE BYTE 5 x89 DRIVE EXT SENSE BYTE 6 xA4 DRIVE EXT SENSE BYTE 7 x00 DRIVE EXT SENSE BYTE 8 x00 DRIVE EXT SENSE BYTE 9 x00 DRIVE EXT SENSE BYTE 10 x00 DRIVE EXT SENSE BYTE 11 x00 DRIVE EXT SENSE BYTE 12 xC2 DRIVE EXT SENSE BYTE 13 x14 DRIVE EXT SENSE BYTE 14 x00 DRIVE EXT SENSE BYTE 15 x00 DRIVE EXT SENSE BYTE 16 xFA DRIVE EXT SENSE BYTE 17 x00 DRIVE EXT SENSE BYTE 18 x00 DRIVE EXT SENSE BYTE 19 x00 _______________________________________________________________________
3.6.4 Producing a Summary Report
To produce a summary report, use the -o flag with the summary report type, as shown in the following example:
% dia -o summary
The summary report format provides a statistical summary of the event entries in the event log.
Example 3-4 shows the format for a summary report.
Example 3-4: Summary Report Format ___________________________________________________________________ SUMMARY OF ALL ENTRIES LOGGED ON NODE alpha unknown major class MSCP 46. SCSI 4. ___________________________________________________________________
3.7 Translating Events as They Occur
The -c flag allows events to be monitored as they occur in real time. This enables you to see the translated events immediately on the terminal, or to send translated events to an output file.
To monitor the event logger on Digital UNIX systems, enter the following command:
% dia -c
If you wish to send translated events to an output file instead of viewing the events on a terminal screen, enter the following command:
% dia -c -o brief > brief.rpt
The above command creates a brief report called brief.rpt.
Using the -o brief report type with the -c flag is strongly recommended. Using the -o summary report type with the -c flag is not allowed.
3.7.1 Halting the Continuous Display of Events
To halt the continuous display of events as they occur, enter Ctrl/C. This stops the display, and the system prompt appears on the screen.