UCMDB Log Files

CMDB log files enable you to perform basic troubleshooting of CMDB runtime problems. Additionally, by tracking the CMDB behavior in the log files, you can examine the effects of changes made in the system. The CMDB is composed of subsystems and each subsystem records to several log files. CMDB Server logs have consistent format. The order is data and time: (format "yyyy-MM-dd hh:mm:ss:SSS") logLevel [Thread Name]. The wrapper log is an exception to this standard. These settings can be changed from log properties files located in the UCMDBServer\conf\log\ folder.

Log files are located in:

  • Windows: C:\UCMDB\UCMDBServer\runtime\log
  • Linux: /opt/UCMDB/UCMDBServer/runtime/log

Note

UCMDB log levels should be set to the OOTB values. They may be increased when investigating issues. However, after obtaining the required information the log levels should be reverted. Increased log levels for a longer period of time may have an impact over performance.

If you want to delete the logs, you should delete the content in the log folder only, and never delete the folder itself. Make sure that the log folder always exists. If the log folder is deleted accidentally, create the log folder manually before starting up the UCMDB Server.

General Log Files

Quota Log Parameters

The log name is cmdb.quota.log.

Log File Description
Purpose Quota names, quota values, and current quota levels.
Information Level Quota names and values set in the server and customer levels during a customer load.
Error Level CMDB operations that fail because they exceed quota limits.
Debug Level A count collector runs every n minutes and gathers current counts for all quotas. Collected counts are logged.
Basic Troubleshooting If operations fail because of quota limits, check the count growth and quota values.

CMDB Operation Statistics Log

The log name is cmdb.operation.statistics.log.

The log does not appear in the log folder by default. Only when you perform some specific action, the log becomes available. For example, when you invoke the resetOperationStatistics JMX method from the Framework Services category, it resets CMDB Server Operation Statistics and writes dump to this log.

Log File Description
Purpose Statistics for all operations performed in the past 15 minutes including worst operation instances.
Information Level

Statistics per operation including operation class name, caller application, and customer ID.

Default of 10 worst operation instances.

Error Level Disables the statistics feature.
Debug Level Not available.
Basic Troubleshooting Check when there is a performance slowdown.

Configuration Log

The log name is configuration.log.

Log File Description

Purpose

Contains basic environment details, including:

  • Server version and CUP version
  • Database vendor and version
  • Content pack version
  • High Availability configuration
  • Data Flow Probe version
  • Changes to settings (each setting is audited in the log)
Information Level Information is written to the log when the system starts up or when a setting is changed.
Error Level Not available.
Debug Level Not available.
Basic Troubleshooting Used by Customer Support to help reproduce customer problems.

Keystore and Truststore Password Save Log

The log name is save_store_pass.log.

Log File Description
Purpose Information about installation log: keystore password and truststore password save time and encryption type.
Information Level Operation details.
Error Level Not available.
Debug Level Not available.
Basic Troubleshooting This is especially useful when installing and starting the UCMDB server. You can use this log information together with the information in Troubleshooting Keystore and Truststore.

Keystore and Truststore Password Verify Log

The log name is verify_store_pass.log.

Log File Description
Purpose Information about the installation log: whether keystore password and truststore password are saved correctly or not. If server-storepass.conf exists, then the UCMDB server installer will change keystore and truststore passwords with keytool.
Information Level Operation details.
Error Level Not available.
Debug Level Not available.
Basic Troubleshooting This is especially useful when installing and starting the UCMDB server. You can use this log information together with the information in Troubleshooting Keystore and Truststore.

Long Running Threads Troubleshooting

The log name is slow.log.

Log File Description
Purpose This log file is used to troubleshoot long running threads and operations.
Information Level A list of slow running threads with operations will be displayed. A list of all managers and their load will also be displayed. Finally a list of open connections to the database will be displayed.
Error Level Errors about collecting the information about the threads will be displayed. All threads interrupted due to operation timeout will be displayed.
Debug Level No information.
Basic Troubleshooting

If an operation takes a lot of time you will see it in this log.

If an operation is interrupted you will see it in this log.

Class Model Log Files

CI Type Model Log

The log name is cmdb.classmodel.log.

This log should appear when you perform operations on the UCMDB class model, like creating a new CI Type, or adding an attribute on an existing CI Type.

Log File Description
Purpose CI Type Model errors and debug messages.
Information Level When a CI Type Model is loaded, incorrect definitions are logged as informational messages. An example of an incorrect definition is duplicate attributes.
Error Level Not available.

Debug Level

Every CI Type update includes the following:

  • Original CIT in XML format

  • New CIT in XML format

  • Differences between the CITs

If the CI Type Model update is rejected, the reason is logged.

Basic Troubleshooting

Compares the differences that the server finds between the original CIT and the new CIT. This is useful to understand the following scenarios:

  • A CIT in a package failed

  • An action in the CIT browser applet failed

  • An action in the CIT browser applet succeeded when it should have failed

TQL Log Files

CMDB Notification Log

The log name is cmdb.notification.log.

Log File Description

Purpose

Notification messages from the time of the component's creation in the CMDB until the client's listener receives a message.

Most components receive configuration changes from the CMDB in push mode, by the notification mechanism, rather than in pull mode.

Information Level

  • Startup and shutdown of publishers

  • Register and unregister remote and internal listeners

Error Level

  • Errors when messages are published

  • Errors when messages are received

Debug Level

  • Unique message ID

  • Number of changes that a message includes as well as more details according to the type of the message (for example, the TQL result version)

  • JMS header properties

Basic Troubleshooting

If an application does not receive a notification, check the following:

  • a listener is registered with the appropriate notification filter

  • a message is published with data that matches this filter

  • a message is received by the listener (use the unique message ID to verify)

Data-In Log Files

CMDB Model Audit Short Log

The log name is cmdb.model.audit.short.log.

Log File Description

Purpose

Information about a CI Type operation: type of operation, data received as input, and what happened to the data in each CIT.

Also contains information about the caller application, execution time, and persistency time.

Information Level Operation details.
Error Level Not available.
Debug Level Not available.

Basic Troubleshooting

If there are no changes when there should be, check the following:

  • Whether the operation exists.

  • Whether the input is correct.

  • What happened to the data. There may have been a false update.

This is especially useful when running DFM to trace the input.

History Log Files

History Log

The log name is history.log.

Log File Description
Purpose Records general history events

Information Level

  • Auto completion events
  • Auto complete table lock/unlock messages
  • Tenants bitmask column size handling
  • Delete customer fuse notice

Debug Level

  • Auto completion details
  • History Root table handling messages

History Audit Update Log

The log name is history.update.audit.log.

Log File Description
Purpose Tracks events saved in the History tables

Information Level

  • Details all events stored in the history tables
  • Event statistics
Debug Level Database statistics

History Partition Log

The log name is history.partition.log.

Log File Description

Purpose

  • Records history partition data.
  • Records the Baseline process events.

Information Level

  • Add/Remove partition history tables
  • Baseline events
  • Baseline statistics

Error Level

  • Table partition failures
  • Baseline process failures

Query History Log

The log name is history.queries.log.

Log File Description
Purpose Records all the queries performed on the history tables.

Information Level

  • Query condition
  • Query results summary
Error Level Fuse exceeded

Debug Level

  • Query condition details
  • Query result details

History Class Model Changes Log

The log name is history.classmodel.changes.log.

Log File Description
Purpose Tracks all the class model changes that affect the history tables.
Information Level Class aligning messages
Error Level Errors that occurred during class aligning

History Purging Log

The log name is history.purge.log.

Log File Description
Purpose Records the History purging process events
Information Level Purging process information
Error Level Errors that occurred during the purging process
Debug Level Details about purged data

Enrichment Log Files

CMDB Enrichment Log

The log name is cmdb.enrichment.log.

Log File Description

Purpose

  • Enrichment definitions: adding, updating, removing, and calculating.

  • Calculation results such as how many CIs were added, how many relationships were removed, and so forth.

  • Supplies the reason for a calculation failure. Failure in a model update, however, is not included since it is an asynchronous execution.

Information Level

  • Add, update, and remove enrichment definitions.

  • Add, update, and remove CIs or relationships to or from a model.

Error Level Calculation failure.
Debug Level Traces the enrichment calculation process.

Basic Troubleshooting

  • If no calculation was carried out, check the definition of add enrichment.

  • If there are no results, check the finish calculate entry.

Dal Log Files

CMDB Dal Log

The log name is cmdb.dal.log.

Log File Description
Purpose Information about activity that occurred in the data access layer, the layer that works with the CMDB.
Information Level Not available.

Error Level

  • Connection pool errors

  • Database errors

  • Command execution errors

Debug Level

  • All DAL commands executed

  • All SQL commands executed

Basic Troubleshooting

If you suspect that CMDB actions are taking too long, check the time spent on queries and updates in the DAL logs and operation logs.

Exception details and ID are entered into the log. The exception ID appears in the exception itself.

Authorization Log Files

CMDB Authorization Management Log

The log name is security.authorization.management.log.

Log File Description
Purpose Audit all modifications related to the authorization model.

Information Level

  • Creation and deletion of users, user groups, tenants, roles, and resource groups.

  • Addition and removal of users from user groups, changes to user passwords, and changes in users' default tenants.

  • Addition and removal of permissions from roles and changes in read-only status of roles.

  • Addition and removal of resources from resource groups.

  • Changes in user role assignments.

  • Changes in resource tenant associations.

Error Level Failure to create or modify authorization resources, such as trying to create a user with an existing name.
Debug Level Web services login requests.
Basic Troubleshooting May be used to track why a user no longer has a specific permission.

CMDB Authorization Permissions Log

The log name is security.authorization.permissions.log.

This log contains detailed information for authorization and out-of-the-box information. To enable the print of information, you may need to set the log level to DEBUG.

Log File Description
Purpose Debug authorization permissions queries.
Debug Level Print all existing permissions for the user currently logged in, whenever they are queried in the server.
Basic Troubleshooting

To check a specific permission issue,turn on the debug level, perform the action in the UI, turn the debug level off, and check the log for the existing permissions of the user.

It is not recommended to keep this log at debug level, because it generates a large amount of printed output.

UCMDB UI Log Files

Client-side Applet Logs

The following client side applet logs are also available:

  • applet-operations.log. Tracks the operations that are executed from the CMDB UI to the UCMDB server.

  • applet-general.log. General log for the UI.

  • applet-cacheStatistics.log. Tracks statistics of the UI cache.

  • applet-missing_resources.log. Missing resources log.

  • applet-applet-tasks.log. Logs task executions.

  • applet-timeMeasure.log. Log for measuring performance.

  • applet-memoryTracker.log. Tracks the memory usage of the UI.

  • applet-errors.log. Logs the errors that occurred in the UI

Note

UCMDB UI log files are present in the %Temp%/UcmdbLog/log folder on the machine from which you access the UCMDB UI.

SAML Authentication Log File

cmdb.samlAuthentication.log

This log file contains all log information related to SAML Authentication. By default, the log level is to set to DEBUG. You can change the log level in the conf/log/cmdb.properties file by updating the following line:

samlAuthentication= DEBUG

Note

For starters, we suggest leaving this log on DEBUG in order to resolve possible problems more easily.

Log File Description
Purpose Log the details related to SAML authentication.

Information Level

The default log level is DEBUG for now.
Error Level Errors that appeared during SAML Authentication.
Debug Level Details related to SAML Authentication, like the request send to IdP, the response received, and so on.
Basic Troubleshooting Errors could appear if the configurations are not done correctly. If anything wrong happens, it will be logged in the file.

 

Data Flow Management Log Files

Data Flow Management log files store information about data flow activity (discovery and integrations), as well as related errors, that occur on the Server side.

mam.AutoDiscovery.log

Contains information about tasks running on the server. The server provides services to the user interface or the Probe Gateway, such as: activating jobs, processing results from the Probe, or creating tasks for the Probe.

Level Description
Error All DFM process errors on the server side.
Information Information about requests being processed.
Debug Logs mainly for debugging purposes.

Basic Troubleshooting. Check this log when you have invalid user interface responses or errors you need to explore. This log provides information to enable you to analyze the problems.

discoveryServlet.log

This log receives messages from:

  • The Collectors Utilities Servlet. The user interface connects to the server through this servlet.

  • The Collectors Servlet. The Probe requests new tasks from the server through this servlet.

  • The Collectors Results Servlet. The Probe sends new results through this servlet.

  • The Collectors Download Servlet. The Probe downloads new server data through this servlet.

Level Description
Error All errors in the servlet.
Information Information about user requests and Probe task requests.

Debug

  • User requests

  • Probe requests to read DFM tasks.

  • Probe access to the servlet.

Basic Troubleshooting

  • User Interface – Server communication problems.

  • Probe – Server communication problems.

Some processing problems may be written to this log instead of to mamAutoDiscovery.log.

mam.autodiscovery.results.stat.log

Contains the statistics of the results received from the Probe.

mam.autodiscovery.accuratedependency.log

(Deprecated) Contains information about accurate dependency for the Automatic Service Modeling feature. This log is related to the old ASM version (before Content Pack 18), and is no longer in use.

mam.dispatch.log

Contains all the dispatch related information.

To enable this log,

  1. Locate and open the <UCMDB_Server_Home>/conf/log/mam.properties file.

  2. Manually add the following settings into the mam.properties file:

    log4j.category.mam.dispatch=${loglevel}, mam.dispatch.appender
    #######################################
    ##   mam.packaging                   ##
    #######################################
    log4j.appender.mam.dispatch.appender=com.mercury.topaz.cmdb.shared.base.log.BetterRollingFileAppender
    log4j.appender.mam.dispatch.appender.File=${logs.dir}/mam.dispatch.log
    log4j.appender.mam.dispatch.appender.MaxFileSize=${def.file.max.size}
    log4j.appender.mam.dispatch.appender.MaxBackupIndex=${def.files.backup.count}
    log4j.appender.mam.dispatch.appender.layout=org.apache.log4j.PatternLayout
    log4j.appender.mam.dispatch.appender.layout.ConversionPattern=${msg.layout}
  3. Save the file.

Autodiscovery Dal Log

The log name is mam.autodiscovery.dal.log.

Log File Description
Purpose Holds information on queries and other actions taken on the server’s database tables as part of the discovery process.
Information Level A summary of actions taken and their results on the database (such as retrieving information, deleting records, and so on).
Error Level All critical errors that occurred during the attempt to access the database.
Debug Level Detailed information on query parameters and/or the results that are retrieved from them
Basic Troubleshooting If there are any database errors or failures (such as connection failed, technical error in the query, and so on), the error log is included in this log file also.

workflow_sizing.log

Enabling this log file helps you to collect running statistics (for example, time spent on normalization and auto delete) of each modules on a probe.

To enable this log, follow these steps:

  1. On the probe, locate and open the /conf/log/probeGWLog4j.properties and /conf/log/probeMgrLog4j.properties files.
  2. Manually add the following settings into each of the above files:

    #######################################
    ### cmdb.workflow.sizing             ##
    #######################################
    log4j.category.cmdb.workflow.sizing=INFO, cmdb_workflow_sizing
    log4j.appender.cmdb_workflow_sizing=com.mercury.topaz.cmdb.shared.base.log.BetterRollingFileAppender
    log4j.appender.cmdb_workflow_sizing.File=${logs.dir}/workflow_sizing.log
    log4j.appender.cmdb_workflow_sizing.Append=true
    log4j.appender.cmdb_workflow_sizing.MaxFileSize=512MB
    log4j.appender.cmdb_workflow_sizing.Threshold=INFO
    log4j.appender.cmdb_workflow_sizing.MaxBackupIndex=10
    log4j.appender.cmdb_workflow_sizing.layout=org.apache.log4j.PatternLayout
    log4j.appender.cmdb_workflow_sizing.layout.ConversionPattern=<%d> [%-5p] [%t] (%F:%L) - %m%n
    log4j.appender.cmdb_workflow_sizing.encoding=UTF-8
  3. Save the files.
  4. Restart the probe.

Sample log

<2015-11-11 13:56:51,459> [INFO ] [ProbeGW Task Results Sender] (TaskResultsSenderThread.java:458) - [TaskResultsSenderThread.handleSuccessTriggers.start][desc=update ID mapping,size=1]
<2015-11-11 13:56:51,460> [INFO ] [ProbeGW Task Results Sender] (TaskResultsSenderThread.java:481) - [TaskResultsSenderThread.handleSuccessTriggers.stop][desc=update ID mapping,size=1]

Probe Auto Upgrade Log

The log name is probe_auto_upgrade.log.

It shows in the C:\UCMDB\DataFlowProbe\runtime\log\probeUpgradeLogs\<source_version>to<target_version> folder. For example: C:\UCMDB\DataFlowProbe\runtime\log\probeUpgradeLogs\10.32to10.33.

This log file is also sent to the UCMDB server and shows as <domain_name>_probename_auto_upgrade.log in the C:\UCMDB\UCMDBServer\runtime\log\probeUpgradeLogs\<source_version>to<target_version>\failed|success folder.

Log File Description
Purpose

Shows the related information when the probe auto upgrade agent upgrades a probe.

Information Level Shows the console output of normal information.
Error Level Any error that occurs when the probe auto upgrade agent upgrades a probe.
Debug Level N/A
Basic Troubleshooting Check this log file when the probe upgrade fails.