Module : log
Module Overview
This module provides a basic API for logging.
Loggers
Each module in Ballerina has its own dedicated logger. A log record contains the timestamp, log level, module name, and the log message. The printError() function takes an optional error record apart from the log message. A sample log record logged from the foo module would look as follows:
2018-04-09 11:33:21,300 ERROR [foo] - This is an error log.
Log Output
Logs are written to the stderr stream (i.e., the console) by default in order to make the logs more container friendly.
To publish the logs to a file, redirect the stderr stream to a file.
$ ballerina run program.bal 2> b7a-user.log
Log Levels
This module provides functions to log at the WARN, ERROR, INFO, DEBUG, and TRACE levels. By default, all log messages are logged to the console at the INFO level. In addition to these, there are two other levels named OFF and ALL. The OFF log level turns off logging, and the ALL log level allows all log levels. The log level can be configured through the Config API.
The b7a.log.level configuration key can be used to configure the log level for the log API (i.e., for all the modules). The following can be provided in a configuration file.
b7a.log.level="<LOG_LEVEL>"
The log level can also be configured through a CLI parameter as follows:
$ ballerina run program.bal --b7a.log.level=<LOG_LEVEL>
Log levels can be configured for modules either through a configuration file as <MODULE_NAME>.loglevel="<LOG_LEVEL>" or through a CLI parameter as <MODULE_NAME>.loglevel=<LOG_LEVEL>.
Suppose there is a module named foo. We can set the log level of foo to DEBUG in a configuration file by placing the following entry in it:
["<org-name>/foo"]
loglevel="DEBUG"
OR
"<org-name>/foo.loglevel"="DEBUG"
The log level of foo can also be configured through the CLI as follows:
$ ballerina run foo --\"<org-name>/foo.loglevel\"=DEBUG
For information on the operation, which you can perform with this module, see the below Function. For examples on the usage of the operation, see Log Api.
Functions
| printDebug |
Logs the specified value at DEBUG level. |
| printError |
Logs the specified message at ERROR level. |
| printInfo |
Logs the specified message at INFO level. |
| printTrace |
Logs the specified message at TRACE level. |
| printWarn |
Logs the specified message at WARN level. |