Skip to content

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

Class: MemoryLogManager

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

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.

Implements

Constructors

Constructor

new MemoryLogManager(opts): MemoryLogManager

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

Parameters

opts

IMemoryLogManagerOptions

Returns

MemoryLogManager

Methods

close()

close(taskId): void

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

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): null | ILogRange

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

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

null | ILogRange

Implementation of

ILogManager.get


open()

open(taskId): void

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

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:78

Returns

void


stopTimer()

stopTimer(): void

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

Returns

void


write()

write(taskId, level, message): void

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

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