Sun Identity Manager 8.1 System Administrator's Guide

How to Configure Tracing from the Gateway Debug Page

You can enable tracing from the Gateway Debug page (Gateway.jsp) or from the command line to debug problems with Windows accounts on Identity Manager.

Instructions are provided in the following sections:

From the Gateway Debug Page

Enable tracing from the Gateway Debug page (Gateway.jsp) if you cannot access the Gateway. You can specify and retrieve Gateway trace files from this debug page.

ProcedureTo Enable Tracing:

  1. Log in to the Identity Manager Administrator interface.

  2. Type the following URL in to your browser to open the Gateway Debug page:

    http://host :port/idm/debug/Gateway.jsp

  3. Choose a resource to trace from the Gateway Resource list.

  4. If necessary, modify existing settings.

    Click the following buttons to modify the settings:

    • Get Version. Returns the Gateway version and the operating system of the machine on which you are running the Gateway.

    • Get Trace File. Returns the contents of the trace file.

    • Get Trace Parameters. Returns the path of the trace file, the trace level, and the maximum size of the trace file.

    • Set Trace Parameters. See To Create a New Trace Configuration Object for information about these options.

    • Get Loaded Modules. Returns the load addresses of modules (DLLs) being used by the Gateway.

    The Get Loaded Modules list consists of load addresses, followed by module names and only includes loaded modules. The list does not include delay-loaded modules that have not been called.

    The Get Loaded Modules option only supports Active Directory and Domino.

From the Command Line

Enabling trace from the command line is useful if you want a wider range of options.

ProcedureTo Enable Tracing:

  1. Open a command window.

  2. Start the Gateway, specifying the necessary trace command arguments.

    The following table describes the Gateway tracing command line arguments.




    Specify the path to the trace file 


    Specify the level of tracing: 

    • Level 0. Disables tracing. (Default)

    • Level 1. Traces the flow of control between components and generally defines a low-detail trace point that includes entry and exit from high-level functional methods.

    • Level 2. Generally defines a medium-detail trace point that includes entry and exit from every method, and information and data trace points for high-level functional methods. Level 2 adds the flow of control within each component, major decision points, and items of information.

    • Level 3. Generally defines a high-detail trace point that includes entry and exit from every method, information and data trace points for high-level functional methods, and significant subroutines. Level 3 adds lower-level decision points and items of information.

    • Level 4. Generally defines a hyper-detail trace point that includes everything traced in the other trace levels. Level 4 traces at a very low level and provides a level of detail that is seldom needed but might be useful in characterizing complex behaviors of some components. NOTE: Not all components support level 4.

      Trivial methods, such as getters and setters, generally do not have entry or exit trace points because they add overhead.


    Specify the maximum trace file size in kilobytes 

    When the trace file reaches -m Kbytes, Identity Manager closes the current trace file, deletes any existing back-up files, renames the current trace file to the name specified by the -f argument with .bk appended, and opens a new trace file with the -f argument name.

    For example, if you specified -f beeble.trc on the command line, the following two files result after -m Kbytes are recorded:



    Where beeble.trc contains the most recent traces.

    Usage: gateway -f name -l -m

    For example:

    cd %WSHOME%\bin\winnt
    gateway -d -p 11319 -f %CD%\gateway.trc -l 2 -m 500

    The preceding invocation starts the Gateway with the following characteristics:

    • -d – Use regular application (not a service)

    • -p 11319 – Use port 11319

      You must configure this port for Gateway resources from the Identity Manager resource configuration. For example, for an Active Directory resource

    • -f %CD%\gateway.trc – Directory to which the trace output is written. Identity Manager writes the trace output to a text file in this directory.

    • -l 2 – Output level 2 of Gateway tracing.

    • -m – Maximum size in Kilobytes of trace log file.

    Note –

    If specified, Identity Manager saves -f, -l, and -m values in the registry, so the next time you run Gateway from the command line or as a service, the same values are used.

    Identity Manager sends the Gateway trace output to the console and to a trace file.