Manages all log messages from SDK modules, you can use this logger to add your custom messages and set your custom log handlers to forward all messages to your own monitoring system.

By default all loggers are set in level OFF (Logger.OFF), and there are available the following log levels.

This module is based on js-logger you can refer to its documentation or following our examples.

Source

Examples

// Log a message
Logger.info('This is an info log', 445566)
// [Global] 2021-04-05T15:58:44.893Z - This is an info log 445566
// Create a named logger
const myLogger = Logger.get('CustomLogger')
myLogger.setLevel(Logger.WARN)
myLogger.warn('This is a warning log')
// [CustomLogger] 2021-04-05T15:59:53.377Z - This is a warning log
// Profiling
// Start timing something
Logger.time('Timer name')

// ... some time passes ...

// Stop timing something.
Logger.timeEnd('Timer name')
// Timer name: 35282.997802734375 ms

Members

(inner, constant) DEBUG :LogLevel

Logger.DEBUG

Type:
Source

(inner, constant) ERROR :LogLevel

Logger.ERROR

Type:
Source

(inner, constant) INFO :LogLevel

Logger.INFO

Type:
Source

(inner, constant) OFF :LogLevel

Logger.OFF

Type:
Source

(inner, constant) TIME :LogLevel

Logger.TIME

Type:
Source

(inner, constant) TRACE :LogLevel

Logger.TRACE

Type:
Source

(inner) VERSION

Returns the current SDK version.

Source

(inner, constant) WARN :LogLevel

Logger.WARN

Type:
Source

Methods

(inner) diagnose(statsCountopt) → {Object}

Returns an object with diagnostics about the state of the connection and environment.

Parameters:
NameTypeAttributesDefaultDescription
statsCountNumber<optional>
5

Amount of stats objects to be saved.

Source
Returns:

Relevant information about the current state, such us userAgent, SDK version, besides others.

Type: 
Object
Example
// Log and get a diagnose object with the last 3 stats reports
const diagnostics = await Logger.diagnose(3)

(inner) get(name) → {Object}

Gets or creates a named logger. Named loggers are used to group log messages that refers to a common context.

Parameters:
NameTypeDescription
nameString
Source
Returns:

Logger object with same properties and functions as Logger except history and handlers related functions.

Type: 
Object
Example
const myLogger = Logger.get('MyLogger')
// Set logger level
myLogger.setLevel(Logger.DEBUG)

myLogger.debug('This is a debug log')
myLogger.info('This is a info log')
myLogger.warn('This is a warning log')

// Get logger level
myLogger.getLevel()
// {value: 3, name: 'INFO'}

(inner) getHistory() → {Array.<String>}

Get all logs generated during a session. All logs are recollected besides the log level selected by the user.

Source
Returns:

All logs recollected from level TRACE.

Type: 
Array.<String>
Example
Logger.getHistory()
// Outupt
// [
//   "[Director] 2021-04-05T14:09:26.625Z - Getting publisher connection data for stream name:  1xxx2",
//   "[Director] 2021-04-05T14:09:27.064Z - Getting publisher response",
//   "[Publish]  2021-04-05T14:09:27.066Z - Broadcasting"
// ]

(inner) getHistoryMaxSize()

Get the maximum count of logs preserved during a session.

Source
Example
Logger.getHistoryMaxSize()

(inner) getLevel() → {LogLevel}

Get global current logger level. Also you can get the level of any particular logger.

Source
Returns:
Type: 
LogLevel
Example
// Global Level
Logger.getLevel()
// Output
// {value: 2, name: 'DEBUG'}

// Module Level
Logger.get('Publish').getLevel()
// Output
// {value: 5, name: 'WARN'}

(inner) setHandler(handler, level)

Add your custom log handler to Logger at the specified level.

Parameters:
NameTypeDescription
handlerloggerHandler

Your custom log handler function.

levelLogLevel

Log level to filter messages.

Source
Example
const myHandler = (messages, context) => {
 // You can filter by logger
 if (context.name === 'Publish') {
   sendToMyLogger(messages[0])
 }

 // You can filter by logger level
 if (context.level.value >= Logger.INFO.value) {
   sendToMyLogger(messages[0])
 }
}

Logger.setHandler(myHandler, Logger.INFO)

(inner) setHistoryMaxSize(maxSize)

Set the maximum count of logs to preserve during a session. By default it is set to 10000.

Parameters:
NameTypeDescription
maxSizeNumber

Max size of log history. Set 0 to disable history or -1 to unlimited log history.

Source
Example
Logger.setHistoryMaxSize(100)

(inner) setLevel(level)

Set log level to all loggers.

Parameters:
NameTypeDescription
levelLogLevel

New log level to be set.

Source
Example
// Global Level
Logger.setLevel(Logger.DEBUG)

// Module Level
Logger.get('Publish').setLevel(Logger.DEBUG)