PDGuide - Guide to Instrumenting Your Code

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

Code instrumentation improves problem analysis. Instrumented components of OS/2 Warp Version 4 use First Failure Support Technology (FFST) and trace. This chapter defines the required steps for instrumentation, and things you should consider before you instrument your code. This chapter also tells you what to expect when you use the FFSTProbe API and trace utility.

Planning for Instrumenting Your Code

       Defining Vital Product Data (VPD)
       Deciding How and Where to Place Calls to FFSTProbe API
           Places to Instrument 
       Deciding What Data You Want to Collect
           Error Types to Consider 
       Ways to Collect Data
           FFST Dump Data
               Process Environment Data
               System Process Status Data
               Trace Data
               User Storage Data
               Additional Error Log User Data
               FFST Dump Process Errors
               Process Dumps
               System Dumps 

Coding the FFSTProbe Functions

       Direct Calls
       Using Macros to Call the FFSTProbe Function
       Using Subroutines to Call the FFSTProbe Function 

Creating Template Files

       Why Template Files Are Important 

Defining Trace Information Format

       Creating Trace Entry Formatting Directives 

Creating DMI MIF Files

       How to Install Your Software Product 

Examples of Code when Instrumenting for FFST and Trace

       Example of an Application Program Using a Subroutine
       Creating an Error Record Template Input File
           Template File Tips 
       Message Input File Example
       MIF File Example