TMTM Agent and extension logs

Agent and extension logging is configurable using QPLog.ini. This file only applies to non-Java monitoring extensions. You modify QPLog.ini to change the level of logging, the type and location of logging, and set different log levels for different applications.

QPLog.ini on i5/OS must be an ascii file in CCSID 819.

QPLog.ini controls the logging per extension using stanzas. Stanzas are defined by a string enclosed in square brackets [] except on z/OS batch where parenthesis () are used. z/OS USS uses square brackets.

The following stanzas are defined for the current agent and extensions:

[qpea]
[qpmon]
[qpcfg]

Stanza settings

The following settings are supported for the agent or extensions and can be specified per stanza.

Parameter settings are described in the tables below.

Parameter	Value
`logAppend`	Default is 0. logAppend controls whether logging is appended to the existing log file (`logAppend=1`) or a new log is created (`logAppend=0`) on each start of the agent/extension.
`logToConsole`	Default: 1 logToConsole controls whether or not log output is written to the window where the command is running. 0 is off, 1 is on.
`logLevel`	Level of logging. Range: a positive number. BMC recommends that you do not set log levels above 50 without specific instructions from BMC Support. See the table below.
`logTimeStamp`	Default: 0 logTimeStamp controls whether a time stamp is written to the log or not. 0 is off, 1 is on.
`logCheckIniFrequency`	Default: 5000 (seconds) Value indicates how many times the log is written to before rereading the QPLog.ini file.
`logFilename`	Name of the log file.
`logDirectory`	Directory in which the log file is located.
`logCircular`	Default: 1 logCircular controls whether to back up logs when the log's size reaches logCircularSizeMB (`logCircular=1`), or to clear the log and start writing from the beginning (`logCircular=0`). The number of backups is determined by logCircularCount.
`logCircularCount`	Number of circular logs. Range: 2 - 10.
`logCircularSizeMB`	Size of the circular log in MB. Range: 1 - 100.
`shouldHandleSEH`	Default: 0 0 disables mini-dumps from exceptions. 1 enables mini-dumps from exceptions.

Make sure to take into account the inheritance factor when lowering the level of logging.

Log levels are cumulative. All logging at lower levels is included in a higher level.
Excessive logging can impact performance of an extension and in some cases the technology the extension is monitoring. Care should be taken before using high levels of logging and in most cases the levels are recommended by BMC Support for specific problem analysis.
High log levels can result in extremely large log files. The table below lists the level of data collection for specific log level settings. Use circular logging to restrict the amount of disk space used. Note that BTM extensions use circular logging by default.

Common log level settings

Value	Data collected
0	Nothing but messages that are always logged.
5	Errors. Default.
6	Warnings.
50	Informational.
60	More informational.
100	Verbose.
>100	More verbose.

If you run applications with monitoring extensions, make sure the log directory is accessible and writeable by the applications.

Log categories specific to BTM non-Java extensions

In addition to the loglevel keyword, BTM extensions allow for more precise logging using log categories. The table below lists the log categories that apply to all BTM non-Java extensions.

Below is a sample QPLog.ini file content parameters and categories with default settings.

Sample BTM stanzas in QPLog.ini

[btm_app1]
loglevel=5
btmmsg=100
btmfilter=100
btmupdatemsg=51
[btm_brad1_amqsput]
loglevel=5
btmmon=200
btmmsg=200
btmmq=200
[btm_brad1_btmtestapp]
loglevel=5
btmmon=200
btmmsg=200
btmmq=200

`btmstats`	Statistics on extension processing.
`btmmsg`	Information about success/failures of parsing messages.
`btmfilter`	Information about success/failures of activity filters.
`btmmon`	Information about what resources are being monitored.
`btmstate`	Information about the state of monitoring in relation to agent connection.
`btmconfigcheck`	Information about checking for updated configurations.
`btmupdatemsg`	Detail information of updates published.
`btmparse`	Details about message parsing processing.
`btmparse-msgformat`	Details about message parsing in relation to message format.

BTM extensions also support hierarchical stanzas that allow you to restrict logging to certain applications or technology instances. In addition, each BTM technology can have specific log categories. The stanza formats and log categories are listed in the table below for each technology.

Applies to	Stanza title	Log category
All BTM non-Java extensions.	[btm]
The BTM WMQ Exit	[btm_QueueManager] [btm_QueueManager_AppName]	btmmq Additional log categories on i5/OS are btmile and btmpase
The BTM WMB Exit	[btm_BrokerName] [btm_BrokerName_ExecutionGroup]	btmwmb
The BTM IIS Extension	[btm_iis]	btmiis, btmhttp
The BTM Apache Extension	[btm_apache] [btm_apache_GroupName]	btmapache, btmhttp
The BTM Sun Java System Web Server Extension	[btm_sunwbsvr][btm_sunwbsvr_GroupName]	btmsunwbsvr, btmhttp

A log category level inherits from a less specific stanza. In the example below, any applications using queue manager "myQM1" has btmmsg=100 and btmfilter=5. BTM extensions are the only extensions that currently support this hierarchy of stanzas.

[btm]
btmmsg=100
[btm_myQM1]
btmfilter=5

TMTM Agent and extension logs

Stanza settings

Common log level settings

Log categories specific to BTM non-Java extensions

Comments