Queue events and monitoring in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of queue events in a NestJS application?

Queue events help track the lifecycle of jobs, such as when a job is added, completed, failed, or retried. This allows better control and monitoring of background tasks.

beginner

Name two common queue events you can listen to in NestJS using Bull or BullMQ.

Common events include completed (when a job finishes successfully) and failed (when a job encounters an error).

intermediate

How can you monitor queue health in a NestJS app?

You can monitor queue health by listening to events, checking job counts (waiting, active, completed, failed), and using dashboards like Bull Board or Arena for visual monitoring.

beginner

What is Bull Board in the context of NestJS queues?

Bull Board is a web interface that shows real-time status of queues and jobs. It helps developers see job progress, failures, and retry jobs easily.

intermediate

Why is it important to handle the 'failed' event in queue processing?

Handling the 'failed' event lets you log errors, alert teams, or retry jobs. This prevents silent failures and improves reliability.

Which event indicates a job finished successfully in a NestJS queue?

A stalled

B failed

C waiting

D completed

The 'completed' event fires when a job finishes without errors.

What tool can you use to visually monitor Bull queues in NestJS?

A Bull Board

B Grafana

C Kibana

D Prometheus

Bull Board is designed specifically for monitoring Bull queues.

Which event should you listen to for retrying failed jobs?

A failed

B active

C completed

D waiting

The 'failed' event indicates a job error and is the right place to trigger retries.

What does the 'active' event in a queue represent?

A Job is waiting to be processed

B Job is currently being processed

C Job has failed

D Job has completed

The 'active' event means the job is running right now.

Why is monitoring queue events important in production?

A To reduce server CPU usage

B To improve user interface design

C To track job status and handle errors promptly

D To increase database size

Monitoring helps catch issues early and ensures jobs run smoothly.

Explain how you would set up event listeners for queue jobs in a NestJS application.

Think about how you track job progress and errors.

Describe methods to monitor and visualize queue health in a NestJS project.

Consider both code and tools for monitoring.

Practice

1. What is the main purpose of using @OnQueueEvent decorators in NestJS queues?

easy

A. To delete jobs from the queue manually

B. To listen and react to specific queue events like job completion or failure

C. To configure the queue's concurrency settings

D. To create new queues dynamically at runtime

Solution

1. Step 1: Understand the role of @OnQueueEvent

   This decorator is used to listen for events emitted by the queue, such as when a job completes or fails.

2. Step 2: Identify what @OnQueueEvent does not do

   It does not create queues, configure concurrency, or delete jobs manually; it only listens to events.

3. Final Answer:

   To listen and react to specific queue events like job completion or failure -> Option B

4. Quick Check:

   @OnQueueEvent listens to events [OK]

Hint: Remember: @OnQueueEvent listens to queue events only [OK]

Common Mistakes:

• Thinking it creates or deletes queues
• Confusing event listening with queue configuration
• Assuming it manages job concurrency

2. Which of the following is the correct syntax to listen for a 'completed' event in a NestJS queue using @OnQueueEvent?

easy

A. @OnQueueEvent('done')
handleDone(job: Job) {
// handle job completion
}

B. @OnQueueEvent('complete')
handleComplete(job: Job) {
// handle job completion
}

C. @OnQueueEvent('completed')
handleCompleted(job: Job) {
// handle job completion
}

D. @OnQueueEvent('finished')
handleFinished(job: Job) {
// handle job completion
}

Solution

1. Step 1: Recall the exact event name for job completion

   The official event name emitted by NestJS queues for job completion is 'completed'.

2. Step 2: Match the syntax with the correct event name

   The syntax must use @OnQueueEvent('completed') to listen properly.

3. Final Answer:

   @OnQueueEvent('completed')\nhandleCompleted(job: Job) {\n // handle job completion\n} -> Option C

4. Quick Check:

   Event name is 'completed' exactly [OK]

Hint: Use exact event names like 'completed' with @OnQueueEvent [OK]

Common Mistakes:

• Using incorrect event names like 'complete' or 'done'
• Misspelling the decorator syntax
• Not passing the event name as a string

3. Given the following code snippet, what will be logged when a job fails in the queue?

@OnQueueEvent('failed')
handleFailed(job: Job, error: Error) {
  console.log(`Job ${job.id} failed with error: ${error.message}`);
}

medium

A. Job <job_id> failed with error: <error_message>

B. Job failed with error: <error_message>

C. Job <job_id> completed successfully

D. Error occurred but no job info logged

Solution

1. Step 1: Analyze the event and handler parameters

   The handler listens to the 'failed' event and receives the job and error objects.

2. Step 2: Understand the console.log output

   The log prints the job's id and the error's message in the format: "Job failed with error: ".

3. Final Answer:

   Job <job_id> failed with error: <error_message> -> Option A

4. Quick Check:

   Failed event logs job id and error message [OK]

Hint: Failed event handlers get job and error objects [OK]

Common Mistakes:

• Ignoring job id in the log message
• Confusing 'failed' with 'completed' event
• Logging incomplete error information

4. You wrote this event listener but it never triggers:

@OnQueueEvent('completed')
handleCompleted() {
  console.log('Job done');
}

What is the likely problem?

medium

A. The event name 'completed' is incorrect

B. You must call the handler manually after job completion

C. The method name must be 'onCompleted' instead of 'handleCompleted'

D. The handler is missing the job parameter to receive event data

Solution

1. Step 1: Check the event handler signature

   Event handlers for 'completed' receive the job object as a parameter, but this method has none.

2. Step 2: Understand why missing parameters cause no trigger

   Without the expected parameter, NestJS cannot properly call the handler, so it never triggers.

3. Final Answer:

   The handler is missing the job parameter to receive event data -> Option D

4. Quick Check:

   Event handlers need correct parameters [OK]

Hint: Always include expected parameters in event handlers [OK]

Common Mistakes:

• Omitting parameters in event handlers
• Changing event names incorrectly
• Thinking handlers must be called manually

5. You want to monitor a NestJS queue to log when jobs are added, completed, or failed. Which combination of event listeners should you implement to cover these events effectively?

hard

A. Use @OnQueueEvent('waiting'), @OnQueueEvent('completed'), and @OnQueueEvent('failed')

B. Use @OnQueueEvent('added'), @OnQueueEvent('done'), and @OnQueueEvent('error')

C. Use @OnQueueEvent('start'), @OnQueueEvent('finish'), and @OnQueueEvent('fail')

D. Use @OnQueueEvent('enqueue'), @OnQueueEvent('success'), and @OnQueueEvent('failure')

Solution

1. Step 1: Identify correct event names for job lifecycle

   In NestJS queues, 'waiting' is emitted when a job is added, 'completed' when done, and 'failed' on failure.

2. Step 2: Verify the other options' event names

   Other options use incorrect or non-existent event names like 'added', 'done', 'error', 'start', 'finish', 'fail', 'enqueue', 'success', 'failure'.

3. Final Answer:

   Use @OnQueueEvent('waiting'), @OnQueueEvent('completed'), and @OnQueueEvent('failed') -> Option A

4. Quick Check:

   Correct event names: waiting, completed, failed [OK]

Hint: Use official event names: waiting, completed, failed [OK]

Common Mistakes:

• Using wrong event names not recognized by NestJS
• Missing the 'waiting' event for job addition
• Confusing 'failed' with 'fail' or 'error'