PreviousNext

GDS API Logging

The GDS API logging facility displays informational and error messages for XDS functions. In addition, the input and output arguments to XDS function calls can also be displayed. For each XDS object, its OM types, syntaxes, and values are displayed recursively. A number of different display formats can be selected for the XDS objects. These are selected by setting the value of the environment variable XDS_LOG as shown in the table below.

Logging can be activated dynamically at runtime by setting the environment variable XDS_LOG.


XDS_LOG Values

XDS_LOG Value Result Example
Bit 1 = on Display arguments, messages, results and errors N/A
Bit 1 = off Display messages only (all other bits ignored) N/A
Bit 2 = on Display result and error objects as private objects N/A
Bit 2 = off Display result and error objects as public objects N/A
Bit 3 = on Object identifiers displayed as specified in 4th bit N/A
Bit 3 = off Object identifiers displayed as symbolic constants DS_C_SESSION
Bit 4 = on Object identifiers displayed as dotted-decimal 2.5.4.35
Bit 4 = off Object identifiers displayed as hexadecimal bytes \x55\x04\x23
Bit 5 = on Syntaxes displayed as integers 127
Bit 5 = off Syntaxes displayed as symbolic constants OM_S_OBJECT
Bit 6 = on Types displayed as integers 715
Bit 6 = off Types displayed as symbolic constants DS_AVAS
The bits shown in the table above can be combined. For example, the following command sequence sets XDS_LOG to 5 (00101 in binary):

XDS_LOG=5; export XDS_LOG

In this example, the logging facility is directed to display arguments, messages, results, and errors, to convert results and errors into public objects (for display purposes only), and to display object identifiers as hexadecimal bytes; and to display OM syntaxes and OM types as symbolic constants. Normally, XDS_LOG should be set to 0. If full tracing is required, then set XDS_LOG to 1.

More:

Logging Format

Examples