@litert/xxl-job-integration

Appearance

Documents for @litert/xxl-job-integration / LogManagers/MemoryLogManager / MemoryLogManager

Class: MemoryLogManager ​

Defined in: src/lib/LogManagers/MemoryLogManager.ts:69

The implementation of the ILogManager interface that writes logs to memory in a specified directory.

This class manages log sections for different tasks, allowing you to open, close, write logs, and read logs by range.

Warning ​

This log manager stores all logs in memory, which is only suitable for testing or small-scale applications. For production use, consider using FileLogManager or implementing a custom log manager that writes to a more durable storage.

Extends ​

Implements ​

Constructors ​

Constructor ​

new MemoryLogManager(opts): MemoryLogManager

Defined in: src/lib/LogManagers/MemoryLogManager.ts:79

Parameters ​

opts ​

IMemoryLogManagerOptions

Returns ​

MemoryLogManager

Overrides ​

EventEmitter<LibXJ.ILogManagerEvents>.constructor

Methods ​

close() ​

close(taskId): void

Defined in: src/lib/LogManagers/MemoryLogManager.ts:124

Close the log section for the given task ID.

Parameters ​

taskId ​

number

The task ID to close the log section for.

Returns ​

void

Implementation of ​

ILogManager.close

get() ​

get(taskId, startLine): ILogRange | null

Defined in: src/lib/LogManagers/MemoryLogManager.ts:147

Read a range of log for the given task ID, by the start line and datetime.

Don't always return the all rest lines, keep it less than a certain number of lines (e.g. 100), in case of memory overflow or performance issues.

Parameters ​

taskId ​

number

The task ID to read the log for.

startLine ​

number

The start line to read from.

Returns ​

ILogRange | null

Implementation of ​

ILogManager.get

open() ​

open(taskId): void

Defined in: src/lib/LogManagers/MemoryLogManager.ts:119

Initialize a log section for the given task ID.

Parameters ​

taskId ​

number

The task ID to initialize the log section for.

Returns ​

void

Implementation of ​

ILogManager.open

startTimer() ​

startTimer(): void

Defined in: src/lib/LogManagers/MemoryLogManager.ts:87

Returns ​

void

stopTimer() ​

stopTimer(): void

Defined in: src/lib/LogManagers/MemoryLogManager.ts:111

Returns ​

void

write() ​

write(taskId, level, message): void

Defined in: src/lib/LogManagers/MemoryLogManager.ts:135

Write a log message to the task log storage.

Parameters ​

taskId ​

number

The task ID to write the log message for.

level ​

string

The log level (e.g. "info", "error").

message ​

string

The log message to write.

Returns ​

void

Implementation of ​

ILogManager.write