Logtool Utility External Reference Specification Support Tool Manager (STM) Hewlett-Packard Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Legal Notices The information in this document is subject to change without notice. Hewlett-Packard makes no warranty of any kind with regard to this manual, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Legal Notices................................................................................................................... 1 1. Product Identification ................................................................................................. 4 1.1. Product Name.............................................................................................. 4 1.2. Document Change History ............................................................
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Appendix A - Log Entry Formats.................................................................................... 41 I/O Error Entry .................................................................................................... 42 LPMC Entry ........................................................................................................ 42 System Overtemp Entry .................................................................................
Hewlett-Packard STM: Logtool ERS * Revision 1.17 1. Product Identification 1.1. Product Name This project is known internally as STM. This document describes the external specifications for the LOGTOOL utility. 1.2. Document Change History Revision 1.00 - 4/15/94 First Publication Revision 1.1 - 4/19/94 Numerous changes made to reflect the evolving design of STM logging. Added appendices with formats of each log entry type and the logger configuration file. Revision 1.
Hewlett-Packard Revision 1.10- 07/21/97 STM: Logtool ERS * Revision 1.17 Made changes to incorporate selection of current raw log file as default. Made changes where appropriate for logtool “shortcut” commands. (Introduced in Logtool Version 2.0.) Revision 1.11– 10/29/97 Reformatted to make customers. document suitable for HP Revision 1.12– 11/26/97 Made changes to incorporate multiple file selection capability. (Introduced in Logtool Version 3.0.) Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 2. Functional Overview 2.1. Tool Strategy Logtool is an interactive utility that runs on the STM platform, providing users with access to the system log files. Logtool has four main command categories: File, View, Filters and Memory. The File commands allow the user to select log files, switch log files, or exit (i.e., quit) Logtool. The View commands display summary data on selected log files or the contents of the logs.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 2.2. Operational Overview Utilities are invoked via the Utilities sub-menu under the Tools menu in the STM User Interface. Selection of this command will cause a cascade menu to be displayed with the names of all of the utility programs that are currently installed. The user should select the "Logtool" entry to invoke this tool. 2.3. User Perspectives 2.3.1. Utility Options The figure below shows the options that are available for utilities.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 entry consists of a header that is generated by Logtool and a series of language localized message descriptors that are generated by log decoding programs associated with each logging entity (e.g. i/o driver) or entry type (e.g. lpmc entry). The contents of the formatted log can then be displayed to the user by retrieving message text from catalogs associated with each message specifier and displaying it.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Since it is possible for there to be a large amount of data in a given log file or series of log files, Logtool gives the user a set of formatting and display filters that enable the user to select only those log entries that are of interest for formatting or viewing.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 In addition to the various filters implemented by Logtool, the STM Logger process also has the capability to filter log data based on certain criteria. This enables the user to "turn off" logging of entries that are of no interest. Entries that are filtered out via the logger process are discarded and not placed in the raw log file, thus saving disk space. This filter can be modified by editing the logger configuration file.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Although the examples in this document focus on I/O error entries, which are expected to be the most prevalent, the principles of each example apply to the other entry types as well. 2.7. Operational Overview All of the Logtool commands can be invoked via: a GUI interface, a menu interface, or a command line interface. In all cases, the user is presented with four categories of commands.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 3. User Interface Logtool commands allow the user to easily search a computer system’s I/O and memory error log files. The User Interface is designed with usability as a foremost concern which means it strives to be as intuitive as possible while also providing as much capability as possible. 3.1. Logtool Commands In an effort to keep Logtool simple for the user, only four command categories (called menus) exist.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 3.2. Logtool Main Window When Logtool is first invoked from the Utility menu of the STM User Interface, the main command window is displayed. This window contains a set of command menus through which the user selects operations for Logtool to perform. The contents of these menus were discussed in the previous section. This screen also provides a scrolling information area where Logtool can display informational messages to the user.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 3.3. Typical Logtool Usage A typical Logtool session could consist of the following activities: • View a summary of a raw log file on the system and determine if any entries have been logged that are of interest. • If the raw log summary indicates that there are some entries of interest: • Set up a format filter which will filter out all entries except for those of interest. • Format the raw log file(s). • Display the formatted log file.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4. Detailed Command Descriptions 4.1. Commands within the File Menu 4.1.1. Select Raw This command displays the names of the raw log files that are currently on the system and allows the user to select one or more of them for viewing, filtering or formatting. The initial file filter is set to the default location and naming convention for raw log files and the default file selection defaults to the current raw logfile, if there is one.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 If the user wishes to exit this command without selecting a file, the Cancel button which will take the user back to the main menu screen should be selected. Clicking on the Help button will provide help on how to perform a file selection.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.1.2. Format Raw This command is used to format any raw log files that were previously selected via the Select Raw command under the File menu. If no files were selected, the current raw log file, if there is one, is used as the default. Depending on how much data is in the selected files, the Format Raw command may take several minutes to complete.
Hewlett-Packard STM: Logtool ERS - Page 18 - * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.1.3. Select Formatted This command displays the names of the formatted log files that are currently in the default log directory on the system and allows the user to select one or more of them for viewing or filtering. The initial filter will be set to the default location for formatted log files. Users can specify a file from the files list presented or they can optionally specify a file of their own choosing.
Hewlett-Packard STM: Logtool ERS - Page 20 - * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.1.4. Switch Log This command causes the STM logger to open a new current log file. It may be desirable to issue this command occasionally in order to keep individual log files from becoming larger than what is desirable. The new log file that is created by the logger process will be named according to the standard naming convention with the number incremented by one. Thus, if the current log file is called log5.raw.cur, the new one will be called log6.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.2. Commands within the View Menu 4.2.1. Raw Summary This command displays a summary of the currently selected raw log file or files. If a file was not selected via the Select Raw command under the File menu, then the current raw log file, if there is one, is used as the default. The summary is a report of the total number of each entry type that occurs in the file.
Hewlett-Packard STM: Logtool ERS - Page 23 - * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.2.2. Raw Log This command displays the contents of all the raw log files selected with the Select Raw command under the File menu If no files were selected, the current raw log file, if there is one, is used as the default. Each entry consists of a header and data. The header content is architected for all entries. The format of the data portion is not architected and is under complete control of the logging entity (e.g. I/O drivers).
Hewlett-Packard STM: Logtool ERS - Page 25 - * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.2.3. Formatted Summary This command displays a summary of the currently selected formatted log file or files. If a file was not selected via the Select Formatted command under the File menu, then the current raw log file, if there is one, is used as the default. The summary is a report of the total number of each entry type that occurs in the file.
Hewlett-Packard STM: Logtool ERS - Page 27 - * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.2.4. Formatted Log This command displays the formatted log data that was generated by the Format Raw command under the File menu. If a file was not selected via the Select Formatted command under the File menu, then the current raw log file, if there is one, is used as the default. This default file is then automatically formatted and that formatted log is displayed.
Hewlett-Packard STM: Logtool ERS - Page 29 - * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.3. Commands within the Filters Menu 4.3.1. Format This command is used to select the filter that will be used by Logtool to select which entries in the selected raw log file(s) to format. In order to set the filter, the user should first select a raw log file or files via the Select Raw command under the File menu. If a file was not selected in this way then the current raw log file, if there is one, is used as the default.
Hewlett-Packard STM: Logtool ERS * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.3.2. Display --> Raw This command is used to select the filter criteria that will be used by Logtool to select which entries in the raw log file to display. In order to set the filter, the user should first select a raw log file or files via the Select Raw command under the File menu. If a file was not selected in this way then the current raw log file, if there is one, is used as the default.
Hewlett-Packard STM: Logtool ERS * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.3.3. Display --> Formatted This command is used to select the filter criteria that will be used by Logtool to select which entries in the formatted log file to display. In order to set the filter, there must be a currently active selected formatted file.
Hewlett-Packard STM: Logtool ERS * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.4. Commands within the Memory Menu 4.4.1. Clear Log This command allows the user to clear the memory log file. The user is cautioned that performing this operation will result in the loss of any data that was in the memory log file. It is recommended that the user run the Memory Log-->Detail command to verify that any data in the file is no longer needed. 4.4.2.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 4.4.4. Report Log-->View Detail This command allows the user to view the entire contents of the memory error log file. The memory log file will be formatted and then displayed to the user. Depending on how many entries are in the file, this may take a few minutes. A dialog box is displayed to the user telling them how many entries are in the file. At this point they may either cancel the operation or continue with the format and display of the file.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Appendix A - Log Entry Formats There are several architected log entry formats that Logtool handles. For each entry, there is a header portion that is architected. Additionally, each entry has a data portion which is not architected. Logtool processes, formats, and displays the header fields and decoding programs are used to handle the data portion.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 I/O Error Entry I/O error entries are logged by I/O system drivers and typically contain information concerning exception conditions that the driver encountered. The header for this entry contains the following fields: Entry Length The total length of the entry including the header. Entry Type The type of entry. The value for I/O error entries is 1.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Entry Index The entry index is used in combination with the entry time stamp to build the entry ID for this error event. Entry Version The entry version indicates the version of the header for the type of log entry this is. Time Stamp The date/time that the logger process logged this entry. Hversion Hversion of the main processor. Data Length The total length of the data portion of this entry.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Entry Version The entry version indicates the version of the header for the type of log entry this is. Time Stamp The date/time that the logger process logged this entry. Data Length The total length of the data portion of this entry. Logger Entry This entry is logged by the logger process.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 Appendix B - Logger Configuration File The STM Logger process utilizes a configuration file to allow the user to tailor its operation. This file, called diaglogd.cfg, is automatically checked by the logger process before each log entry is processed. If the file has changed, logger will read it and reconfigure itself according to the settings in the file.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 the FIFO file will be created. Both fifo_name and prog_name must be fully qualified. The entry will still be logged as usual by the STM logger. exec-path device_path prog_name exec | no-exec [fifo_name] If exec, executes a specified program when an I/O error entry for a particular device is logged. If fifo_name is given, passes it the raw log entry entry via the specified FIFO file. If no-exec, just passes the raw log entry via the specified FIFO file.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 disk-threshold nn The % of disk space usage which, if exceeded, will result in logging being suspended until the usage drops back below this number. The default (i.e. if this directive does not appear in the configuration file) will be 95%. rate-threshold nn The rate of logging, in number of entries per minute, which if exceeded, will result in logging being suspended until the rate drops back below this number.
Hewlett-Packard STM: Logtool ERS * Revision 1.17 exec-prod HPC35450A /usr/sbin/tape_prog no-exec /var/tape_fifo passes the raw log entry for entries for product HPC35450A thru the FIFO file /var/tape_fifo. exec_logger tape2 /usr/sbin/tape_prog no-exec /var/tape_fifo passes the raw log entry for entries for the tape2 driver thru the FIFO file /var/tape_fifo. disk-threshold 80 suspends logging if disk space usage exceeds 80%. rate-threshold 20 suspends logging if the rate exceeds 20 entries/minute.
