Class OINOLog`Abstract`

Abstract base class for logging implementations supporting

error, warning, info and debug channels
setting level of logs outputted

Hierarchy (View Summary)

OINOLog
- OINOConsoleLog

Index

Constructors

constructor

Methods

debug error exception exportLogLevels importLogLevels info setInstance setLogLevel setLogLevels warning

Constructors

constructor

new OINOLog(logLevel?: OINOLogLevel): OINOLog
Abstract logging method to implement the actual logging operation.
Parameters
- logLevel: OINOLogLevel = OINOLogLevel.warning
  default loglevel for all log events
Returns OINOLog
- Defined in common/src/OINOLog.ts:42

Methods

`Static`debug

debug(
    domain: string,
    channel: string,
    method: string,
    message: string,
    data?: any,
): void
Log debug event. Debug events are prettyprinted.
Parameters
- domain: string
  domain of the log event
- channel: string
  channel of the log event
- method: string
  method of the log event
- message: string
  message of the log event
- Optionaldata: any
  structured data associated with the log event
Returns void
- Defined in common/src/OINOLog.ts:189

`Static`error

error(
    domain: string,
    channel: string,
    method: string,
    message: string,
    data?: any,
): void
Log error event. Error events are printed as a single line.
Parameters
- domain: string
  domain of the log event
- channel: string
  channel of the log event
- method: string
  method of the log event
- message: string
  message of the log event
- Optionaldata: any
  structured data associated with the log event
Returns void
- Defined in common/src/OINOLog.ts:147

`Static`exception

exception(
    domain: string,
    channel: string,
    method: string,
    message: string,
    data?: any,
): void
Log exception event. Exception events are prettyprinted and preserve newlines so that stack traces are readable.
Parameters
- domain: string
  domain of the log event
- channel: string
  channel of the log event
- method: string
  method of the log event
- message: string
  message of the log event
- Optionaldata: any
  structured data associated with the log event
Returns void
- Defined in common/src/OINOLog.ts:132

`Static`exportLogLevels

exportLogLevels(): any[]
Get current log levels as an array of objects with domain, channel, method and level.

Returns any[]
- Defined in common/src/OINOLog.ts:197

`Static`importLogLevels

importLogLevels(logLevels: any[]): void
Import log levels from an array of objects with domain, channel, method and level resetting existing values (i.e. non-existing values get removed).
Parameters
- logLevels: any[]
  array of log level objects
Returns void
- Defined in common/src/OINOLog.ts:243

`Static`info

info(
    domain: string,
    channel: string,
    method: string,
    message: string,
    data?: any,
): void
Log info event. Info events are printed as a single line.
Parameters
- domain: string
  domain of the log event
- channel: string
  channel of the log event
- method: string
  method of the log event
- message: string
  message of the log event
- Optionaldata: any
  structured data associated with the log event
Returns void
- Defined in common/src/OINOLog.ts:175

`Static`setInstance

setInstance(instance: OINOLog): void
Set active logger instance.
Parameters
- instance: OINOLog
  OINOLog instance
Returns void
- Defined in common/src/OINOLog.ts:94

`Static`setLogLevel

setLogLevel(
    logLevel: OINOLogLevel,
    domain?: string,
    channel?: string,
    method?: string,
): void
Set log level for given combination of domain/channel/method. Not defining dimension(s) means they match any value. Multiple settings can be combined to set different logging accuracy specifically

For example: logLevel: warning, domain: *, channel: , method: * will only output error events. logLevel: debug, domain: d1, channel: c1, method: "" will enable debug events for channel c1 of domain d1. logLevel: info, domain: d1, channel: c1, method: m1 will supress debug events for method m1.
Parameters
- logLevel: OINOLogLevel
  log level to use
- domain: string = ""
  domain of the log event (default: "*" for all)
- channel: string = ""
  channel of the log event (default: "*" for all)
- method: string = ""
  method of the log event (default: "*" for all)
Returns void
- Defined in common/src/OINOLog.ts:116

`Static`setLogLevels

setLogLevels(logLevels: any[]): void
Set log levels from an array of objects with domain, channel, method and level overwriting existing values (i.e. non-existing values are not affected).
Parameters
- logLevels: any[]
  array of log level objects
Returns void
- Defined in common/src/OINOLog.ts:223

`Static`warning

warning(
    domain: string,
    channel: string,
    method: string,
    message: string,
    data?: any,
): void
Log warning event. Warning events are printed as a single line.
Parameters
- domain: string
  domain of the log event
- channel: string
  channel of the log event
- method: string
  method of the log event
- message: string
  message of the log event
- Optionaldata: any
  structured data associated with the log event
Returns void
- Defined in common/src/OINOLog.ts:161

Class OINOLogAbstract

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OINOLog

Methods

Staticdebug

Parameters

Returns void

Staticerror

Parameters

Returns void

Staticexception

Parameters

Returns void

StaticexportLogLevels

Returns any[]

StaticimportLogLevels

Parameters

Returns void

Staticinfo

Parameters

Returns void

StaticsetInstance

Parameters

Returns void

StaticsetLogLevel

Parameters

Returns void

StaticsetLogLevels

Parameters

Returns void

Staticwarning

Parameters

Returns void

Settings

On This Page

Class OINOLog`Abstract`

`Static`debug

`Static`error

`Static`exception

`Static`exportLogLevels

`Static`importLogLevels

`Static`info

`Static`setInstance

`Static`setLogLevel

`Static`setLogLevels

`Static`warning