Software AG Products 10.11 | Administrating API Gateway | Operating API Gateway | General Administration Configuration | Application Log Configurations | Configuring Log Levels
 
Configuring Log Levels
You can configure the log level settings to specify the level of detail that you want to capture in the logs.
The log level settings that you can specify are described below. Each logging level includes the indicated type of message and all messages from the levels above it (for example, the Warn level includes Fatal, Error, and Warn messages).
Log Level
API Gateway Server records these entries
Examples
Fatal
Failures that end operations in such a way that the operations cannot successfully continue without user intervention. Failure is very likely to affect other operations or products.
Product cannot read its configuration file and has no default settings.
Error
Same as Fatal, except that existing error handling renders the failure unlikely to affect other operations or products.
Business process step failed due to a service error caused by bad input data.
Warn
Problems that do not end operations, or unexpected or unusual conditions that might signal impending failure.
Multiple registered JMX servers were discovered where only one is needed.
Info
Success of an event that you need to know about.
Package was loaded, or connection was pool initialized.
Debug
Code-level statements recording unusual conditions or decisions that might lead to errors.
Expects an object to be initialized but it is not, or hash table is empty.
Trace
Code-level statements recording the state and flow of the program during normal execution.
Entry or exit method, or local and global object state.
Off
No information for the product or facility is written to the server log.
Prerequisite:You must have the Manage general administration configurations functional privilege to configure log levels.
*To configure log levels
1. Expand the menu options icon in the title bar, and select Administration.
2. Select General > Application logs.
3. In the Log level configuration section, configure the following parameters:
Log file type
Description
Log file source
API Gateway
This setting sets the API Gateway server log level. API Gateway server logs contain information on the API Gateway UI related activities. API Gateway server logs also contain information on the start-up activity of API Gateway server and its functioning, its state and activities related to connections to various components.
Select a log level that you want to configure to collect required logs.
The available log levels are: off, trace, debug, info, warn, error, fatal.
By default, the log level for API Gateway server logs are set as info.
Note:
Changing the log level of API Gateway server logs sets that value of log level for all the log components of API Gateway. If you want to set a different log level for a particular log components, then log into Integration Server user interface, click Logs > Logging Configuration > Sever Logger > API Gateway, then select the log level that you want to set for the corresponding log component.
Install_Dir/IntegrationServer/instances/default/logs/server.log
API Gateway Data Store logs
This setting sets the API Data Store log level. This contains log files of API Data Store. All API Gateway assets such as API, application, alias, and so on that are stored in API Data Store are logged based on this setting.
Select a log level that you want to configure to collect required logs.
The available log levels are: off, debug, info, warn, error, fatal.
By default, the log level for API Data Store logs are set as info.
Install_Dir/InternalDataStore/logs/SAG_EventDataStore.log
Dashboard
This setting sets the log level for dashboard logs. These logs contain information regarding dashboard-related activities and the Kibana log files that are included in API Gateway.
Select a log level that you want to configure to collect required logs.
The available log levels are: silent, quiet, verbose.
*Select silent to suppress all logging output.
*Select quite to suppress all logging output except for error messages.
*Select verbose to log all events, including system usage information and all requests.
By default, the log level for dashboard logs are set as quiet.
Install_Dir/profiles/IS_instance_name/apigateway/dashboard/startup.log
Security
API Gateway generates security logs when you enable this. These logs contain information on security-related administrative and operational events. For example, changes to authorization, authentication, port settings, password restrictions, attempts to log on to API Gateway and to access API Gateway services, and so on.
Select the checkbox to enable the collection of security logs.
Install_Dir/IntegrationServer/instances/default/logs/WMSECURITY*.log
Session
API Gateway generates session logs when you enable this. These logs contain information on sessions activated on API Gateway and provide data on when sessions start, their current status, their duration, and so on.
Select the checkbox to enable the collection of session logs.
Install_Dir/IntegrationServer/instances/default/logs/WMSESSION*.log
Platform
This setting sets the log level for API Gateway platform logs.
Select a log level that you want to configure to collect required logs.
The available log levels are: off, trace, debug, info, warn, error, fatal.
By default, the log level for platform logs are set as info.
Note:
Whenever you change the log level settings for the API Gateway platform logs, make sure you restart API Gateway for the changes to take effect.
Install_Dir/ profiles/IS_instance_name/logs/sag-osgi.log
4. Click Save.
This configures the log levels for the various log file types that can be downloaded as an archive.