PDGuide - Summary of Functions and Interfaces

Problem Determination Programmer's Guide
Introduction to Collecting and Managing Problem Determination Data Guide to Instrumenting Your Code Controlling FFSTProbe Calls Viewing and Analyzing Error Log Entries Analyzing Performance and Debugging Problems Using Trace Capturing and Saving Failure-Related Information through Dumps The Desktop Management Interface Summary of Functions and Interfaces Problem Determination APIs

Reprint Courtesy of International Business Machines Corporation, © International Business Machines Corporation

OS/2 Warp Version 4 provides functions, commands, graphical utilities, icons, and folders to help you collect and manage problem determination data. Here is a summary to help you understand all that is available to you, and where more information can be found about each.

The tables appear in the same order as the chapters in the book:

First Failure Support Technology
Trace
Dumps
Error Log
DMI

Most of the function described in the tables can be accessed from the systems management folder

Table2. FFST
NAME	TASKS	FOR INFORMATION
FFSTProbe function	* Logs data in Error Log * Can trigger FFST dump	Instrumenting Your Code
FFSTQueryConfiguration function	Queries FFST configuration information
FFSTSetConfiguration function	Change FFST configuration values
MKTMPF (Make Template File) command	Creates an error record template file
MRES (MultiRes Resource Compiler)	Creates message files
FFSTCONF command	Controls error data requested by the FFSTProbe function	Controlling FFSTProbe
FFST Setup icon	Accesses FFST Setup display	Controlling FFSTProbe

Table 3. Trace
NAME	TASKS	FOR INFORMATION
TRACE utility	Turns trace points on and off	Using Trace
TRACEFMT utility	Views error event trace data data
TRACEGET command	Captures contents of trace buffer to a file
TRACELOG utility	Controls logging of event trace data
TRCUST utility	Trace Customizer to create trace format file

Table 4. Dump
NAME	TASKS	FOR INFORMATION
PM Dump Facility icon	Initiates the PM Dump Facility dump formatter	Capturing Dumps

Table 5. Error Log
NAME	TASKS	FOR INFORMATION
LogOpenEventNotification function	Requests notification of when entries are put in error log	Problem Determination APIs
LogChangeEventFilter function	Changes the event notification filter
LogReadEntry function	Reads entries from the log file
LogOpenFile function	Opens a log file for reading
LogCloseFile function	Closes a log file
LogWaitEvent function	Request error notification
LogCloseEventNotification function	Closes event notification
LogFormatEntry function	Gets character strings that can be displayed when formatted.
SYSLOG (Error Log Formatter) utility	Displays the system Error Log Allows access to other FFST tools	Viewing Error Log

Table 6. DMI
NAME	FUNCTION(S)	FOR INFORMATION
DMI	Standard way and API set to define and access VPD	DMI