2.12 Viewing Identity Manager Processes

To view Identity Manage processing events, use DSTRACE. You only use this during testing and troubleshooting Identity Manager. Running DSTRACE while the drivers are in production increases the utilization on the Identity Manager server and can cause events to process very slowly.

In order to see Identity Manager processes in DSTRACE, values are added to the Driver Set and the Drive objects. You can do this in Designer and iManager.

2.12.1 Adding Trace Levels in Designer

You can add trace levels to the Driver Set object or to each Driver object.

Driver Set

  1. In an open project in Designer, select the Driver Set object in the Outline view.

    Selecting the Driver Set Object
  2. Right-click and select Properties, then click 5. Trace.

  3. Set the parameters for tracing, then click OK. See Table 2-1 for more information about the Driver Set trace parameters.

    If you set the trace level on the Driver Set object, all drivers appear in the DSTRACE logs.

Table 2-1 Driver Set Trace Parameters

Parameter

Description

Driver trace level

As the Driver object trace level increases, the amount of information displayed in DSTRACE increases.

Trace level one shows errors, but not the cause of the errors. If you want to see password synchronization information, set the trace level to five.

XSL trace level

DSTRACE displays XSL events. Only set this trace level when troubleshooting XSL style sheets. If you do not want to see XSL information, set the level to zero.

Java debug port

Allows developers to attach a Java debugger.

Java trace file

When a value is set in this field, all Java information for the Driver Set object is written to a file. The value for this field is the patch for that file.

As long as the file is specified, Java information is written to this file. If you do not need to debug Java, leave this field blank.

Trace file size limit

Allows you to set a limit for the Java trace file. If you set the file size to unlimited, the file grows in size until there is no disk space left.

NOTE:The trace file is created in multiple files.Identity Manager automatically divides the maximum file size by ten and creates ten separate files. The combined size of these files equals the maximum trace file size.

Driver

  1. In an open project in Designer, select the Driver object in the Outline view.

    Selecting the Driver Object
  2. Right-click and select Properties, then click 8. Trace.

  3. Set the parameters for tracing, then click OK. See Table 2-2 for more information about these parameters.

    If you set the parameters on the Driver object only, only information for that driver appears in the DSTRACE log.

Table 2-2 Driver Trace Parameters

Parameter

Description

Trace level

As the Driver object trace level increases, the amount of information displayed in DSTRACE increases.

Trace level one shows errors, but not the cause of the errors. If you want to see password synchronization information, set the trace level to five.

If you select Use setting from Driver Set, the value is taken from the Driver Set object.

Trace file

Specify a file name an location of where the Identity Manager information is written for the selected driver.

If you select Use setting from Driver Set, the value is taken from the Driver Set object.

Trace file size limit

Allows you to set a limit for the Java trace file. If you set the file size to unlimited, the file grows in size until there is no disk space left.

If you select Use setting from Driver Set, the value is taken from the Driver Set object.

NOTE:The trace file is created in multiple files.Identity Manager automatically divides the maximum file size by ten and creates ten separate files. The combined size of these files equals the maximum trace file size.

Trace name

The driver trace messages are prepended with the value entered instead of the driver name. Use if the driver name is very long.

2.12.2 Adding Trace Levels in iManager

You can add trace levels to the Driver Set object or to each Driver object.

Driver Set

  1. In iManager select Identity Manager > Identity Manager Overview.

  2. Browse to the Driver Set object, then click Search.

  3. Click on the Driver Set name.

    Selecting Driver Set Object
  4. Select the Misc tab for the Driver Set object.

  5. Set the parameters for tracing, then click OK. See Table 2-1 for more information about these parameters.

Driver

  1. In i Manager select Identity Manager > Identity Manager Overview.

  2. Browse to the Driver Set object where the Driver object resides, then click Search.

  3. Click the upper right corner of the Driver object, then click Edit properties.

  4. Select the Misc tab for the Driver object.

  5. Set the parameters for tracing, then click OK. See Table 2-2 for more information.

    NOTE:The option Use setting from Driver Set does not exist in iManager.

2.12.3 Capturing Identity Manager Processes to a File

To save Identity Manager processes to a file, it is saved through the parameter on the Driver object or through DSTRACE. The parameter on the Driver object is the Trace file parameter.

The following methods helps you capture and save Identity Manager processes through DSTRACE on different OS platforms.

NetWare

Use DSTRACE.NLM to display trace messages on the system console or trace messages to a file ( SYS:\SYSTEM\DSTRACE.LOG). DSTRACE.NLM displays the trace messages to a screen labeled DSTRACE Console.

  1. Type DSTRACE.NLM at the server console.

    This loads DSTRACE.NLM into memory.

  2. Type DSTRACE SCREEN ON at the server console.

    Allows trace messages to appear on the DSTRACE Console screen.

  3. Type DSTRACE FILE ON at the server console.

    Captures trace messages sent to the DSTRACE Console to the DSTRACE.LOG.

  4. Type DSTRACE -ALL at the server console.

    Turns off all trace flags.

  5. Type DSTRACE +DXML DSTRACE +DVRS at the server console.

    Displays the Identity Manager events.

  6. Type DSTRACE +TAGS DSTRACE +TIME at the server console

    Displays the message tags and timestamps.

  7. Toggle to the DSTRACE Console screen and watch for the event to pass.

  8. Toggle back to the server console.

  9. Type DSTRACE FILE OFF at the server console.

    Stops capture trace messages to the log file. It stops logging the information into the file as well.

  10. Open the DSTRACE.LOG in a text editor and search for the event or the object you modified.

Windows

  1. Open the Control Panel > NDS Services > dstrace.dlm, then click Start.

    A window opens named NDS Server Trace Utility.

  2. Select Edit > Options, then click Clear All.

    This clears all of the default flags.

  3. Select DirXML and DirXML Drivers.

  4. Click OK.

  5. Select File > New.

  6. Specify the filename and location of where you want the DSTRACE information saved, then click Open.

  7. Wait for the event to occur.

  8. Select File > Close.

    This stops the information from being written to the log file.

  9. Open the file in a text editor and search for the event or the object you modified.

UNIX

  1. Type ndstrace to start the ndstrace utility.

  2. Type set ndstrace=nodebug

    Turns off all trace flags currently set.

  3. Type set ndstrace on

    Displays trace messages to the console.

  4. Type set ndstrace file on

    Captures trace messages to the file ndstrace.log the directory where eDirectory is installed. By default it is /var/nds.

  5. Type set ndstrace=+dxml

    Displays the Identity Manager events.

  6. Type set ndstrace=+dvrs

    Displays the Identity Manager driver events.

  7. Wait for the event to occur.

  8. Type set ndstrace file off

    This stops the logging of information to the file.

  9. Type exit to quite the ndstrace utility.

  10. Open the file in a text editor. Search for the event or the object that was modified.

iMonitor

iMonitor allows you to get DSTRACE information from a web browser. It does not matter where Identity Manager is running. These are the files that run iMonitor:

  • NDSIMON.NLM Runs on NetWare.

  • NDSIMON.DLM Runs on Windows.

  • ndsimonitor Runs on UNIX.

  1. Access iMonitor from http:// server_ip:8008/nds.

    The port of 8008 is the default port.

  2. Enter in a user name and password with administrative rights, the click Login.

  3. Select Trace Configuration on the left side.

  4. Click Clear All.

  5. Select DirXML and DirXML Drivers.

  6. Click Trace On.

  7. Select Trace History on the left side.

  8. Click the document with the Modification Time of Current to see a live trace.

  9. Change the Refresh Interval if you want to see information more often.

  10. Select Trace Configuration on the left side, then click Trace Off to turn the tracing off.

  11. You can view the trace history by selecting Trace History. The files are distinguished by their timestamp.

If you need a copy of the HTML file, the default location is:

  • NetWare: SYS:\SYSTEM\ndsimon\DSTRACE*.htm

  • Windows: Drive_letter:\Novell\NDS\ndsimon\dstrace\*.htm

  • UNIX: /var/nds/dstrace/*.htm