sys.logs

Describes utilities in the Javascript API to write logs.

sys.logs

The sys.logs package provides methods for logging application events. These logs are accessible in the app monitor, serving as valuable tools to understand your app’s activities.

You have the option to set up your app to generate alerts when error or warning messages are logged. This proactive approach aids in monitoring your app effectively.

info(message,exception)

This method logs a message at the INFO level.

Parameters
NameTypeRequiredDescription
messagestringyesThe message to be logged.
exceptionsys.exceptions.ScriptException or ErroryesOptional. An associated exception, if applicable.
Samples
// logs something in the app
sys.logs.info('this is a test info log');

warn(message,exception)

This method logs a message at the WARN level.

Parameters
NameTypeRequiredDescription
messagestringyesThe message to be logged.
exceptionsys.exceptions.ScriptException or ErroryesOptional. An associated exception, if applicable.
Samples
// logs something in the app
sys.logs.warn('this is a test warn log');

error(message,exception)

This method logs a message at the ERROR level.

Parameters
NameTypeRequiredDescription
messagestringyesThe message to be logged.
exceptionsys.exceptions.ScriptException or ErroryesOptional. An associated exception, if applicable.
Samples
// logs something in the app
sys.logs.error('this is a test error log');

// catches an exception and logs a message with the exception
try {
  sys.data.find('entityThatDoesNotExist', {});
} catch (e) {
  sys.logs.error('there was an error when doing query', e);
}

debug(message,exception)

This method logs a message at the DEBUG level for development purposes. Please note that this service functions exclusively in the Development environment.

Parameters
NameTypeRequiredDescription
messagestringyesThe message to be logged.
exceptionsys.exceptions.ScriptException or ErroryesOptional. An associated exception, if applicable.
Samples
// logs something in the app
sys.logs.debug('this is a test debug log');