Troubleshoot with the log4j2 file

The properties in the log4j2.xml file control the level of messages written to Activator system log files. By changing levels, you control the volume of messages written to the logs. Changing levels can be useful in troubleshooting.

System logs contain formatted, time-stamped information reported by various components of the application. Activator uses the Apache Jakarta Project's log4j framework to format and manage the logs. Logs are generated by each Java virtual machine during runtime. For information about Apache logging services, see .

The log4j2.xml file is located in <Activator_install_directory>\Activator\conf. You can edit this file to generate debug level events in Activator log files.

You do not need to restart the server after changing levels for message categories. You do need to restart the server if you add or delete a property.

Caution   To use log files to monitor processing or to troubleshoot you must have advanced knowledge of the system.

The logging level settings you can use in this file are, from lowest to highest verbosity:

  • Error – Error messages indicate a possibly serious error affecting service.
  • Warn – Warn messages typically have operational significance, but may not affect service.
  • Info – Info messages provide general processing information that could be useful in troubleshooting.
  • Debug – Debug messages usually have much detailed information that can be useful in troubleshooting. This level should be turned on only when necessary, as it can degrade system performance and use large amounts of disk space.

These four logging levels are cumulative: Error messages are included at the warn level, both error and warn messages are included at the info level, and everything is logged at the debug level. The debug level also produces more details per message.

Changing the log level of a category changes the level of all categories beneath it that do not have a logging level explicitly specified. For example, setting category “com.foo” to debug also sets “com.foo.fum” to debug, unless there is an explicit entry for “com.foo.fum.”

The following list describes commonly used categories, from general to more specific. In the event that you are troubleshooting issues with the assistance of Axway support, you may be asked to add even more specific categories, not listed here.

Once you set a category to a different level (for example, from info to warn), the level remains in effect until you set the category to something else. Removing or commenting out the category does not reset its level, unless the server is restarted. For this reason, if you add a category and set it to a verbose level (for example, debug), we recommend that when you are done debugging, you reset it to the info level, rather than removing the added category. Otherwise, you would have to wait until the server is restarted for the verbose logging to stop.

You can change the levels of the following message categories.

Server messages

  • log4j.category.com.axway=info – A main message category. Includes all system log messages for all levels below this one.
  • log4j.category.com.cyclonecommerce=info – A main message category. Includes all system log messages for all levels below this one.
  • log4j.category.com.cyclonecommerce.alerts.AlertDefinitionsManager=info – Messages related to Alert system activity
  • log4j.category.com.cyclonecommerce.clustercontroller=info – Messages related to system startup and clustering.
  • log4j.category.com.cyclonecommerce.crossworks=info – Messages related to certificate and cryptographic operations.
  • log4j.category.com.cyclonecommerce.ediintmsg=info – Messages related to EDIINT messages (AS2).
  • log4j.category.com.cyclonecommerce.messageprotocols=info – Messages related to protocol sender and receiver operations.
  • log4j.category.com.cyclonecommerce.persistence=info – Messages related to persistence.
  • log4j.category.com.cyclonecommerce.tradingengine=info – Messages related to the handling and routing of messages within the trading engine core.
  • log4j.category.com.cyclonecommerce.tradingengine.transport.email.pop=info – Messages related to SMTP/POP delivery exchange.
  • log4j.category.com.cyclonecommerce.tradingengine.transport.email.smtp=info – Messages related to SMTP delivery exchange.
  • log4j.category.com.cyclonecommerce.tradingengine.transport.Polling=info – Messages specifically related to transport polling. Set to debug to log a message each time a transport is polled (every 60 seconds by default).
  • log4j.category.com.cyclonecommerce.tradingengine.transport.system=info – Messages related to the transport subsystem (consumers and producers).
  • log4j.category.com.cyclonecommerce.txm.clusteradmin.service.RestartManager=info – Messages related to document queue processing and restart states.
  • log4j.category.com.cyclonecommerce.util=info – Messages from utility classes.

Database messages

These are messages related to the database interface, OpenJPA. Typically these properties should only be changed under direction of technical support.

  • log4j.category.OpenJPA.DataCache=warn
  • log4j.category.OpenJPA.Enhance=warn
  • log4j.category.V.jdbc.JDBC=warn
  • log4j.category.OpenJPA.jdbc.Schema=warn
  • log4j.category.OpenJPA.jdbc.SQL=warn
  • log4j.category.OpenJPA.MetaData=warn
  • log4j.category.OpenJPA.Query=warn
  • log4j.category.OpenJPA.Remote=warn
  • log4j.category.OpenJPA.Runtime=error
  • log4j.category.OpenJPA.Tool=warn
  • log4j.category.net.sf.ehcache.store.DiskStore=fatal

HTTP messages

To troubleshoot HTTP issues, change the levels of all of the following properties to debug.

  • log4j.category.com.cyclonecommerce.collaboration.transport.http=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.http=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.http.server=info
  • log4j.category.com.axway.transport.http.server=info
  • log4j.category.org.mortbay=info

FTP messages

To troubleshoot FTP issues, change the levels of all of the following properties to debug.

  • log4j.category.com.cyclonecommerce.collaboration.transport.ftp=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.ftp=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.ftp.SimpleDebug=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.ftp.server=info
  • log4j.category.org.apache.ftpserver=info

SFTP client messages

To troubleshoot issues for trading with partners using external SFTP servers, change the levels of all of the following properties to debug.

  • log4j.category.com.cyclonecommerce.collaboration.transport.sftp=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.sftp=info
  • log4j.category.com.sshtools=info

SFTP server messages

To troubleshoot issues for trading with partners using embedded SFTP servers, change the levels of all of the following properties to debug.

  • log4j.category.com.cyclonecommerce.collaboration.transport.sftp.server=info
  • log4j.category.com.cyclonecommerce.collaboration.transport.ssh.server=info
  • log4j.category.com.cyclonecommerce.tradingengine.transport.ssh.server=info
  • log4j.category.com.maverick.sshd=info

PeSIT server messages

To troubleshoot issues for trading with partners using embedded PeSIT servers, change the level of the following property to debug.

  • log4j.category.com.cyclonecommerce.tradingengine.transport.pesit=info

SSH nodes messages

To troubleshoot SSH nodes issues, change the level of the following property to debug.

  • log4j.category.com.maverick=info
  • log4j.category.com.axway.xsr.log.listenOnce=error
  • log4j.category.com.axway.xsr.log.outcall=error

Related Links