Configuring Logging in the Installation Directory
Use this procedure to configure a new log appender with log file name, log file location, and logging levels on both, ActiveTransfer Server and ActiveTransfer Gateway.
To configure
ActiveTransfer logging
1. In ActiveTransfer Server installation, navigate to the following directory:
Integration Server_directory \IS_default\configuration\logging
2. Using a text editor, open the log4j2.properties file.
3. Follow these steps to configure the log appender, which specifies the log file name, log file location, and global log level:
a. Ensure that the following entries are present. If not, then add them:
logger.mft.name = com.softwareag.mft
logger.mft.level = info
logger.mft.additivity = false
logger.mft.appenderRef.rolling.ref = ActiveTransfer.RollingLogFile
appender.mft.type = RollingFile
appender.mft.name = ActiveTransfer.RollingLogFile
appender.mft.fileName =
Integration Server_directory
\profiles\IS_default\logs/ActiveTransfer.log
appender.mft.filePattern =
Integration Server_directory
\profiles\IS_default\logs\ActiveTransfer-%i.log.gz
appender.mft.layout.type = PatternLayout
appender.mft.layout.pattern = %d{DEFAULT} %-5p [%-40.60c{10}]
[%scgMsgKey] - %m%n
appender.mft.policies.type = Policies
appender.mft.policies.size.type = SizeBasedTriggeringPolicy
appender.mft.policies.size.size=10MB
appender.mft.strategy.type = DefaultRolloverStrategy
appender.mft.strategy.max = 10
b. In the log appender, make suitable modifications to the log file name, log file location, and global log level:
appender.mft.fileName = Integration Server_directory \profiles\IS_default\logs\ActiveTransfer.log |
| Provides the log file location and log file name. Make the following modifications: In place Integration Server_directory , specify the exact Integration Server installation directory, or provide any other location of your choice for the log file. If required, you can modify the default log file name, ActiveTransfer.log, to a file name of your choice. |
logger.mft.level = info |
| Is the default log level. You can modify it, if required. The possible log levels are: fatal: Severe errors that might cause ActiveTransfer to abort. error: Errors that caused during the execution of ActiveTransfer operations. info: Informational messages about ActiveTransfer events. warn: Non-critical errors that might potentially lead to unexpected results. debug: Debug information for errors and analysis. trace: Trace information for analysis. off: Turn off logging. If you turn off logging important log messages are not logged. Not recommended at the global level. If you use off, important log messages are not logged. Software AG does not recommend its use at the global level. trace and debug log levels will result in large amount of log messages for analysis. |
Note: If you omit the next step, the global setting for the log level is applied to all modules unless you set the log modules from the user interface. For details on how set up audit logging for modules or sub-modules from the user interface, see
Setting Up Audit Logging from the
My webMethods User Interface.
4. To specify specific log levels for a module or sub-module, add the following logger entries for the relevant modules or sub-modules:
logger.module_submodule.name = value
logger.module_submodule.level = info
Where, module or sub-module can be:
Module | Sub-Module | Value |
Port | | com.softwareag.mft.port |
Port | ftp | com.softwareag.mft.port.ftp |
Port | sftp | com.softwareag.mft.port.sftp |
Port | http | com.softwareag.mft.port.http |
Port | message | com.softwareag.mft.port.message |
Event | | com.softwareag.mft.event |
External_Session | | com.softwareag.mft.external.session |
External_Session | ftp | com.softwareag.mft.external.session.ftp |
External_Session | sftp | com.softwareag.mft.external.session.sftp |
External_Session | http | com.softwareag.mft.external.session.http |
External_Session | file | com.softwareag.mft.external.session.file |
Asset | | com.softwareag.mft.asset |
Common | | com.softwareag.mft.common |
Database | | com.softwareag.mft.database |
Tunnel | | com.softwareag.mft.acceleration |
Gateway | | com.softwareag.mft.gateway |
Security | | com.softwareag.mft.security |
If you do not specify the sub-module, then the log levels of a module is applicable to all the sub-modules of the module. For example, the log level for Port is applicable to Port, Port_ftp, Port_sftp, Port_http, and Port_message.
The messages related to the communication between
ActiveTransfer Server and
ActiveTransfer Gateway are logged in the Port and External Session modules in
ActiveTransfer Gateway. The default log level for these messages is
debug.
The messages related to the communication between an external client and
ActiveTransfer Server or
ActiveTransfer Gateway are logged in the Port module. These messages include commands interchanged, response to commands, and HTTP(S) request and response headers. The Port module is also used to log messages related to the communication between
ActiveTransfer Server and
ActiveTransfer Gateway in
ActiveTransfer Server. The default log level for these messages is
debug.
Example:
To get trace level logs for all FTP user sessions, add the following logger entries:
logger.external_Ftp.name = com.softwareag.mft.external.session.ftp
logger.external_Ftp.level = trace
5. Repeat the procedure in the ActiveTransfer Gateway installation.