View Source

h2. Logging API

The Logging API is used to access the client console logger.

The following Logging APIs are available:

* *{{[ice.log.debug(logger, message, exception)|#debug]}}*
* *{{[ice.log.info(logger, message, exception)|#info]}}*
* *{{[ice.log.warn(logger, message, exception)|#warn]}}*
* *{{[ice.log.error(logger, message, exception)|#error]}}*
* *{{[ice.log.childLogger(parentLogger, categoryName)|#childLogger]}}*

----
\\
{anchor:debug}
{panel}
h4. ice.log.debug(logger, message, exception)

Logs a DEBUG level message to the console or log window.

_Usage:_

{code:javascript}ice.log.debug(ice.log, 'Debug message');{code}
{_}Parameters:_

* logger
bq. The logger.

* message
bq. The message to be logged.

{panel}
\\
{anchor:info}
{panel}
h4. ice.log.info(logger, message, exception)

Logs a INFO level message to the console or log window.

_Usage:_

{code:javascript}ice.log.info(ice.log, 'Info message');{code}
{_}Parameters:_

* logger
bq. The logger.

* message
bq. The message to be logged.

{panel}
\\
{anchor:warn}
{panel}
h4. ice.log.warn(logger, message, exception)

Logs a WARN level message to the console or log window.

_Usage:_

{code:javascript}ice.log.warn(ice.log, 'Warning message');{code}
{_}Parameters:_

* logger
bq. The logger.

* message
bq. The message to be logged.

{panel}
\\
{anchor:error}
{panel}
h4. ice.log.error(logger, message, exception)

Logs a ERROR level message to the console or log window.

_Usage:_

{code:javascript}
try {
...
} catch (e) {
ice.log.error(ice.log, 'Error occurred', e);
}
{code}
{_}Parameters:_

* logger
bq. The logger.

* message
bq. The message to be logged.

* responseDOM
bq. The captured exception. This is an optional parameter.

{panel}
\\
{anchor:childLogger}
{panel}
h4. ice.log.childLogger(parentLogger, categoryName)

Creates an new child logger that logs its messages into the defined category.

_Usage:_

{code:javascript}var a = ice.log.childLogger(ice.log, 'A');
ice.log.debug(a, 'message in category A');
//outputs -- [window.A] debug: message in category A

var aa = ice.log.childLogger(a, 'AA');
ice.log.warn(aa, 'message in category AA');

//outputs -- [window.A.AA] warning: message in category AA
{code}
{_}Parameters:_

* logger
bq. The parent logger.

* categoryName
bq. The name of the category.
{panel}
\\