How to enable trace debug level logging for the UIM Spectrum Gateway

Products

• CA Spectrum
• DX NetOps
• DX Unified Infrastructure Management (Nimsoft / UIM)
• Unified Infrastructure Management for Mainframe
• CA Unified Infrastructure Management SaaS (Nimsoft / UIM)

Issue/Introduction

There may be occasions where more debug is required to troubleshoot UIM / Spectrum / spectrumgtw probe issues.

Here is how to turn on trace level logging for the various components.

Environment

- spectrumgtw probe

Cause

- spectrumgtw troubleshooting

Resolution

1. Navigate into \Nimsoft\probes\gateway\spectrumgtw\logs\

2. Find and edit the log4j2.properties file:

3. Change any line to "trace" to get more details from the system for any component you want more information/detail from:

#alarmLogger is for alarm.log
logger.alarmLogger.level = trace
#maintenanceLogger is for maintenance.log
logger.maintenanceLogger.level = info
#vmwareLogger is for vmware.log
logger.vmwareLogger.level = info
#vmotionLogger is for vmotion.log
logger.vmotionLogger.level = info
#inventoryLogger is for inventory.log
logger.inventoryLogger.level = info
#hostLogger is for host.log
logger.hostLogger.level = info

Additional Information

See also-> spectrumgtw AC configuration

Configuring Logging Level

You can update the logging levels, it will be updated dynamically every 30 seconds. You need not restart the probe for the change to be reflected. Each logger accepts Log4j 2’s built-in log levels: "trace", "debug", "info", "warn", "error" and "fatal". The default log level is info.

Follow these steps to change log levels:

Open the log4j2.properties file.

Update any one of the log levels. For example, see the following log configuration:

Alarms:             logger.alarmLogger.level = 
Maintenance:    logger.maintenanceLogger.level = 
Hosts:               logger.hostLogger.level = 
VMWare:           logger.vmwareLogger.level = 
vMotion:            logger.vmotionLogger.level = 
Inventory:          logger.inventoryLogger.level = 
Spectrumgtw(Common):   rootLogger.level = 

spectrumgtw probe uses Log4j2 for logging. Log4j2 can be configured using the log4j2.properties file. Th spectrumgtw probe stores each sync logging in a separate file. All log files are stored in the logs folder of the spectrumgtw probe installation path.

On the UIM Primary hub filesystem you should see the log files located in:

Windows
...\Program Files (x86)\Nimsoft\probes\gateway\spectrumgtw

UNIX/Linux
/opt/nimsoft/probes/gateway/spectrumgtw

For example:

   spectrumgtw.log
   spectrumgtw.log.2
   spectrumgtw.log.3
   etc.

Enable the additional relevant log setting for the reported problem, e.g., alarm sync issues, maintenance schedule sync, etc.

In the log4j2.properties file for example:

#rootLogger is for spectrumgtw.log
rootLogger.level = trace

#alarmLogger is for alarm.log
logger.alarmLogger.level = trace
#maintenanceLogger is for maintenance.log
logger.maintenanceLogger.level = trace
#vmwareLogger is for vmware.log
logger.vmwareLogger.level = info
#vmotionLogger is for vmotion.log
logger.vmotionLogger.level = info
#inventoryLogger is for inventory.log
logger.inventoryLogger.level = info
#hostLogger is for host.log
logger.hostLogger.level = info