Transformer Pipeline Module API Reference (JavaScript)  7.1.5.312996
Logging routines

Detailed Description

The log package allows a script to write messages to the pipeline module's log file.

The log file is filtered on log level, and as such messages of a lower level than that the log file is currently set to will be ignored. The following log levels are available

Functions

 log.log (var level, var message)
 Log a message to the pipeline logfile. More...
 
 log.logLine (var level, var message)
 Log a message to the pipeline logfile. More...
 
 log.getLevel ()
 Return the current log level.
 

Function Documentation

log.log ( var  level,
var  message 
)

Log a message to the pipeline logfile.

Parameters
level- Log level
message- Text to log

This function will cause the message to be logged to the pipeline module's logfile at the appropriate level

The following example will log some a message to the pipeline logfile at debug level

var log = require("log");
function myfunc(symbolname)
{
log.log(log.INFO,"This is a message related to symbol " + symbolname);
}
Note
This function will not append a new line character to the end of message.
log.logLine ( var  level,
var  message 
)

Log a message to the pipeline logfile.

Parameters
level- Log level
message- Text to log

This function will cause the message to be logged to the pipeline module's logfile at the appropriate level

Note
This function will append a new line character to the end of message.

Generated on Tue May 14 2019 13:45:48 for Transformer Pipeline Module API Reference (JavaScript)