PreviousApplication Configuration CCI.INI - The CCI Configuration FileNext

Chapter 8: CCI Trace

CCI Trace enables you to trace any CCI function calls made by applications.

The information obtained from the trace is sent to a log file. By default this is called ccitrc1.trc, which a matching index file ccitrc1.idx. In addition to the trace information, data flow information can be sent to a separate set of log files with the default names ccitrc1d.trc and ccitrc1d.idx, depending on the trace options specified.

Although the trace log file is not generally in a readable format, any data output from the CCI data buffers will not be encrypted when written to a trace file. Applications that use CCI can be coded to block data tracing for security reasons.

8.1 Activating CCI Trace

To activate CCI Trace add the following /tr parameter setting to the Fileshare Server configuration file.

/tr cci

To prevent unauthorized access to the CCI Trace information you are prompted for the supervisor password when you invoke a Fileshare Server with CCI Trace enabled (the supervisor password is that specified for the user-ID FSVIEW in the password file so you must specify this password when you start the Fileshare Server). If the password is accepted CCI Trace is enabled and a second prompt asks if CCI Trace should be activated immediately or not.

CCI Trace can be toggled on and off using the F3 key.

8.2 CCI Trace Options

8.2.1 CCITRACE Environment Variable

CCI trace can be enabled for any application by setting the CCITRACE environment variable as follows:

CCITRACE=filename [options]

where:

filename is the name of the log file you want the trace output to go to. If you do not specify this parameter, the log file ccitrc1.trc is created in the current directory with all options set to their default states. A matching filename.idx will also be generated.
options can be any one, or all, of the following, and must be upper case:

/F or -F logs the details of CCI API calls to the trace file. The default condition for this option is OFF, unless a filename or any other trace option are specified, in which case it is always ON.
/P or -P logs the details of protocol level calls to the trace file. If this flag is not ON, then only the details of the CCI user level API will be traced. If this flag is ON, the level of function tracing may be greatly increased. The default condition for this option is OFF.
/D or -D logs the contents of all buffers passed to and from the CCI functions. The default condition for this option is OFF. Data tracing may not be allowed if the application has been coded to prohibit data tracing for security reasons.

So to create a CCI trace file with the default name of ccitrc1.trc (with matching ccitrc1.idx file) which traces CCI API function flow, along with the underlying protocol function flow, but with no tracing of the user data passed to these calls, the value of the CCITRACE environment variable would be /P.

The CCI.INI file can also be used to control trace options, but any values specified by the CCITRACE environment variable will take precedence.

8.2.2 CCI.INI Trace Options

CCI trace options can be specified via the CCI.INI file. These options are listed under the [ccitrace-base] section.

Option
Value
Meaning
force_trace_on yes or no If yes, logs the details of CCI API calls to the trace file. The default condition for this option is no. Unless this option is specified, no tracing will be generated, even if the other options are specified to yes.
protocol_trace yes or no If yes, logs the details of protocol level calls to the trace file. If this option is yes, the level of function tracing may be greatly increased. The default condition for this option is no.
data_trace yes or no If yes, logs the contents of all buffers passed to and from the CCI functions. The default condition for this option is no. Data tracing may not be allowed if the application has been coded to prohibit data tracing for security reasons.

For example, to turn on CCI API tracing and data tracing, but not protocol level tracing, the CCI.INI file would need to contain the following

[ccitrace-base]
force_trace_on=yes
protocol_trace=no
data_trace=yes

Note that if trace options have been specified via a CCITRACE environment variable they will take precedence over any trace options specified in the CCI.INI file.


Copyright © 1999 MERANT International Limited. All rights reserved.
This document and the proprietary marks and names used herein are protected by international law.

PreviousApplication Configuration CCI.INI - The CCI Configuration FileNext