17.00 - Enabling Teradata PT API Infrastructure-Specific Tracing - Parallel Transporter

Teradata® Parallel Transporter Application Programming Interface Programmer Guide

prodname
Parallel Transporter
vrm_release
17.00
created_date
June 2020
category
Programming Reference
featnum
B035-2516-220K

The environment variable TPTAPIDEBUG enables the TPT API debug mode and writes the log to the file named by the environment variable TPTAPILOG.

The environment variable TPTAPILOG specifies the file to which TPT API debug messages are written.

Setting TPTAPIDEBUG

To enable the TPT API debug mode, the environment variable TPTAPIDEBUG should be set to an integer value greater than zero, for example, 1 or 5 or 100. Only positive integer values are valid for the TPTAPIDEBUG environment variable.

  • If TPTAPIDEBUG=0, the TPT API debug mode is not enabled. The value to which TPTAPIDEBUG should be set cannot be 0.
  • If TPTAPIDEBUG=-1, the TPT API debug mode is not enabled. The value to which TPTAPIDEBUG should be set is a number greater than 0.
  • If TPTAPIDEBUG="abc", the TPT API debug mode is not enabled. The value to which TPTAPIDEBUG should be set should be a positive integer greater than zero.

Setting TPTAPILOG

  • If TPTAPILOG is set to a filename, the TPT API debug messages, when TPTAPIDEBUG is set correctly, are written to the file named.
  • If TPTAPILOG is not set to a filename, but the TPT API debug mode is enabled (because TPTAPIDEBUG is set correctly), the TPT API debug messages are written to the console (standard output, that is, 'stdout').

Example 1

If:

  • TPTAPIDEBUG=1
  • TPTAPILOG="APILOG.txt"

the log/debug information is written to the file "APILOG.txt".

Example 2

If:

  • TPTAPIDEBUG=1
  • TPTAPILOG is not set

the log/debug information is written to the console ('stdout').

Example 3

If

  • TPTAPIDEBUG=100
  • TPTAPILOG=stdout

the log/debug information is written to the console ('stdout')

Example 4

If:

  • TPTAPIDEBUG=1
  • TPTAPILOG=1

the log/debug information is written to the file named "1".

Example 5

If:

  • TPTAPIDEBUG is not set to any value
  • TPTAPILOG="APILOG.txt"

the TPT API debug mode is not enabled (because TPTAPIDEBUG has not been set to a value) and log/debug information is not written to the file named. The TPT API program continues without the debug mode being enabled.

Example 6

If

  • TPTAPIDEBUG=-4
  • TPTAPILOG="APILOG.txt"

the TPT API debug mode is not enabled (because TPTAPIDEBUG is set to less than 1) and log/debug information is not written to the file named. The TPT API program continues without the debug mode being enabled.