Diagnostics

This document describes the types of general and specialized trace options available to you for problem analysis. The following types of traces are created:

  • CICS application (AP) tracing - via ENTER TRACENUM;

  • CICS exception tracing.

The following topics are covered:


Trace Activation

Both of the following conditions must be true for TRACE to be activated:

  • The CXGMCONN macro parameter TRACE must be set to YES.

  • CICS tracing must be enabled (for example, via the CICS transaction CETR).

Important:
The CXGMCONN macro parameter setting TRACE=NO can be used to optimize performance. This setting prohibits the creation of trace entries by jumping over the associated code segments. The UQAD administration transaction can be used to setTRACE=YES when and if it is required.

Trace Points

Trace entries are produced using an EXEC CICS ENTER TRACENUM call.

Trace points are entered in the AP domain and are restricted to a range of values from 0 through 199. They are configured using the TRACELEVEL1 and TRACELEVEL2 parameters of the CXGMCONN macro (for more information, read CXGMCONN Macro.

  • Assigning a value of 0 (zero) forces the use of unique trace points, which are documented in Trace Points.

  • Assigning a value greater than 0 causes the trace points to be mapped.

Trace points are mapped as follows:

  • TRACELEVEL1 is used to issue Level-1 trace entries for the RI and RA components and for exception tracing.

  • TRACELEVEL2 is used to issue Level-2 trace entries for the RI and RA.

A list of the trace points that can occur is provided in Trace Points.

Trace Levels

Trace entries are produced for Level-1 and Level-2, as documented in Trace Points.

Components

The following component abbreviations can be used to control the trace that is produced.

Code Component Name Origin/Module
RI Resource manager interface (RMI) RMI – EX1, CS, TM, CC, IN0, SD0 and EX2
RA Resource manager adapters RA – CXX, NSERV

Important:
Component abbreviations can only be used to control the creation of trace entries. They cannot be used later to evaluate the trace output, as the entries are produced in the AP domain.

Resource IDs

For trace entries produced using the EXEC CICS ENTER TRACENUM application call, the resource ID is unique and has the following layout:

graphics/diag_resourceID.png

These resource ID components are described in the remainder of this section.

Module Identifier

The module identifier is the last two bytes of the module name.

Event Identifiers

One of the following event identifiers may appear:

Identifier Type Notes
ENTx Module Entry (Component Trace: RI or RA)
EXIx Module Exit (Component Trace: RI or RA)

Function Identifiers

The following function identifiers may appear:

Function Identifier Description
ABND Transaction dump request
ACON ABEND Not connected
COMM COMMIT failed
CONM (CONNECT)
CRED Get credentials failed
CTXT Exit CTXT request
DCON (DISCONNECT)
DDLB Delete list directory buffer
DMPX Transaction dump ID
DMPX Transaction dump request failed
EAPI API request failed (LINK)
EBSB Rebuild session buffer failed
ECFG CFG definitions invalid
ECON Not connected to server
ECSB CSB create/chain failed
ECSB Create CSB failed
ECSB Invalid public key
EDF Exit EDF request
EERR Unexpected error
EFNC Function failed
EFRE Freemain failed
EGER Getmain failed
EGWA Invalid initparm (GWA)
ELEN Length
EMSG Force console message
ENTA Entry
EOTR Terminate session failed
ERID Create resource ID failed
ERTR Retrieve
ESCN Error during syncpoint - CONNECT
ESD0 Rejected – RMI disabled
ESD1 Rejected – shutdown in progress
ESES Create session failed
ESET Setup
ESTF Start service task failed
ESWT Create SYNCWAIT RECOVERY entry failed
ETCB Invalid TCB
ETIE No TIE
EUER Unexpected condition
EXI1 Exit - level 1
EXI2 Exit - level 2
EXTR Extract
FCFG Create resource ID failed
EFCSB Disconnect (de-establish) session failed
FCSB Establish session railed
FCSB List session failed
FCSB Modify session failed
FGND Directory list failed
FNEW Create new entry failed
FRCI Function failed
FRCR Create recovery entry failed
FRCY Restore in-doubt session failed
FREE FREEMAIN failed
FRSY RESYNC failed
FSYN Syncpoint failed (COMMIT)
FSYN Syncpoint failed (ROLLBACK)
FUOW UOWLINK failed
GDIA GET DIAGNOSTICS failed
GETC Request CSB length failed
GETM GETMAIN failed
GIPA Request TCP address
GNDE Request directory entries
GRCI Request RCI identification
GSBL Request Buffer length
ICSB Invalid CSB
IFNC Invalid function
IRCE Recovery entry failed
IRCY Recovery session failed
ISYN Invalid syncpoint
MNDE Modify directory entry
RBCK ROLLBACK failed
RNSV Register with server
SPI Exit SPI request
SYNC Exit SYNC request
TASK Exit TASK request
TERM Exit TERM request
TFGP Invalid UERTFGP
TFID Invalid UERTFID
TNUM TRACENUM failed
UNSV De-register with server
WTOC Write message to console failed
WTOQ Write message to TDQ failed
XAPI About to issue API request
XAPI Return from API request
XTRC Server trace request failed

Trace Points

Trace points are described in Trace Points.