Tracing

To enable or to modify tracing

use the cimconfig command or the MODIFY console command. You can modify the tracing configuration properties while the CIM server is running.

See also cimconfig and MODIFY console command.

You can modify the following tracing configuration properties:

traceLevel

turns tracing on and off and specifies the trace level. You can choose among the following trace levels:

0

Tracing is off

1

Severe errors

2

Warning level error messages (default)

3

Inter-function logic flow, medium data detail

4

High data detail

5

High data detail, method enter and exit

traceComponents

specifies the components that you want to trace.

You can choose one or more of the following components, separated by comma:

Component name	Component name
All	Authentication
Authorization	BinaryMessageHandler
CIMExportRequestDispatcher	CIMOMHandle
CMPIProvider	CMPIProviderInterface
Config	ControlProvider
CQL	DiscardedData
Dispatcher	ExportClient
Http	IndicationFormatter
IndicationGeneration	IndicationHandler
IndicationReceipt	IndicationService
Internal Provider	IPC
L10N	Listener
LogMessages	MessageQueueService
ObjectResolution	OsAbstraction
ProviderAgent	ProviderManager
Repository	Server
Shutdown	SSL
StatisticalData	Thread
UserManager	WsmServer
WQL	Xml
XmlIO

The following components have a special purpose:

Special purpose trace components	Description
All	Traces all available components
DiscardedData	Issues a trace message when information is discarded or an operation is cancelled
LogMessages	Traces all messages written to the logging facility
StatisticalData	Prints statistical data to the trace at level 4
XmlIO	Prints the complete CIM-XML messages

traceFacility

specifies the destination of the trace messages.

FILE

saves the trace messages to the file specified in traceFilePath.

This file is continuously growing. You can remove it while the CIM server is running. It will be recreated automatically.

LOG

saves the trace messages to the logging facility, if the logLevel is set to TRACE (see Logging). This alternative combines the log messages and the trace messages to one message stream.

MEMORY

saves trace messages in a wrap around memory buffer. This buffer is included in memory dumps. (default).

To find the trace in a memory dump, the top of the allocated memory block is flagged with "PEGASUSMEMTRACE". The last trace message is flagged with the suffix "EOTRACE". The flags are encoded in ASCII.

Specify the size of the memory buffer with the static traceMemoryBufferKbytes property.

traceFilePath

if traceFacility=FILE, this property specifies the file which saves the trace data. The default is /tmp/cimserver.trc.

traceMemoryBufferKbytes

specifies the size of the memory area which is reserved for trace messages in kB (1kB=1024B). The default is 10240. The value must be at least 16. traceMemoryBufferKbytes is a planned configuration property (see Changing planned configuration properties).

This area is allocated when traceFacility=MEMORY.

Tracing providers running out-of-process:

When tracing is enabled in the CIM server, it is also enabled in the provider agent processes. For reasons of trace data integrity and regarding performance aspects, a separate trace file is used for each provider agent process.

Each provider agent is uniquely identified by the name of the shared provider agent executable. Each non-shared instance of a provider agent corresponds with a single provider module. This name is used as an extension to the trace file name specified by the traceFilePath configuration property. For example, if traceFilePath is defined as /tmp/cimserver.trc, the non-shared provider agent for the OperatingSystemModule would direct its trace output to the file /tmp/cimserver.trc.OperatingSystemModule.

Examples:

To set the trace level to trace all information with high data detail in the Thread and ProviderManager components,

type the following commands into the UNIX System Services shell:

cimconfig -s traceLevel=4
cimconfig -s traceComponents=Thread,ProviderManager

or

F CFZCIM,APPL=CONFIG,traceLevel=4
F CFZCIM,APPL=CONFIG,traceComponents='Thread,ProviderManager'

on the console.

To disable all tracing,

type the following command into the UNIX System Services shell:

cimconfig -s traceLevel=0

To route both trace and log messages to a file:

type the following commands into the UNIX System Services shell:

cimconfig -s traceLevel=1
cimconfig -s traceComponents=Thread,ProviderManager,LogMessages
cimconfig -s traceFacility=FILE
cimconfig -s traceFilePath=/tmp/cimservr1.trc

The CIM server now saves severe trace messages in the Thread and ProviderManager components and all log messages to the file /tmp/cimservr1.trc.

To route both trace and log messages to memory:

type the following commands into the UNIX System Services shell:

cimconfig -s traceLevel=1
cimconfig -s traceComponents=Thread,ProviderManager,LogMessages
cimconfig -s traceFacility=MEMORY

The CIM server now saves severe trace messages in the Thread and ProviderManager components and all log messages to the default memory space of 10240kB.

To route both trace and log messages to the z/OS Communications Server's system logger (syslog) daemon:

1. configure the syslog daemon as described in z/OS Communications Server: IP Configuration Referenceand z/OS Communications Server: IP Configuration Guide
2. type the following commands into the UNIX System Services shell:

   cimconfig -s logLevel=TRACE
   cimconfig -s traceLevel=1
   cimconfig -s traceComponents=Thread,ProviderManager
   cimconfig -s traceFacility=LOG

The CIM server now writes severe trace messages in the Thread and ProviderManager components and all log messages to the syslog daemon.

See also Logging.