Interface IDiagnosticLogger

interface IDiagnosticLogger {
    consoleLoggingLevel: (() => number);
    debugToConsole?(message: string): void;
    errorToConsole?(message: string): void;
    logInternalMessage?(severity: number, message: _InternalLogMessage): void;
    queue: _InternalLogMessage[];
    resetInternalMessageCount(): void;
    throwInternal(severity: number, msgId: number, msg: string, properties?: Object, isUserAct?: boolean): void;
    unload?(isAsync?: boolean): void | IPromise<void>;
    update?(updateState: ITelemetryUpdateState): void;
    warnToConsole(message: string): void;
}

Implemented by

DiagnosticLogger

Index

Properties

consoleLoggingLevel queue

Methods

debugToConsole? errorToConsole? logInternalMessage? resetInternalMessageCount throwInternal unload? update? warnToConsole

Properties

consoleLoggingLevel

consoleLoggingLevel: (() => number)

0: OFF 1: only critical (default) 2: critical + info

queue

queue: _InternalLogMessage[]

The internal logging queue

Methods

`Optional`debugToConsole

debugToConsole(message): void
This will write a debug message to the console if possible
Parameters
- message: string
  {string} - The debug message
Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:33

`Optional`errorToConsole

errorToConsole(message): void
This will write an error to the console if possible. Provided by the default DiagnosticLogger instance, and internally the SDK will fall back to warnToConsole, however, direct callers MUST check for its existence on the logger as you can provide your own IDiagnosticLogger instance.
Parameters
- message: string
  The error message
Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:47

`Optional`logInternalMessage

logInternalMessage(severity, message): void
Logs a message to the internal queue.
Parameters
- severity: number
  The severity of the log message
- message: _InternalLogMessage
  The message to log.
Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:59

resetInternalMessageCount

resetInternalMessageCount(): void
Resets the internal message count

Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:52

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
  The severity of the log message
- msgId: number
- msg: string
- Optionalproperties: Object
- OptionalisUserAct: boolean
Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:27

`Optional`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
- OptionalisAsync: 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.
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:75

`Optional`update

update(updateState): void
Optional Callback hook to allow the diagnostic logger to update it's configuration
Parameters
- updateState: ITelemetryUpdateState
Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:65

warnToConsole

warnToConsole(message): void
This will write a warning to the console if possible
Parameters
- message: string
  The warning message
Returns void
- Defined in JavaScriptSDK.Interfaces/IDiagnosticLogger.ts:39