|
|
|
Performing a Trace in EXTRA! X-treme
Technical Note 2249
Last Reviewed 27-Jun-2008
Applies To
EXTRA! X-treme version 9.0
Summary
Technical Note 2249
Last Reviewed 27-Jun-2008
Applies To
EXTRA! X-treme version 9.0
Summary
When troubleshooting a problem in EXTRA! X-treme, you obtain one or more traces. This technical note describes how to generate an API trace, communications trace, or secure connection socket trace.
This technical note contains the following sections:
API Trace
If you have an application that makes API calls to EXTRA!, such as using HLLAPI, and your application is not working properly, you can capture the API calls and return codes for debugging purposes. (For API code examples and test code, see Technical Note 2164.)
- Close your API application(s).
- Launch the Status application from the Start menu (click Attachmate EXTRA! X-treme > Status App).
- Click the API Trace tab.
- Click Options > Settings. In the API Trace Options dialog, enable the API(s) your application uses, such as IBM EHLLAPI, and click OK.
Note: API Trace does not support COM (OLE Automation) calls.
- Click the Record (triangle) toolbar button.
- Run your application that makes the API calls.
Note: For HLLAPI, you must already have HLLAPI short name(s) assigned to .edp session(s) in EXTRA! X-treme (Options > Global Preferences > Advanced).
The Status application displays the API activity (date, time, API type, and function name) with separate rows for the call and return. When a row is double-clicked, the Details pane displays parameter names, data types, and values.
- After the problem has been reproduced, go back to the Status application. Click the Stop (square) toolbar button.
- Save the trace file (with .log extension). You can later re-open the trace file in the Status application to view it again, or provide the trace file to Technical Support if necessary.
Note: The trace file is stored in binary format, so cannot be viewed in a text editor.
Communications Trace
To capture a communications trace, follow these steps:
- Close EXTRA! X-treme if it is running.
- Launch the Status application from the Start menu (click Attachmate EXTRA! X-treme > Status App).
- Click the Communications Trace tab.
- Click File > Open and open the session .edp file that you want to trace.
- To start the trace, click the Record (triangle) toolbar button. The red circle should turn green and begin to rotate.
- Start EXTRA! X-treme and open the same session .edp file from step 4 above. Note that, in the Status application, the value in the Events column should increment as the connection progresses.
- When the problem has been reproduced, go back to the Status application. Stop and save the communications trace file (with .trc extension).
- Provide the saved trace file to Technical Support. If you are an authorized support contact on a current maintenance plan, you can attach the file to your service request at http://mysupport.attachmate.com/go.aspx?l=srlist. Otherwise, use http://upload.attachmate.com/.
Secure Connection Socket Trace
Beginning with version 9.0 Service Pack 1 (SP1), detailed tracing is available to diagnose secure connection problems at the socket level. To enable this level of tracing, you must edit the session .edp file.
- Open the session .edp file in a text editor.
- In the [Connection] section of the session file, add the RSCTraceLevel setting. For example:
[Connection]RSCTraceLevel=3The following RSCTraceLevel values are supported:
0: Tracing is off. This may be used to optimize performance.
1: Trace errors only. This is the default setting.
2: Trace errors and warnings.
3: Trace everything. Use for diagnosing failing secure connections.
1: Trace errors only. This is the default setting.
2: Trace errors and warnings.
3: Trace everything. Use for diagnosing failing secure connections.
- Connection trace events are written to the AomAudit.slg (Audit Log) file in your EXTRA! session folder and to the Windows system event log. (You can prevent this data from being written to the Windows system event log by checking “Disable event logging” in EXTRA! X-treme: click Options > Global Preferences.)
- After the connection issue has been reproduced, restore normal performance by removing the RSCTraceLevel line from the session .edp file.
The Audit Log events can be viewed in the Status application (Audit Log tab). Provide the AomAudit.slg file to Technical Support.
