Setting debug level logging for all TIBCO LogLogic SEM application components

Setting debug level logging for all TIBCO LogLogic SEM application components

book

Article ID: KB0077393

calendar_today

Updated On:

Products Versions
TIBCO LogLogic Security Event Manager 2.7.x and higher

Description

LogLogic SEM is composed of several modules. This procedure explains how to set each module in DEBUG mode and look for the associated log file.

Issue/Introduction

This article explains how to configure all SEM application components to log at debug level and also provides the full path and filename to each component's log file.

Resolution

For all components which are located on the server, you have the following script: /usr/local/exaprotect/esms-setup/scripts/others/set_debug.sh

Local SMA:
To set DEBUG mode on local agent, you have to execute the following script:
/usr/local/exaprotect/esms-setup/scripts/others/set_debug.sh on agent INSTANCE_NAME.
The log file corresponding to the local agent is: /var/lib/exaprotect/logs/INSTANCE_NAME/esma_errors.log To go back into normal mode, you need to re-execute this script with the "off" argument.
This mode allows to see TAT generation queries.

 
Runtime:
To set DEBUG mode on runtime, you have to execute the following script: /usr/local/exaprotect/esms-setup/scripts/others/set_debug.sh on runtime INSTANCE_NAME.
The log file corresponding to the local agent is: /var/lib/exaprotect/logs/INSTANCE_NAME/esmp_errors.log
To go back into normal mode, you need to re-execute this script with the "off" argument.

Report:
To set DEBUG mode on runtime, you have to execute the following script: /usr/local/exaprotect/esms-setup/scripts/others/set_debug.sh on report INSTANCE_NAME.
The log file corresponding to the local agent is: /var/lib/exaprotect/logs/INSTANCE_NAME/esmp_report_errors.log
To go back into normal mode, you need to re-execute this script with the "off" argument.

Executor:
To set DEBUG mode on runtime, you have to execute the following script: /usr/local/exaprotect/esms-setup/scripts/others/set_debug.sh on executor
The log file corresponding to the local agent is: /var/lib/exaprotect/logs/esmp_executor_errors.log
To go back into normal mode, you need to re-execute this script with the "off" argument.

Other:
To set DEBUG mode on runtime, you have to execute the following script: /usr/local/exaprotect/esms-setup/scripts/others/set_debug.sh on other
The log file corresponding to the local agent is: /var/lib/exaprotect/logs/esmp_other_errors.log
To go back into normal mode, you need to re-execute this script with the "off" argument.


Remote Log Collector:
In this case, you need to modify manually configuration file. Please follow this procedure:

1. Stop your agent:
On Linux : /etc/init.d/exa_agent_ stop
On Windows: Programs -> ExaProtect Technology -> ESMA 2.7.3.0 -> Stop ExaProtect Security Management Agent

2. Open the file
/installation_folder/conf/agent_log4j.properties and change the 2 following lines:

log4j.rootLogger=info, EAS_AGENT, EAS_AGENT_ERRORS
[snip]
log4j.appender.EAS_AGENT_ERRORS.Threshold=ERROR


To :
log4j.rootLogger=debug, EAS_AGENT, EAS_AGENT_ERRORS

[snip]
log4j.appender.EAS_AGENT_ERRORS.Threshold=
DEBUG


Note: The DEBUG mode is very verbose; you have the possibility to set the max file size in the "log4j" configuration file (agent_log4j.properties).
You have to change only this line:
log4j.appender.EAS_AGENT_ERRORS.MaxFileSize=1MB
to (In this example, the log file size is set to 5 MBytes):
log4j.appender.EAS_AGENT_ERRORS.MaxFileSize=5MB


3. Save the file and restart the remote agent:
On Linux : /etc/init.d/exa_agent_ start
On Windows: Programs -> ExaProtect Technology -> ESMA 2.7.3.0 -> Start ExaProtect Security Management Agent

Debug message are stored in the log file: /installation_folder/logs/esma_errors.log

New features on version 2.7.3.1

In this version, it is possible to set the DEBUG mode "byThread"; it means each thread will be logged in dedicated file.

On Log Collectors:
You must set the Log Collector in DEBUG mode as seen previously. You also need to stop the Log Collector, add the following line at the end of the file /install_folder/conf/agent.properties
useStdThreadLog=yes
Then, you can restart the agent.

Note: If your remote agent is in mode Server -> Agent, the configuration file agent.properties does not exist. So you must create it in the folder /install_folder/conf/ and just add the previous line.

You will find the log files in the folder: /install_folder/logs/
These files will be named like "byThread..log"


On SMP :
You must set the server component in DEBUG mode as seen previously. You also need to stop the required component.,To do so, add the following line at the end of the file /home/exaprotect/conf/exa_instance.properties
useStdThreadLog=yes
You will find the log files in the folder: /var/lib/exaprotect/logs/
These files will be named like "byThread..log"

Note: Other log files will not be impacted by this setting.


Warning: You must be careful because files are not limited in size.