How do I enable logging for the SCM Broker?

Products

• CA Harvest Software Change Manager

Issue/Introduction

How do I enable logging for the SCM Broker, HServer and RTServer?  What do the different logging options do?

Environment

Release : 13.0.3

Component : CA HARVEST SCM INFRASTRUCTURE (BROKER/AGENT/PEC/SECURITY

Resolution

Here is where to turn on the server-side logging options, and what the different options do:

 

For SCM Broker, edit %CA_SCM_HOME%\HBroker.arg (or $CA_SCM_HOME/HBroker.arg) and add lines:

-trace	Displays PEC-related trace messages.
-qtrace	Turns on the trace for the broker maintained queues and tables. When this option is specified, it directs the contents of the broker maintained queues and tables to the broker log file (or to the stdout if -verbose is specified) whenever the queues or tables are modified.

 

Log file location: %CA_SCM_HOME%\log

Log file name pattern: yyyymmddHBrokerpppp.log

Where:

• “yyyymmdd” is the date the log records were collected
• “pppp” is the process id of the bkrd process

SCM Broker service restart is required to activate the change.

 

For SCM HServer, edit %CA_SCM_HOME%\HServer.arg (or $CA_SCM_HOME/HServer.arg) and add lines:

-logging=n

Writes detailed server information to the server log. Each log level displays the information of all levels below it. The levels are cumulative not mutually exclusive. Level=1 displays ODBC errors and any error messages written by the relational database. Level=2 displays the product Transaction name; the date and time it started; the date and time it ended; the name of the server and process ID that processed the transaction; and the duration of the transaction in milliseconds. Level=3 displays the executed SQL statement, when it started, when it ended, the execution time in milliseconds, and the time in milliseconds since the last completed SQL. Level=4 displays commit and rollback statements. Level=5 displays the results of the SQL statements being executed. Logging levels are cumulative.

-trace

Displays PEC-related trace messages.

 

Log file location: %CA_SCM_HOME%\log (or $CA_SCM_HOME/log)

Log file name pattern: yyyymmddHServerpppp.log

Where:

• “yyyymmdd” is the date the log records were collected
• “pppp” is the process id of the hserver process

SCM Broker service restart is required to activate the change.

 

For PEC, edit %RTHOME%\standard\rtserver.cm (or $RTHOME/standard/rtserver.cm) and add/update:

setopt log_in_client     UNKNOWN	Change “UNKNOWN” to a valid path and file name for the log file you want to create. Logs incoming messages from RTclient processes
setopt log_in_server     UNKNOWN	Change “UNKNOWN” to a valid path and file name for the log file you want to create. Logs outgoing messages to RTclient processes
setopt log_out_client     UNKNOWN	Change “UNKNOWN” to a valid path and file name for the log file you want to create. Logs incoming messages from other RTserver processes
setopt log_out_server     UNKNOWN	Change “UNKNOWN” to a valid path and file name for the log file you want to create. Logs outgoing messages to other RTserver processes
setopt verbose	When the Verbose option is set to TRUE, RTserver prints out much information to stdout (and the debug file described above) as new processes connect, existing processes disconnect, and subjects are operated on. The Verbose option provides a way to watch the detailed operations of RTserver.

 

Log file location/name: As specified for each option.

All 4 of the log* options can be given the same folder and file name, or you can specify separate names for each log file.

You must specify a full path and file name.  The folder you specify must already exist on the broker machine.

Also note that while the rtserver process is running it will have a lock on the log file(s) specified.  If the files get too big you will need to stop the rtserver process in order to move or delete them.

Rtserver process restart is required to activate the change.

 

Additional debug logging for PEC can be found in the folder “C:\Windows\Temp\rtworks” on a Windows broker machine or “/tmp/rtworks” on a Linux/Unix broker machine.