Interface JobLogger

Pluggable interface for persistent job event logging.

Implement this interface to store job lifecycle logs in your preferred backend. Each backend package (mongo, postgres, redis) provides a built-in implementation that stores logs in a dedicated table/collection alongside the jobs.

Example

// Enable backend's built-in logger
const agenda = new Agenda({
  backend: new PostgresBackend({ connectionString: '...', logging: true }),
  logging: true
});

// Query logs
const result = await agenda.getLogs({ jobName: 'myJob', limit: 100 });

interface JobLogger {
    clearLogs(query?: JobLogQuery): Promise<number>;
    getLogs(query?: JobLogQuery): Promise<JobLogQueryResult>;
    log(entry: Omit<JobLogEntry, "_id">): Promise<void>;
}

Index

Methods

clearLogs getLogs log

Methods

clearLogs

clearLogs(query?: JobLogQuery): Promise<number>
Delete log entries matching the query. If no query is provided, deletes ALL log entries. Returns the number of deleted entries.
Parameters
- Optionalquery: JobLogQuery
Returns Promise<number>
- Defined in types/JobLogger.ts:147

getLogs

getLogs(query?: JobLogQuery): Promise<JobLogQueryResult>
Query log entries with optional filtering and pagination. Used by agendash to display logs.
Parameters
- Optionalquery: JobLogQuery
Returns Promise<JobLogQueryResult>
- Defined in types/JobLogger.ts:140

log

log(entry: Omit<JobLogEntry, "_id">): Promise<void>
Write a log entry. Called automatically by Agenda for each job lifecycle event. Implementations should be fast and non-blocking.
Parameters
- entry: Omit<JobLogEntry, "_id">
Returns Promise<void>
- Defined in types/JobLogger.ts:134

Interface JobLogger

Example

Index

Methods

Methods

clearLogs

Parameters

Returns Promise<number>

getLogs

Parameters

Returns Promise<JobLogQueryResult>

log

Parameters

Returns Promise<void>

Settings

On This Page