IBM Support

How to use Data Virtualization Manager (DVM) ODBC debug driver

Troubleshooting


Problem

When needing to diagnose Data Virtualization Manager (DVM) Driver issues, how can the DVM ODBC driver provide ODBC API driver diagnostics?

Symptom

ODBC application encounters driver errors or unknown ODBC application issues.

Resolving The Problem

DVM Debug Driver Configuration Steps for turning on DVM ODBC driver logging:
On Windows
  1. Create a Data Virtualization Manager (DVM) Debug ODBC data source using the 'Data Virtualization Manager Debug Driver 3.x' ODBC driver
  2. Use the same ODBC data source settings as on your original ODBC data source, but use the Debug driver dll instead
  3. Click on the button Advanced->Debug
  4. Depending on the load of the application, and the nature of the problem, you can enable more/less tracing.
  5. Set all tracing on by Severity: level to 'DEBUG' and check the Information boxes 'Data Conversions', 'ODBC Api', 'Data Buffers','Network','System','Thread locks". See "Exhibit #1" below for TRACEFLAG parameters.
  6. Ensure the Trace File location to which you point can be written to by any user
  7. Adapt the ODBC application to use this new DVM ODBC data source
  8. Restart the application (/service) and reproduce the problem
  9. Once reproduced, reconfigure the application to use the old ODBC data source
  10. Compress/zip the log file and forward to support.

On Unix / Linux     
          
  1. Either set the TRACEFLAG environment variable or adapt the DVM data source section to include a line about TRACEFLAG. e.g.
  2. DRIVER=Data Virtualization Manager Debug Driver 3.2
  3. TRACEFLAG=DEBUG SQL DATA BUFFER NETWORK LOCK SYS
  4. TRACEPATH=/temp/dvlog.txt
  5. Adapt the DVM ODBC data source section or connection string to pick up the Data Virtualization Manager Debug Driver 3.x
  6. Restart the application (/service) and reproduce the problem
  7. Once reproduced, set remove the line
  8. gzip / compress the log file and forward to support
Exhibit #1
Severity:
NONE: With this option, no messages are traced or recorded. No trace file is created or opened. This option effectively turns off the DV Driver Trace Facility.
FATAL: This option, the highest severity level, causes only program termination messages to be traced and recorded.
SEVERE: This option causes only events of a severe or higher level to be traced and recorded.
ERROR: This option causes all error messages to be traced and recorded. These messages usually include a description of what went wrong, a record of where the error was detected, any relevant return code, and a detailed error text message.
WARNING: This option allows any warning messages issued by the DV Driver to be traced and recorded.
INFO: This option allows all informational events to be traced, including SQL. Note that values passed to and returned from the DV Driver are included here. This option will cause a large quantity of information to be traced and recorded and is not recommended for general use; however, this option can be useful for application debugging. In addition, this option will trace the host connection ID, allowing users to identify the connection ID so that they can perform transaction monitoring based on the particular connection.
DEBUG (DETAIL): This option causes all events to be traced.
Information (Trace flags):
DATA: This option traces the EBCDIC to ASCII translation of data. This option causes all conversion operations to and from DB2, ODBC C, and ODBC SQL data types to be traced. In each case, the input and output data is displayed in hexadecimal and character format. In addition, information is provided that designates which row and column of the table is currently being processed.
SQL (ODBC API): This option causes all SQL statements passed to the host to be traced, even if the trace severity level is higher than INFO. It also causes the column information for SELECT statements to be displayed, including the column number, name, and data type. For SQL_NUMERIC and SQL_DECIMAL data types, the precision and scale values are also displayed. This option is automatically set when INFO or DETAIL severity levels are selected.
BUFFER: This option traces network buffers transmitted between the client and server.
NETWORK (COMM): (Not available for the DV ODBC Driver on SCO) This option traces detail information on all TCP/IP calls.
SYS (ENVLIST): This option will trace out all environment variable settings into the client trace after a connection request, regardless of whether the connection request was successful or unsuccessful.
LOCK: This option enables tracing for thread locks (mutex) that the DV ODBC Driver obtains and releases.
Trace File (Optional):

STAY: This option keeps the trace file open while conducting tracing. This can improve performance if you are using a disk file to store trace messages. This is generally a good option when doing heavy tracing.
FLUSH: Use this option with STAY. It helps to ensure that messages are not lost if your machine fails.

Document Location

Worldwide

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS4NKG","label":"IBM Data Virtualization Manager for z\/OS"},"ARM Category":[{"code":"","label":""}],"Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
23 January 2023

UID

ibm16845558