Trace component details screen

The trace component details screen is used to begin tracing a component.

Table 1. Trace component details
Fields Description
Component Type Select the type of component you want to trace from one of the following:
  • API - Trace a standard API.
  • User Exit - Trace an implemented user exit.
  • Services - Trace a service created using the service builder.
  • Agents - Trace an agent.
  • Application Console - Trace the user interface layer of the Application Console.
  • Web UI framework Console - Trace the web user interface framework Console.
  • User Activity Tracking - Trace a user’s activity.
  • Health Monitor - Trace a health monitor.
  • Business Processes - Trace a business process.
  • CallOut - Trace a callout.
  • Transaction Tracing - Trace a transaction.
    When the transaction tracing is enabled in the System Management Console, it allows to set the trace level for a specific invocation of an API or service, by passing the "TransactionTracingLevel" XML attribute in the root element of the API or the service input. No trace level are required to be specified in the System Management Console for transaction tracing. Specify the trace level in the"TransactionTracingLevel" XML attribute provided in the root element of the API or the service input. The trace level is effective only for the transaction boundary of the API or service being invoked.
    Note: Once transaction tracing is enabled in the System Management Console, the trace level provided in the API or service input overrides the trace level set for the API or service or trace level set for the user who invokes the API or service.
    Note: If an invalid or blank value is provided for "TransactionTracingLevel", the system ignores it.
  • User Tracing - Trace a specific user.
    User tracing allows the system to specify a trace level for a specific user. After a trace level is configured for a user in the System Management Console, all the API or service invocations made by the user, are traced as per the trace level set for the specific user. The user ID for which tracing is being enabled must be specified as the component name.
    Note: The trace level set for the user overrides the individual trace levels set for the APIs or services which are invoked by the user.
  • RestService - Trace a REST API.
Component Name Once a component type has been selected, the available components for that type appear in the Component Name field. Select the component you want to trace from this field.

For example, health monitor agent has the following traceable components:

  • JNDICleanup
  • HealthMonitorPurge
  • AgentMonitor
  • APIMonitor
  • AppServerMonitor
  • JMSMonitor
  • HeartbeatMonitor
  • All
For RestService, the traceable component name is the relative URL path information for the REST serivce. It can also be a regular expression matching multiple REST service URLs. For example, to trace the URL “/restapi/invoke/getLocaleList” the component name should be “/invoke/getLocaleList”. Alternatively, “/invoke/.*” can be used as traceable component name, to trace all the REST service paths starting with “/invoke”.
Note: If multiple trace components are configured for type RestService, such that a rest service URL matches more than one trace components, any of the trace component may be used to evaluate the effective tracing level.
Tracel Level Select the appropriate trace level. The trace level determines what kind of additional information is output. The trace level can be one of the following:

Timer - Additional information about the time it took to complete various events. This is useful when trying to resolve performance problems to see what parts of a particular component are taking the longest to complete.

SQLDebug - Additional information about the SQL database statements that are run within the component. This is useful to find out what database statements are actually called. This information can be used to resolve performance problems or to tune your database for optimal performance.

Debug - Some additional miscellaneous information about the component. This information may be useful when trying to debug why a component is not running as expected.

Verbose - All available additional information about the component. This trace level outputs the additional information for all other trace levels in addition to any other miscellaneous information that may be available. Select this trace level to get the most information possible for a component.

Warning: Tracing a component negatively impacts the performance of that component due to the additional information that needs to be output. It is not recommended to keep a trace on for any components for an extended period of time.
Actions Description
Apply Click to start tracing the component.
Cancel Click to close the window without saving.