Class Logger

Logger for AMC's DaVinci Apps. Logs are sent to cloud. Currently there is no way for 3rd party apps to make use of this.

Hierarchy

AbstractLogger
- Logger

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Logger(logSource: LOG_SOURCE | string, isDev?: boolean, apiUrl?: string): Logger

Overrides AbstractLogger.constructor
- Defined in src/app/api/Logger/Logger.ts:25
Parameters
- logSource: LOG_SOURCE | string
- Default value isDev: boolean = false
- Default value apiUrl: string = null
Returns Logger

Properties

Protected _isDev

_isDev: boolean = false

Protected _logLevel

_logLevel: LOG_LEVEL = LOG_LEVEL.Information

Protected _logSource

_logSource: string

Private _logger

_logger: AbstractLogger

config

config: ILoggerConfiguration

Protected timerId

timerId: number = null

Static Protected ApiServiceUrl

ApiServiceUrl: string = null

Static tabId

tabId: string = "00000000-0000-0000-0000-000000000000"

Accessors

apiUrl

get apiUrl(): string
set apiUrl(apiUrl: string): void

Inherited from AbstractLogger.apiUrl
- Defined in src/app/api/Logger/AbstractLogger.ts:49
Returns string
Inherited from AbstractLogger.apiUrl
- Defined in src/app/api/Logger/AbstractLogger.ts:53
Parameters
- apiUrl: string
Returns void

isDev

get isDev(): boolean
set isDev(isDev: boolean): void

Inherited from AbstractLogger.isDev
- Defined in src/app/api/Logger/AbstractLogger.ts:58
Returns boolean
Inherited from AbstractLogger.isDev
- Defined in src/app/api/Logger/AbstractLogger.ts:62
Parameters
- isDev: boolean
Returns void

logLevel

get logLevel(): LOG_LEVEL
set logLevel(logLevel: LOG_LEVEL): void

Inherited from AbstractLogger.logLevel
- Defined in src/app/api/Logger/AbstractLogger.ts:33
Returns LOG_LEVEL
Inherited from AbstractLogger.logLevel
- Defined in src/app/api/Logger/AbstractLogger.ts:37
Parameters
- logLevel: LOG_LEVEL
Returns void

logSource

get logSource(): string
set logSource(logSourceIn: LOG_SOURCE | string): void

Inherited from AbstractLogger.logSource
- Defined in src/app/api/Logger/AbstractLogger.ts:41
Returns string
Inherited from AbstractLogger.logSource
- Defined in src/app/api/Logger/AbstractLogger.ts:45
Parameters
- logSourceIn: LOG_SOURCE | string
Returns void

Methods

clearTimeOutForLogger

clearTimeOutForLogger(): void

Inherited from AbstractLogger.clearTimeOutForLogger
- Defined in src/app/api/Logger/AbstractLogger.ts:266
Returns void

Protected generateLogObj

generateLogObj(logLevel: LOG_LEVEL, errorCode: ERROR_CODE, message: string, localTime?: Date): LogObj

Inherited from AbstractLogger.generateLogObj
- Defined in src/app/api/Logger/AbstractLogger.ts:322
Captures all log record information as a LogObj object

memberof

AbstractLogger

Parameters
- logLevel: LOG_LEVEL
  
  Log Level of log record
- errorCode: ERROR_CODE
  
  Classification of error
- message: string
  
  Content of log record
- Default value localTime: Date = new Date()
Returns LogObj

{LogObj} Wrapper object for log record

Protected getTabIdFromSession

getTabIdFromSession(): void

Inherited from AbstractLogger.getTabIdFromSession
- Defined in src/app/api/Logger/AbstractLogger.ts:279
Retrieves the session ID from browser session storage, or generates a new one if not already present. The session ID helps to differentiate app logs if duplicate instances of the parent DaVinci App are loaded in multiple tabs.

memberof

AbstractLogger

Returns void

logCritical

logCritical(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logCritical
- Defined in src/app/api/Logger/Logger.ts:90
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

logCriticial

logCriticial(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Inherited from AbstractLogger.logCriticial
- Defined in src/app/api/Logger/AbstractLogger.ts:214
Create a CRITICAL log. Deprecated, behaves the same as logCritical()

deprecated

memberof

AbstractLogger

Parameters
- message: string
  
  Content of log record
- Default value errorCode: ERROR_CODE = ERROR_CODE.Other
  
  Error classification
- Default value localTime: Date = new Date()
  
  Local time when log record was generated
Returns void

logDebug

logDebug(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logDebug
- Defined in src/app/api/Logger/Logger.ts:74
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

logError

logError(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logError
- Defined in src/app/api/Logger/Logger.ts:86
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

logInformation

logInformation(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logInformation
- Defined in src/app/api/Logger/Logger.ts:78
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

logLoop

logLoop(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logLoop
- Defined in src/app/api/Logger/Logger.ts:66
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

logTrace

logTrace(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logTrace
- Defined in src/app/api/Logger/Logger.ts:70
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

logWarning

logWarning(message: string, errorCode?: ERROR_CODE, localTime?: Date): void

Overrides AbstractLogger.logWarning
- Defined in src/app/api/Logger/Logger.ts:82
Parameters
- message: string
- Optional errorCode: ERROR_CODE
- Optional localTime: Date
Returns void

pushLogs

pushLogs(): void

Overrides AbstractLogger.pushLogs
- Defined in src/app/api/Logger/Logger.ts:94
Returns void

pushLogsAsync

pushLogsAsync(): Promise<void>

Overrides AbstractLogger.pushLogsAsync
- Defined in src/app/api/Logger/Logger.ts:98
Returns Promise<void>

setConfiguration

setConfiguration(config: ILoggerConfiguration): void

Overrides AbstractLogger.setConfiguration
- Defined in src/app/api/Logger/Logger.ts:34
Parameters
- config: ILoggerConfiguration
Returns void

Protected syncLogLevel

syncLogLevel(): void

Inherited from AbstractLogger.syncLogLevel
- Defined in src/app/api/Logger/AbstractLogger.ts:343
This method will sync the logLevel with account level log level of the logged in user. User has to be logged in before calling this method.

Returns void

Protected uuidv4

uuidv4(): string

Inherited from AbstractLogger.uuidv4
- Defined in src/app/api/Logger/AbstractLogger.ts:298
Generates a random UUID. Method of generation is not secure. Only use this method to generate UUIDs if the UUID cannot be used to compromise data and system security.

memberof

AbstractLogger

Returns string

{string} A randomly generated UUID

Generated using TypeDoc