How to Use xTrace

The following video describes how you can use xTrace:
The following video describes how you can use xTrace:

This topic gives an overview of xTrace and how you can use it.
What is xTrace
xTrace is an XPSConfig option that captures XPS errors in Policy Store. This option is available from CA SiteMinder Release 12.51.
When to Use xTrace
Use xTrace to diagnose few failed XPS transactions in Policy Store. Use the logs to identify when and why an XPS error occurred in Policy Store.
Considerations to use xTrace
  • Enabling xTrace impacts the performance of CA SiteMinder because it logs the XPS transactions of Policy Store.
  • You can enable the most commonly used options of xTrace for tracing various SiteMinder components.
For example:
    • To trace XPS transactions, enable the option 2.
    • To trace Federation transactions, enable the option 58.
    • To gather audit logs, enable the option 1. When you enable, the following XPS audit files are created in the 
      /CA/SiteMinder/audit folder:
For example: xps-3188-20140530101643-1.access where 3188 is the PID for Policy Server. 20140530101643 is date time stamp. -1 is the increment for each type of file before rollover.
  • When you enable few options, the other related options are also enabled by default. For example:
    • Enabling the option 2 enables the other XPS related options such as 3, 5, 6, 7, 9, 16 – 21, 25, 27, 29, 31, 34 – 37, 39 – 50, 56, 57.
    • Enabling the option 58 enables the other federation related options such as 58, 59, 63, 64.
How to Enable xTrace
Perform the following steps to enable xTrace:
  1. Ensure that Profiling is enabled in Policy Server Management Console.
  2. Enable the xTrace option in XPSConfig.
Enable Profiling
Perform the following to ensure that Profiling is enabled:
  1. Open Policy Server Management Console.
  2. Click the Profiler tab.
  3. Ensure that the Enable Profiling option is selected and an output file is specified in the Output section.
  4. Click Configure Settings.
  5. Move the components whose transactions you want to monitor into Selected Components.
  6. Click Data.
  7. For a better tracing, it is a good practice to select the Date, Precise Time, PID, TID, SRC File, Function, and Message data fields.
  8. Save the changes.
Enable xTrace
Perform the following steps to enable xTrace in XPSConfig:
  1. Navigate to the bin folder in the console mode.
  2. Type xpsconfig and press Enter.
  3. Type x and press Enter.
    All the attributes of xTrace are listed. By default, none of the attributes are selected.
  4. Type the option number that you want to trace and press Enter.
  5. Synchronize the changes with Policy server, if running, to get the transaction logs.
  6. Use the update option to preserve settings between Policy Server restarts.
    xTrace is enabled and the XPS Policy Store transactions and audit files are logged.
Analyze the Logs
Use the xTrace logs to analyze and debug the XPS errors. If you need further assistance in analyzing and debugging the logs, contact CA Support.