Tracing and Debugging Environment Variables

This topic lists environment variables relate to the tracing and debugging functionality.

CCITRACE

You can specify the type of information that will be recorded by CCI tracing. To do this, configure the CCITRACE environment variable as follows:

CCITRACE=options

where any, or all, of the following options can be specified with a preceding / or -:

F

Logs the details of CCI API calls to the trace file. The default is OFF, unless any other trace option is specified, in which case it is ON.

P

Logs the details of protocol-level calls to the trace file. The default is OFF. If this flag is OFF, then only the details of the CCI user-level API will be traced. If this flag is ON, the level of function tracing might be greatly increased.

D

Logs the contents of all buffers passed to and from the CCI functions. The default is OFF.

Warning: This type of tracing might not produce the desired results if the application has been coded to prohibit data tracing.

The ctf.cfg and the CCI.INI file ([ccitrace_base] section) can also be used to control trace options, but any values specified by the CCITRACE environment variable will take precedence.

COBANIMOPT

Specifies additional directives to be used by Character Animator.

Syntax

COBANIMOPT=directive-list
export COBANIMOPT

Parameters

• directive-list A directive, or list of directives. Must not be a filename.

Comments

When you invoke Character Animator, it first reads the directives you have specified in COBANIMOPT and then uses any directives you specify in the command line (which might override some of the directives you set in COBANIMOPT).

Example

COBANIMOPT="MIXEDLANGDEBUG MULTITHREAD"
export COBANIMOPT

COBANIMSRV

Identifies which COBOL program a waiting Character Animator process should attach to.

Syntax

COBANIMSRV=progid
export COBANIMSRV

Parameters

• progid An identifier that is used to identify the program to which Character Animator will attach.

Comments

This environment variable is particularly useful for starting cross-session debugging.

Example

In one console session:

export COBANIMSRV=myid

myid is now a unique identifier that you can use to match Character Animator to a program. Type the command to start Character Animator:

cobanimsrv

The Character Animator waits for a COBOL program to start that has a matching identifier. In another console session:

export COBANIMSRV=myid
cobrun prog1.int

When prog1.int starts, the unique identifier myid matches that of Character Animator; therefore, Character Animator attaches to this process. In console session 1, the Character Animator main screen is displayed and the cursor placed on the first line of prog1.int.

COBIDY

Specifies the directory that Animator is to search for the information (.idy) file for the program being animated if it is not found in the same directory as the intermediate code (.int) file. Animator can update the information file to record information held between sessions.

Syntax

COBIDY=pathname
export COBIDY

Parameters

• pathname A list of search directories, each item separated by a colon.

ES_DDBG_PORT_RANGE

A range of ports to use for dynamic debugging.

You specify a range of port numbers using either a hyphen or a comma.

If you use a hyphen, the values you specify are the start and the end of the port range, and the second port number must be greater than the first.

If you specify a comma, the values you specify are the start of the port range and the number of ports available from the start of the range.

Syntax

ES_DDBG_PORT_RANGE=value
export ES_DDBG_PORT_RANGE

Values

• low_port-high_port

  or

• low_port,number_of_ports

Default

If this is not set, dynamic debugging will use random ports.

Examples

The following definition specifies that ports 8001 through 8040 are to be used:

ES_DDBG_PORT_RANGE=8001-8040

The following definition specifies the same ports but using a different format:

ES_DDBG_PORT_RANGE=8001,40

Note: Micro Focus recommends that you use the Advanced Region Properties page in the Enterprise Server Common Web Administration (ESCWA) interface to configure this environment variable. See Advanced Region Properties for more information.

LDAP_OPT_DEBUG_LEVEL

Enables you to set the LDAP_OPT_DEBUG_LEVEL value using decimal representation.

Syntax

MF_OPENLDAP_DEBUG=decimal_debug_value

Parameters

Sum the decimal debug values you require:

1

LDAP_DEBUG_TRACE

2

LDAP_DEBUG_PACKETS

4

LDAP_DEBUG_ARGS

8

LDAP_DEBUG_CONNS

16

LDAP_DEBUG_BER

32

LDAP_DEBUG_FILTER

64

LDAP_DEBUG_CONFIG

128

LDAP_DEBUG_ACL

256

LDAP_DEBUG_STATS

512

LDAP_DEBUG_STATS2

1024

LDAP_DEBUG_SHELL

2048

LDAP_DEBUG_PARSE

16384

LDAP_DEBUG_SYNC

32768

LDAP_DEBUG_NONE

-1

LDAP_DEBUG_ANY

Default

Not set.

Comments

For Enterprise Server processes, the ES_KEEP_STDERR environment variable must also be set.

Example

MF_OPENLDAP_DEBUG=16657

Sets LDAP_DEBUG_SYNC, LDAP_DEBUG_STATS, LDAP_DEBUG_BER, and LDAP_DEBUG_TRACE.

MFTRACE_ANNOTATIONS

The location of the trace files.

MFTRACE_CONFIG

The location of the CTF configuration file.

MFTRACE_LOGS

The location of the CTF log files.

MFTSO_DEBUG

Controls the display of debug messages.