SDK API Reference / Logger

Class: Logger

Logger class - get instances via Logger.of()

Properties

component

readonly component: string

Component name for this logger

Methods

debug()

debug(...args): void

Log debug message

Supports lazy evaluation: logger.debug(() => expensiveComputation())

Parameters

args

...unknown[]

Returns

void

---

error()

error(...args): void

Log error message

Supports lazy evaluation: logger.error(() => expensiveComputation())

Parameters

args

...unknown[]

Returns

void

---

info()

info(...args): void

Log info message

Supports lazy evaluation: logger.info(() => expensiveComputation())

Parameters

args

...unknown[]

Returns

void

---

trace()

trace(...args): void

Log trace message

Supports lazy evaluation: logger.trace(() => expensiveComputation())

Parameters

args

...unknown[]

Returns

void

---

warn()

warn(...args): void

Log warning message

Supports lazy evaluation: logger.warn(() => expensiveComputation())

Parameters

args

...unknown[]

Returns

void

---

addHandler()

static addHandler(handler): void

Add a log handler

Parameters

handler

LogHandler

Returns

void

---

clearHandlers()

static clearHandlers(): void

Remove all handlers

Returns

void

---

format()

static format(record): string

Format a log record using the global formatter

Parameters

record

LogRecord

Returns

string

---

getFormatter()

static getFormatter(): LogFormatter | null

Get the global formatter (for handlers to use)

Returns

LogFormatter | null

---

init()

static init(config?): Promise<void>

Initialize the global logger system

Parameters

config?

LoggerConfig = {}

Logger configuration

Returns

Promise<void>

---

isInitialized()

static isInitialized(): boolean

Check if initialized

Returns

boolean

---

of()

static of(name): Logger

Get or create a named logger

Parameters

name

Component name or class constructor

string | (...args) => unknown

Returns

Logger

Logger instance

Example

const logger = Logger.of('tdx.sdk.query');
const logger = Logger.of(QuerySDK);  // Uses class name

---

reset()

static reset(): void

Reset logger state (for testing)

Returns

void

---

setDefaultLevel()

static setDefaultLevel(level): void

Set default log level

Parameters

level

LogLevel

Returns

void

---

setLogLevel()

static setLogLevel(component, level): void

Set log level for a specific component (hierarchical)

Parameters

component

string

Component prefix (e.g., 'tdx.sdk' matches 'tdx.sdk.query')

level

LogLevel

Log level

Returns

void

Example

Logger.setLogLevel('tdx.sdk', LogLevel.DEBUG);  // Debug all SDK
Logger.setLogLevel('tdx.client.http', LogLevel.TRACE);  // Trace HTTP only

---

shutdown()

static shutdown(): Promise<void>

Shutdown the logger system - flush and close all handlers

Returns

Promise<void>