Collecting diagnostic information

To capture diagnostic information and write it to a file, you have to enable Data Gate on Cloud tracing. To do that, you can run a script from the OpenShift® system where the Data Gate on Cloud server container is installed, or enable tracing by using one of the stored procedures available to Data Gate on Cloud.

Procedure

To run a script from the OpenShift system where the Data Gate on Cloud server container is installed:
1. Log in to your OpenShift system by using the oc login command.
2. Open a bash shell session to your server container:
```
oc exec -it <pod name> -c data-gate-server /bin/bash 
```
  where <pod name> is the name of the Data Gate on Cloud server pod.
3. Change to /<home>/dwaadmin, where <home> is your home directory.
4. Run the following command to execute the trace enablement script:
```
./DGDiagnostics4ICP4D.sh
```
  A trace archive (zip file) is created in the /head/diagnostics directory.
5. Copy the entire trace archive directory to your local machine by running the following command:
```
oc cp <pod name>:/head/diagnostics/ <your local directory> -c data-gate-server
```
  where:
  
  <pod name>
  
  Is the name of the Data Gate on Cloud server pod.
  
  <your local directory>
  
  Is the directory on your local machine that you want to copy to.
  The trace archive is now available on your local machine. Open the zip file to analyze the diagnostic information or send the file to IBM support.

On z/OS®, you can run the SYSPROC.ACCEL_CONTROL_ACCELERATOR stored procedure to obtain trace information. Run:

CALL SYSPROC.ACCEL_CONTROL_ACCELERATOR (accelerator_name, command);

where:

accelerator_name

Is the name of the accelerator.

command

Is a placeholder for the XML command parameter. In its place, insert:

<?xml version="1.0" encoding="UTF-8" ?>
<aqt:controlCommand xmlns:aqt="http://www.ibm.com/xmlns/prod/dwa/2011" version="1.0">
   <getTraceData keepConfiguration="true">
      <content>ACCELERATOR</content>
   </getTraceData>
</aqt:controlCommand>

This subcommand returns the diagnostic data about the accelerator in the first result set generated by the stored procedure call.

This XML instructs the stored procedure to collect diagnostic information about the accelerator and the SQL engine. Optionally, you can also specify a trace data set name and the location of this data set, as in the following example:

<?xml version="1.0" encoding="UTF-8" ?>
<aqt:controlCommand xmlns:aqt="http://www.ibm.com/xmlns/prod/dwa/2011" version="1.0">
 <getTraceData outputLocation="//'XYZ.AB1234.TRACE.TGZ'">
 <content>ACCELERATOR</content>
 </getTraceData>
</aqt:controlCommand>'

The diagnostic information can also be written to a trace file in the z/OS UNIX file system. See this example:

<?xml version="1.0" encoding="UTF-8" ?>
<aqt:controlCommand xmlns:aqt="http://www.ibm.com/xmlns/prod/dwa/2011" version="1.0">
 <getTraceData outputLocation="/u/tmp/trace.tgz">
 <content>ACCELERATOR</content>
 </getTraceData>
</aqt:controlCommand>'

For more information about this stored procedure, see SYSPROC.ACCEL_CONTROL_ACCELERATOR.