Class DiagnosticLogger

constructor

• new DiagnosticLogger(config?): DiagnosticLogger

• Parameters

  • Optional config: IConfiguration

  Returns DiagnosticLogger

identifier

queue

consoleLoggingLevel

• consoleLoggingLevel(): number

• 0: OFF (default) 1: CRITICAL 2: >= WARNING

  Returns number

debugToConsole

• debugToConsole(message): void

• This will write a debug message to the console if possible

  Parameters

  • message: string

    {string} - The debug message

  Returns void

errorToConsole

• errorToConsole(message): void

• This will write an error to the console if possible

  Parameters

  • message: string

    {string} - The warning message

  Returns void

logInternalMessage

• logInternalMessage(severity, message): void

• Logs a message to the internal queue.

  Parameters

  • severity: number

    {LoggingSeverity} - The severity of the log message

  • message: _InternalLogMessage

    {_InternalLogMessage} - The message to log.

  Returns void

resetInternalMessageCount

• resetInternalMessageCount(): void

• Resets the internal message count

  Returns void

throwInternal

• throwInternal(severity, msgId, msg, properties?, isUserAct?): void

• This method will throw exceptions in debug mode or attempt to log the error as a console warning.

  Parameters

  • severity: number

    {LoggingSeverity} - The severity of the log message

  • msgId: number

  • msg: string

  • Optional properties: Object

  • Optional isUserAct: boolean

  Returns void

unload

• unload(isAsync?): void | IPromise<void>

• Unload and remove any state that this IDiagnosticLogger may be holding, this is generally called when the owning SDK is being unloaded.

  Parameters

  • Optional isAsync: boolean

    Can the unload be performed asynchronously (default)

  Returns void | IPromise<void>

  If the unload occurs synchronously then nothing should be returned, if happening asynchronously then the function should return an IPromise / Promise to allow any listeners to wait for the operation to complete.

warnToConsole

• warnToConsole(message): void

• This will write a warning to the console if possible

  Parameters

  • message: string

    {string} - The warning message

  Returns void