Configuration Tool Online Help

[ Bottom of Page | Previous Page | Next Page | Table of Contents | Index ]


Trace Settings

Partial Table-of-Contents

  • Trace Settings
  • Gateway trace file
  • Gateway trace file wrap size (KB)
  • Client trace file
  • Client trace file wrap size (KB)
  • Help on starting JNI trace
  • This panel contains settings for tracing CICS® Transaction Gateway.


    Trace Settings

    Select check boxes to specify the Gateway daemon and Client daemon components to trace when tracing is enabled.

    Enable Gateway daemon trace and select all Client trace components
    Enable Gateway daemon trace and select all Client daemon components.
    Client API level 1
    The client API layer (level 1).
    Client API level 2
    The client API layer (level 1 and 2).
    CICSCLI command line
    The cicscli command interface.
    CICSTERM and CICSPRINT
    cicsterm and cicsprnt emulators.
    CPP classes
    The C++ class libraries.
    Client daemon
    The Client daemon.
    Transport layer level 1
    Interprocess communication. This traces the internal interprocess transport between Client processes. Use it if entries in the Client log refer to functions such as FaarqStart, FaarqStop.
    Transport layer level 2
    Interprocess communication. This traces the internal interprocess transport between Client processes. Use it if entries in the Client log refer to functions such as FaarqGetMsg, FaarqPutMsg. This is the most verbose tracing component.
    Enable Gateway daemon trace on startup
    The CICS Transaction Gateway.
    Help on starting JNI trace
    Click the button to get help on JNI trace.
    Protocol drivers level 1
    Protocol drivers (for example, TCP). This traces data sent and received and provides supplementary information about failures.
    Protocol drivers level 2
    This traces internal flows through the protocol drivers and interactions with other software components. This enhanced tracking level currently has the same functionality as level 1.
    Workload manager
    The Workload Manager.

    You can also use the -m parameter of the cicscli command to specify trace components (excluding the Gateway daemon). This overrides any settings in the configuration file.

    If you enable tracing without specifying the components in either the cicscli command or in ctg.ini, a default set of components is traced:

    Selecting any of the check boxes in the Configuration Tool overrides the default set of components.


    Gateway trace file

    This is the path name of the trace file where Gateway trace messages are written if tracing is enabled.

    If you do not complete this field,
    On Windows: the default name is cicstg.trc.
    On UNIX: the trace is written to stderr.

    When the filename parameter is defined without a directory the log file is created in the:
    On Windows: "IBM\CICS Transaction Gateway" subdirectory, that exists in the Windows common application data directory.
    On UNIX:
    /opt/IBM/cicstg/bin directory.
    On Linux:
    /opt/ibm/cicstg/bin directory.

    UNIX® and Linux®: <install_path>/bin
    Windows®: <product_data_path>\bin

    UNIX® and Linux®: You can also specify a trace file using the tfile option on the ctgstart command.

    The trace file is overwritten (not appended to) each time the CICS Transaction Gateway starts.


    Gateway trace file wrap size (KB)

    This value specifies the size in kilobytes to which the gateway trace file will grow. Once the file reaches this size, subsequent trace entries continue to be written from the beginning of the file.

    Enter a value in the range 0 through 1,000,000.

    Client trace file

    If tracing is enabled you can name the trace file to which Client trace messages will be written or use the default name, cicscli.bin

    You do not have to enter an extension for the file name, because a file of type .BIN is always generated (or .WRP if the trace file wraps).

    When the trace name parameter is defined without a directory the trace file is created in the:
    On Windows: "IBM\CICS Transaction Gateway" subdirectory, that exists in the Windows common application data directory.
    On UNIX and Linux: /var/cicscli directory.

    To minimize any performance impact, the trace file is written out in binary format. To read it, convert the file to ASCII using the cicsftrc command.


    Client trace file wrap size (KB)

    If you use the memory mapped tracing option (cicscli -b), the size of the trace files is determined by this field, which specifies the total amount of space in KB reserved for trace data files.

    Enter a value in the range 0 through 2,000,000.

    Subsequent trace entries will continue to be written from the beginning of the file. Client trace file wrap size (KB) must be greater than 0 if memory mapped tracing is to be used; the default value of 0 disables wrapping. If its value is between 1 and 99, a value of 100 is used instead to guarantee an adequate minimum trace size.

    Help on starting JNI trace

    On Windows:

    Use ctgservice to enable JNI trace for the start up of CICS Transaction Gateway, or by setting environment variables when starting an application in local mode.

    Use one of the following methods to enable JNI trace:

    You cannot enable JNI trace through the Configuration Tool.


    On UNIX and Linux:

    Enable JNI trace by setting environment variables, or by using a ctgstart override, or when starting an application in local mode.

    Use one of the following methods to enable JNI trace:

    • While CICS Transaction Gateway is running, use the system administration functions to enter the following command:
      ctgadmin -a trace -jnilevel=1 -jnifile=filename
    • When you start CICS Transaction Gateway, issue the command:
      ctgstart -j-Dgateway.T.setJNITFile=filename
      where filename is the name of the file to which trace output is to be sent. If you do not specify a full path to the file, the location is <install_path>/bin.
    • Set the following environment variables before you start CICS Transaction Gateway or Java Client applications running in local mode:
      CTG_JNI_TRACE
      Use this environment variable to set the name of the JNI trace file. This environment variable only defines the name of the JNI trace file; it does not enable trace. JNI trace is output as plain text, and there is no requirement to use a particular extension for the file name.
      CTG_JNI_TRACE_ON
      Set this environment variable to YES (case-insensitive) to enable JNI trace when CICS Transaction Gateway or Java Client application is started.
    • For Java Client applications running in local mode, use Java to launch your application and set the system property gateway.T.setJNITFile, as shown in the following example:
      java -Dgateway.T.setJNITFile=filename application
      where
      • filename is the name of the file to which trace output is to be sent
      • application is the application to launch

    You cannot enable JNI trace through the Configuration Tool.


    [ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

    (C) Copyright IBM Corporation, 1999, 2010. All rights reserved. Legal