Tracing EntireX Components under BS2000

This document provides trace information for the following components:


Tracing EntireX Broker

Switching on Tracing

Start of instruction setTo switch on tracing

  • Set the attribute TRACE-LEVEL in the broker attribute file

    • for minimal trace output to "1"

    • for detailed trace output to "2"

    • for full trace output to "3"

    Example:

    TRACE-LEVEL=2

Switching off Tracing

Start of instruction setTo switch off tracing

  • Set the attribute TRACE-LEVEL in the broker attribute file to 0:

    TRACE-LEVEL=0

    Or:
    Omit the TRACE-LEVEL attribute.

Deferred Tracing

It is not always convenient to run with TRACE-LEVEL defined, especially when higher trace levels are involved. Deferred tracing is triggered when a specific condition occurs, such as an ACI response code or a broker subtask abend. Such conditions cause the contents of the trace buffer to be written, showing trace information leading up the specified event. If the specified event does not occur, the Broker trace will contain only startup and shutdown information (equivalent to TRACE-LEVEL=0). Operating the trace in this mode requires the following additional attributes in the broker section of the attribute file. Values for TRBUFNUM and TRAP-ERROR are only examples.

Attribute Value Description
TRBUFNUM 3 Specifies the deferred trace buffer size = 3 * 64 K.
TRMODE WRAP Indicates trace is not written until an event occurs.
TRAP-ERROR 322 Assigns the event ACI response code 00780322 "PSI: UPDATE failed".

Dynamically Switching On or Off the EntireX Broker Trace

The following methods are available to switch on or off the EntireX Broker trace dynamically. You do not need to restart the broker for the changes to take effect.

  • ETBCMD
    Run command utility ETBCMD with option -c TRACE-ON or - c TRACE-OFF. See ETBCMD.

  • Operator Command
    Issue an operator command. See TRACE.

    See also Deferred Tracing.

Tracing Broker Stubs

Scope

The following table describes the possible values for the broker stub trace:

Trace Level Description
0 NONE No tracing. Switch tracing off.
1 STANDARD Traces initialization, errors, and all ACI request/reply strings.
2 ADVANCED Used primarily by system engineers, traces everything from level 1 and provides additional information, for example the Broker ACI control block, as well as information from the transports.
3 SUPPORT This is full tracing through the stub, including detailed traces of control blocks, message information, etc.

Setting Trace Options

Trace options can be supplied to broker stubs for NET communication as well TCP/SSL communication via SDF job control statements or JV job variables:

Transport SDF Job Control JV Control Output
TCP/SSL /ETB-STUBLOG = '3' CREATE-JV ETB-STUBLOG
MODIFY-JV ETB-STUBLOG,SET=C'3'
<tsn>.ETB
NET /EXA-LOG = '3' CREATE-JV EXA-LOG
MODIFY-JV EXA-LOG,SET=C'3'
<tsn>.EXA

Switching off Tracing

Remember to switch off tracing to prevent trace files from filling up your disk.

  • Set the SDF job control option to '0' or delete it.

  • Set the JV job variable to '0' or delete it, for example

    DELETE-JV ETB-STUBLOG

Activating Tracing for the RPC Server

Start of instruction setTo switch on tracing for the RPC server

Tracing Broker Security Server

The Broker Security Server comes with a trace facility that can be used to track the IDs of users logging on to EntireX Broker. It also produces some diagnostic messages that are helpful for problem analysis. By default, no tracing is performed.

Start of instruction setTo switch on tracing for Broker Security Server

  • Set up an SDF variable in the server's job control.

    TRACE='ON'

Start of instruction setTo switch off tracing for Broker Security Server

  • Set the following in the server's job control.

    TRACE='OFF'

See EntireX Broker Security Server for BS2000.