Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractLogger

Abstract Class for AMC Logger objects. Implementations of this interface report DaVinci App logs through various methods and mediums.

export
abstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates an instance of AbstractLogger.

    memberof

    AbstractLogger

    Parameters

    • logSource: LOG_SOURCE | string

      Name of DaVinci App which owns this Logger instance

    • Default value isDev: boolean = false
    • Default value apiUrl: string = null

    Returns AbstractLogger

Properties

Protected _isDev

_isDev: boolean = false

Protected _logLevel

_logLevel: LOG_LEVEL = LOG_LEVEL.Information

Protected _logSource

_logSource: string

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

  • Returns string

  • Parameters

    • apiUrl: string

    Returns void

isDev

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

  • Returns boolean

  • Parameters

    • isDev: boolean

    Returns void

logLevel

  • Returns LOG_LEVEL

  • Parameters

    Returns void

logSource

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

  • Returns string

  • Parameters

    Returns void

Methods

clearTimeOutForLogger

  • clearTimeOutForLogger(): void

  • Returns void

Protected generateLogObj

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

  • 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

  • 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

Abstract logCritical

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

  • Create a CRITICAL log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

logCriticial

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

  • 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

Abstract logDebug

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

  • Create a DEBUG log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

Abstract logError

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

  • Create an ERROR log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

Abstract logInformation

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

  • Create an INFORMATION log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

Abstract logLoop

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

  • Create a LOOP log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

Abstract logTrace

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

  • Create a TRACE log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

Abstract logWarning

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

  • Create a WARNING log

    abstract
    memberof

    AbstractLogger

    Parameters

    • message: string

      Content of log record

    • Optional errorCode: ERROR_CODE

      Error classification

    • Optional localTime: Date

      Local time when log record was generated

    Returns void

Abstract pushLogs

  • pushLogs(): void

  • Push logs if any log records have been buffered. Logs are not guaranteed to be committed if this object is deallocated before pushLogs() is called.

    abstract
    memberof

    AbstractLogger

    Returns void

Abstract pushLogsAsync

  • pushLogsAsync(): Promise<void>

  • Push logs asynchronously if any log records have been buffered. Logs are not guaranteed to be committed if this object is deallocated before pushLogsAsync() is called and resolved successfully.

    abstract
    memberof

    AbstractLogger

    Returns Promise<void>

    {Promise}

Abstract setConfiguration

  • Parameters

    Returns void

Protected syncLogLevel

  • syncLogLevel(): void

  • 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

  • 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