Documents for @litert/xxl-job-integration / LogManagers/FileLogManager / FileLogManager
Class: FileLogManager
Defined in: src/lib/LogManagers/FileLogManager.ts:230
The implementation of the ILogManager interface that writes logs to files in a specified directory.
This class manages log files for different tasks, allowing you to open, close, write logs, and read logs by range.
This class does not handle log file cleanup, so you may want to use FileLogCleaner to manage old log files.
Extends
EventEmitter<ILogManagerEvents>
Implements
Constructors
Constructor
new FileLogManager(
opts):FileLogManager
Defined in: src/lib/LogManagers/FileLogManager.ts:238
Parameters
opts
Returns
FileLogManager
Overrides
EventEmitter<LibXJ.ILogManagerEvents>.constructor
Methods
close()
close(
taskId):void
Defined in: src/lib/LogManagers/FileLogManager.ts:280
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
get()
get(
taskId,startLine):Promise<ILogRange|null>
Defined in: src/lib/LogManagers/FileLogManager.ts:321
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
Promise<ILogRange | null>
Implementation of
open()
open(
taskId):Promise<void>
Defined in: src/lib/LogManagers/FileLogManager.ts:246
Initialize a log section for the given task ID.
Parameters
taskId
number
The task ID to initialize the log section for.
Returns
Promise<void>
Implementation of
write()
write(
taskId,level,message):void
Defined in: src/lib/LogManagers/FileLogManager.ts:295
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