Specifying Log File Details

About this task

Log files created during backup and restore are used to monitor the process and diagnose problems encountered during the process. You can specify the required level of log and the location where the log file must be saved using the following parameters with the apigatewayUtil script:

Parameter Description

logLevel

Parameter	Description
logLevel	Allows you to specify the required level of log that you want to create. Log levels indicate the severity of logs. Available levels are: Info. Provides the list of regular events that occur during the process. These events are informative. Debug. Provides the events that could be useful, if you have to debug the process. Warning. Indicates unexpected events that occurred during the process. Usually, these events do not interrupt or have an immediate effect on the process. Error. Indicates the events that stop the functionality from working as designed. Trace. Provides a much detailed events that could be useful for debugging. You can specify one of the log level with the logLevel parameter. For example, to create a log file of `Warning` level when listing backup files, you can run the following command: `apigatewayUtil.bat list backup -logLevel warning` When you provide Error as the log level, then only the error level logs are saved. When you provide Debug as the log level, then Debug, Info, Warning and Error level logs are saved. When you provide Trace as log level, then all level logs are saved. This parameter is optional. If you do not specify the parameter, then the Info level logs are saved by default.
logFileLocation	Allows you to provide the location where you want to save the log file. For example, to save the log file in C:/apiglogs/backups, you can provide the location as seen in the following example: `apigatewayUtil.bat create backup -name samplebackup -logFileLocation C:/apiglogs/backups` This parameter is optional. If you do not specify the parameter, the logs are saved in the following location `SAGInstallDir`/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/logs/APIGWUtility.log.

Allows you to specify the required level of log that you want to create. Log levels indicate the severity of logs. Available levels are:

Info. Provides the list of regular events that occur during the process. These events are informative.
Debug. Provides the events that could be useful, if you have to debug the process.
Warning. Indicates unexpected events that occurred during the process. Usually, these events do not interrupt or have an immediate effect on the process.
Error. Indicates the events that stop the functionality from working as designed.
Trace. Provides a much detailed events that could be useful for debugging.

You can specify one of the log level with the logLevel parameter. For example, to create a log file of Warning level when listing backup files, you can run the following command:

apigatewayUtil.bat list backup -logLevel warning

When you provide Error as the log level, then only the error level logs are saved. When you provide Debug as the log level, then Debug, Info, Warning and Error level logs are saved. When you provide Trace as log level, then all level logs are saved.

This parameter is optional. If you do not specify the parameter, then the Info level logs are saved by default.

logFileLocation

Allows you to provide the location where you want to save the log file.

For example, to save the log file in C:/apiglogs/backups, you can provide the location as seen in the following example:

apigatewayUtil.bat create backup -name samplebackup 
-logFileLocation C:/apiglogs/backups

This parameter is optional. If you do not specify the parameter, the logs are saved in the following location SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/logs/APIGWUtility.log.