Saving trace information

The Save Trace function saves the collected trace information. In the Save Trace window, which opens before the action is completed, you can specify or change the settings for the save operation.

About this task

You can specify or change the location of the trace file on your local system. The Save Trace window also allows you to include or exclude certain information from the bulk of information that was collected as a result of using a particular profile. You can also choose to add the Eclipse error log to the trace file, since the information in the Eclipse error log is not generated by means of an IBM Db2 Analytics Accelerator trace profile. Moreover, you can send trace information to IBM using the file transfer protocol (FTP) to the effect that the trace information is added to an existing support case.

Using the Save Trace function invokes the SYSPROC.ACCEL_CONTROL_ACCELERATOR stored procedure on your data server. For information about the privileges that are required to run this procedure and further details, follow the appropriate Related reference link at the end of this topic.

Procedure

  1. Connect to the Db2 subsystem or data sharing group that the accelerator is attached to. For more information, see Connecting to a database server.
  2. Select the accelerator. For more information, see Selecting an accelerator.
  3. Open the Save Trace window:
    IBM Db2 Analytics Accelerator Studio In the header section at the top of the Accelerator view, click Save.
    IBM Data Server Manager In the lower half of the Accelerator view, click Save.
    IBM Unified Experience for z/OS®
    1. From the Accelerator actions drop-down button on the upper right of the window, select Manage trace.
    2. Click the Save trace tab.
    IBM Db2 Analytics Accelerator Administration Services
    1. Start a /trace/receiveTrace request.
    2. In the request body, specify:
      • The connection name
      • The accelerator name
      • Other profile parameters as needed. These parameters determine which of the parts of the collected information to include in the zip file.
  4. Select the information that you want to store in the trace file.
    Accelerator
    Log and trace information produced by components running inside Docker container (mainly IBM Db2 Analytics Accelerator and SQL engine). This includes, for example: accelerator logs, SQL engine logs, system logs of the Docker container.
    Note: When you open the Save Trace window from the context menu of the Accelerators folder rather than from the header of the Accelerator view, the Accelerator check box is inactive. The reason is that selecting the entire Accelerators folder does not allow you to specify or select the particular accelerator in whose trace information you are interested. The Save Trace menu choice on the context menu of the Accelerators folder is a kind of “last rescue” option. Without it, there would be no way to submit trace information to IBM in case an error prevented the proper listing of the accelerators in the right pane (accelerators view). If such an error occurs, you have no access to the Save Trace function for individual accelerators.
    Appliance
    Trace information from the IBM Integrated Analytics System on which IBM Db2 Analytics Accelerator and the SQL engine run.
    Note: Similar traces can be obtained for Db2 Analytics Accelerator on Z. To this end, however, you must log in to the Admin UI of the Secure Service Container LPAR and create a dump. See Creating a trace file (dump)

    The Appliance option described here is only for IBM Db2 Analytics Accelerator on an IBM Integrated Analytics System.

    Stored procedure trace information
    Trace information that is collected while running stored procedures of IBM Db2 Analytics Accelerator for z/OS, as the result of using a particular profile for stored-procedure tracing in the Configure Trace window. Using the check box, you can include or exclude this information from the trace file to be saved.
    Eclipse error log
    Error information that is collected by the Eclipse framework, on which the foundation for IBM Db2 Analytics Accelerator Studio, IBM Data Studio, is built. Hence this information does not pertain to errors in IBM Db2 Analytics Accelerator for z/OS, but to its software environment.
    Manually collected diagnostic information
    Query-related Db2 support documents and CDE performance data (CDE stands for columnar data engine).
  5. Where to save the trace file:
    IBM Db2 Analytics Accelerator Studio Under the heading Save to local file system, in the Folder field, type the location of the trace file (full directory path) on your local system.

    Alternatively, you can click Browse to select a folder.
    IBM Data Server Manager The trace information will be exported in a zip file to the default download directory in the local file system of the network server on which IBM Data Server Manager is installed. You cannot change this.
    IBM Unified Experience for z/OS The trace information will be exported in a zip file to the default download directory in the local file system of the network server on which IBM Unified Experience for z/OS is installed. You cannot change this.
    IBM Db2 Analytics Accelerator Administration Services The trace information will be exported in a zip file to the default download directory in the local file system of the network server on which IBM Db2 Analytics Accelerator Administration Services is installed. You cannot change this.
  6. To add the trace information to a support case:
    IBM Db2 Analytics Accelerator Studio
    1. Select Add trace information to IBM problem management record (PMR) using FTP to add the selected information to an existing support case.
    2. In the fields next to PMR number, type the identification number of the support case.
    3. In the FTP password field, type the password for logging on to the IBM RETAIN server on which the support case was opened.
      Note: Most IBM FTP servers for support cases accept the registered email address as the password.

    The currently selected server is displayed in square brackets in the text above the Password field.

    To change the server or the proxy settings required to access the server, select Window > Preferences > IBM Db2 Analytics Accelerator for z/OS > Save Trace Dialog from the IBM Data Studio main menu.
    IBM Data Server Manager
    1. Select Associate the trace file with the following support case.
    2. In the Support case ID field, type the support case ID (number) of the support case.
    IBM Unified Experience for z/OS
    1. Select Associate/upload the trace file with the following support case.
    2. In the Support case ID field, type the support case ID (number) of the support case.
    3. In the Transfer ID field, enter your transfer ID. To create a transfer ID, go to this website: https://www.secure.ecurep.ibm.com/transferids/.

      You need your IBM ID to log in.

    4. In the Password field, enter the password that belongs to your transfer ID.
    IBM Db2 Analytics Accelerator Administration Services In the request body, specify the following parameters:
    "ftpChoosen":
    Set this parameter to true.
    "caseID":
    The support case number.
    "userID"
    Your transfer ID.
    "password":
    The password belonging to the transfer ID.
  7. To reset your choices:
    IBM Db2 Analytics Accelerator Studio If you want to reset your choices in the Save Trace window to make corrections or start over, click Restore Defaults.
    IBM Data Server Manager
    1. Click Cancel.
    2. Reopen the Save Trace window by clicking Save again from the Accelerator view.
    IBM Unified Experience for z/OS Click the Reset button.
    IBM Db2 Analytics Accelerator Administration Services N/A
    Note: This option just undoes all of your recent actions in the Save Trace window. It does not reset profiles and affects your current settings rather than future settings. Compare this with the description of the Reset configuration profiles to default after collecting traces check box (see next step).
  8. To revoke all individual settings and in a future run save just the information that is selected by using the default trace profiles, you can select an additional option. This prevents that verbose trace information consumes too much space on your hard disks. If you want to retain your individual settings after saving them once, clear the check box or leave it deselected (default).
    IBM Db2 Analytics Accelerator Studio Select Reset configuration profiles to default after collecting traces.
    IBM Data Server Manager Select Reset configuration profiles to default after collecting traces.
    IBM Unified Experience for z/OS Select Reset configuration profiles to default after collecting traces.
    IBM Db2 Analytics Accelerator Administration Services In the request body, set the "resetConfig": parameter to true.
  9. Save your settings:
    IBM Db2 Analytics Accelerator Studio Click OK.
    IBM Data Server Manager Click Save.
    IBM Unified Experience for z/OS Click Save trace.
    IBM Db2 Analytics Accelerator Administration Services Click Execute.