IBM Support

Collecting a GSKIT Trace

Technote (troubleshooting)


Problem(Abstract)

In order to debug issues involving SSL failures, it is often useful to collect a GSKIT trace.

Symptom


Version 6.x
Version 5.2




IBM Tivoli Directory Server 6.x GSKIT Trace Instructions

The following steps are applicable to both GSKit v8 and v7.

For ITDS v6.x, if you are running multiple instances you must stop all other instances before attempting to capture a GSKit trace of the instance encountering issues.

1. Enable GSKit Tracing:
    Capturing a GSKit trace is done by setting the GSK_TRACE_FILE environment variable.

    On Unix issue:
      export GSK_TRACE_FILE=filespec

    On Windows issue:
      set GSK_TRACE_FILE=filespec

    By default GSKit will fill the file filespec with about 25MB and then create filespec.1 and the fill it to about 25MB. If the trace continues, filespec is overwritten. So at most, there will be two files of 25MB each that make up the trace. The trace files are binary so if transferred by ftp be sure to use the binary transfer option. The environment variable must in place before starting the program to be traced. The program to be traced should be terminated as normal as possible. In cases of program crashes, it is helpful to also have the environment variable

    On Unix issue:
    export GSKTRACE_NOBUFFERING=YES

    On Windows issue:
    set GSKTRACE_NOBUFFERING=YES

    The trace will append to an existing file. Erasing an existing file before running to capture a trace is normally beneficial. The files filespec and filespec.1 are created by the trace if they do not already exist (assuming permissions allow creation).


    Optional Variables:

    If the issue is difficult to reproduce or varies in the time it takes for the issue to occur, you can increase the size and number of trace files generated using the following variables:

    GSK_TRACE_FILE_SIZE
    Allows you to override the default trace file size of 25MB with any desired size.

    On Unix issue:
    export GSK_TRACE_FILE_SIZE=50000000

    On Windows issue:
    set GSK_TRACE_FILE_SIZE=50000000

    GSK_TRACE_FILE_NUMBER
    Allows you to override the default number of trace files produced before cycling and overwriting.
    On Unix issue:
    export GSK_TRACE_FILE_NUMBER=5

    On Windows issue:
    set GSK_TRACE_FILE_NUMBER=5
1.1 Recreate the Problem

1.2 Send the trace files

    send: filespec
    send: filespec.1

    **Note: If GSK_TRACE_FILE_NUMBER is set, please send all generated filespec trace files generated.
1.3 Disable GSKit Tracing:

    On Unix issue:
      unset GSK_TRACE_FILE
      unset GSKTRACE_NOBUFFERING
      unset GSK_TRACE_FILE_SIZE
      unset GSK_TRACE_FILE_NUMBER
    On Windows issue:
      set GSK_TRACE_FILE=
      set GSKTRACE_NOBUFFERING=
      set GSK_TRACE_FILE_SIZE=
      set GSK_TRACE_FILE_NUMBER=

Return to top of page

IBM Tivoli Directory Server 5.2 GSKIT Trace Instructions

The following steps are applicable to GSKit v7 only.

1. Enable GSKit Tracing:
    Capturing a GSKit trace is done by setting the GSK_TRACE_FILE environment variable.

    On Unix issue:
    export GSK_TRACE_FILE=filespec

    On Windows issue:
    set GSK_TRACE_FILE=filespec

    GSkit will fill the file filespec with about 25MB and then create filespec.1 and the fill it to about 25MB. If the trace continues, filespec is overwritten. So at most, there will be two files of 25MB each that make up the trace. The trace files are binary so if transferred by ftp be sure to use the binary transfer option. The environment variable must in place before starting the program to be traced. The program to be traced shouldbe terminated as normal as possible. In cases of program crashes, it is helpful to also have the environment variable

    On Unix issue:
    export GSKTRACE_NOBUFFERING=YES

    On Windows issue:
    set GSKTRACE_NOBUFFERING=YES

    The trace will append to an existing file. Erasing an existing file before running to capture a trace is normally beneficial. The files filespec and filespec.1 are created by the trace if they do not already exist (assuming permission's allow creation).

    Optional Variables:

    If the issue is difficult to reproduce or varies in the time it takes for the issue to occur, you can increase the size and number of trace files generated using the following variables:

    GSK_TRACE_FILE_SIZE
    Allows you to override the default trace file size of 25MB with any desired size.

    On Unix issue:
    export GSK_TRACE_FILE_SIZE=50000000

    On Windows issue:
    set GSK_TRACE_FILE_SIZE=50000000

    GSK_TRACE_FILE_NUMBER
    Allows you to override the default number of trace files produced before cycling and overwriting.

    On Unix issue:
    export GSK_TRACE_FILE_NUMBER=5

    On Windows issue:
    set GSK_TRACE_FILE_NUMBER=5
1.1 Recreate the Problem

1.2 Send the trace files
    send: filespec
    send: filespec.1
    **Note: If GSK_TRACE_FILE_NUMBER is set, please send all generated filespec trace files generated.
1.3 Disable GSKit Tracing:
    On Unix issue:
    unset GSK_TRACE_FILE
    unset GSKTRACE_NOBUFFERING
    unset GSK_TRACE_FILE_SIZE
    unset GSK_TRACE_FILE_NUMBER

    On Windows issue:
    set GSK_TRACE_FILE=
    set GSKTRACE_NOBUFFERING=
    set GSK_TRACE_FILE_SIZE=
    set GSK_TRACE_FILE_NUMBER=

Return to top of page

Document information

More support for: IBM Security Directory Server
General

Software version: 5.2, 6.0, 6.1, 6.2, 6.3, 6.3.1, 6.4

Operating system(s): AIX, HP-UX, Linux, Solaris, Windows

Reference #: 1283690

Modified date: 16 March 2010


Translate this page: