Log Files and Tracing


You can configure the TIBCO Enterprise Message Service server to write a variety of information to the log. Several parameters and commands control where the log is located as well as what information is written to the log. The log can be written to a file, to the system console, or to both.

Configuring the Log File

The logfile configuration parameter in tibemsd.conf controls the location and the name of the log file.

You can specify that the log file should be backed up and emptied after it reaches a maximum size. This allows you to rotate the log file and ensure that the log file does not grow boundlessly. The logfile_max_size configuration parameter allows you to specify the maximum size of the current log file. Set the parameter to 0 to specify no limit. Use KB, MB, or GB units.

Once the log file reaches its maximum size, it is copied to a file with the same name as the current log file except a sequence number is appended to the name of the backup file. The server queries the directory and determines the first available sequence number. For example, if the current log file is named tibems.log, the first copy is named tibems.log.1, the second is named tibems.log.2, and so on. You can move the files out of the log directory, if desired, and the next log file is determine d based on the first available numbered backup in the log file directory.

When you remove or move log files, it is recommended that you remove or move all log files in the log file directory. The server can then restart its log file sequence with 1.

You can also dynamically force the log file to be backed up and truncated using the rotatelog command in tibemsadmin. See Command Listing for more information about the rotatelog command.

For other configuration parameters that affect the log file, see Tracing and Log File Parameters.

Tracing on the Server

The TIBCO Enterprise Message Service server can be configured to produce tracing messages. These messages can describe actions performed for various areas of functionality (for example, Access Control, Administration, or Routing). These messages can also provide information about activities performed on or by the server, or the messages can provide warnings in the event of failures or illegal actions.

Trace messages can be sent to a log file, the console, or both. You configure tracing in the following ways:

log_trace and console_trace can be configured independently or together. You can configure different types of messages to go to the log file and to the console, if desired.

When you want trace messages to be sent to a log file, you must also configure the logfile configuration parameter. If you specify log_trace, and the logfile configuration parameter is not set to a valid file, the tracing options are stored, but they are not used until the server is started with a valid log file.

When configuring log or console tracing, you have a variety of options for the types of trace messages that can be generated. Table 35 describes the available tracing options.

Table 35 Server tracing options (Sheet 1 of 2)
Trace Option
Description
DEFAULT
Sets the trace options to the default set. This includes:
  • INFO
  • WARNING
  • ACL
  • LIMITS
  • ROUTE
  • ADMIN
  • RVADV
  • CONNET_ERROR
  • CONFIG
  • MSG
INFO
Prints messages as the server performs various internal housekeeping functions, such as creating a configuration file, opening the persistent database files, and purging messages. Also prints a message when tracking by message ID is enabled or disabled.
WARNING
Prints a message when a failure of some sort occurs, usually because the user attempts to do something illegal. For example, a message is printed when a user attempts to publish to a wildcard destination name.
ADMIN
Prints a message whenever an administration function is performed.
LIMITS
Prints a message when a limit is exceeded, such as the maximum size for a destination.
ACL
Prints a message when a user attempts to perform an unauthorized action. For example, if the user attempts to publish a message to a secure topic for which the user has not been granted the publish permission.
SSL
Prints detailed messages of the SSL process, including certificate content.
SSL_DEBUG
Prints messages that trace the establishment of SSL connections.
ROUTE
Prints a message when routes are created or when a route connection is established.
ROUTE_DEBUG
Prints a message for each message that is sent over a route.
CONNECT
Prints a message when a user attempts to connect to the server.
CONNECT_ERROR
Prints a message when an error occurs on a connection.
PRODCONS
Prints a message when a client creates or closes a producer or consumer.
DEST
Prints a message when a dynamic destination is created.
TX
Prints a message when a client performs a transaction.
LDAP_DEBUG
Prints messages when LDAP is used for authentication or to obtain group information.
AUTH
Prints a message when the server authenticates a user using an external LDAP system.
MSG
Specifies that message trace messages should be printed. Message tracing is enabled/disabled on a destination or on an individual message. If message tracing is not enabled for any messages or destinations, no trace messages are printed when this option is specified for log or console tracing. See Message Tracing for more information about message tracing.
FLOW
Prints a message when the server enforces flow control or stops enforcing flow control on a destination.
RVADV
Prints TIBCO Rendezvous advisory messages whenever they are received.

Specify tracing with a comma-separated list of trace options. You may specify trace options in three forms:
Examples

The following example sets the trace log to only show messages about access control violations.

log_trace=ACL 
 
The next example sets the trace log to show all default trace messages, in addition to SSL messages, but ADMIN messages are not shown.
log_trace=DEFAULT,-ADMIN,+SSL 
 
The next example sends a trace message to the console when a TIBCO Rendezvous advisory message arrives.
console_trace=RVADV 

TIBCO Enterprise Message Service™ User’s Guide
Software Release 4.3, February 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com