UIMAPI debug logging enablement - DX Unified Infrastructure Management

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

This article outlines the steps to enable debug-level logging for the UIMAPI probe in DX UIM. Increasing the logging verbosity helps troubleshoot issues by adding UIMAPI calls to the logs.

Environment

• DX UIM 23.4 CU4+
• UIMAPI 23.4.4+ 
• wasp 23.4.4+

Cause

Default logging levels for the UIMAPI (wasp probe) are often set to 'info' or 'error', which may suppress successful request details. Changing the log4j2 configuration to 'all' or 'trace' provides the necessary visibility for debugging API calls.

Resolution

To enable debug logging for UIMAPI, follow these steps:

1. Navigate to the directory where the wasp probe is installed, typically: <InstallFolder>/probes/service/wasp/conf
2. Locate the file uimapi_log4j2.xml.
3. Open the file in a text editor.
4. Under the <Loggers> header, find the root logger configuration.  It will look something like this:

       <!-- Logger Levels: all, trace, debug, info, warn, error, fatal, off -->
       <Loggers>
           <Root level="error" additivity="false">
               <AppenderRef ref="ProbeFile"/>
           </Root>

5. Change the logging level to all or trace (e.g., <Root level="all">).

       <!-- Logger Levels: all, trace, debug, info, warn, error, fatal, off -->
       <Loggers>
           <Root level="all" additivity="false">
               <AppenderRef ref="ProbeFile"/>
           </Root>

6. Save the changes.
7. Restart the wasp probe to apply the new logging configuration.
8. To verify, review the UIMAPI logs located in <InstallFolder>/probes/service/wasp/logs/uimapi.log.

Additional Information

For general UIMAPI deployment and configuration, refer to Knowledge Article 265883: UIMAPI deployment and configuration

To speak with a customer representative or a Support Engineer see Contact Support. Scroll to the bottom of the page and click on your respective region.