node-resque-data

This package can be used to grab node-resque data such as queue lengths and the number of scheduled jobs outstanding.

It can also be used to visualise node-resque data via express middleware.

Installation

1npm install node-resque-data

Usage:

View raw queue information

1const {Queue} = require('node-resque-data')
2
3const config = {
4  port: 6379, // Optional - defaults to 6379
5  host: 'localhost', // Optional - defaults to 'localhost'
6  password: "redis-pw",
7  db: 0, // Optional - defaults to 0
8  family: 4, // Optional - defaults to 4 for IPv4 or 6 for IPv6
9  queues: ['nameOfQueue1', 'nameOfQueue2', 'nameOfQueue3'],
10  namespace: 'beepbop', // Optional - defaults to 'resque'
11};
12
13const result = await Queue.queueData(config);
14console.log(result)

example output

1{
2  queues: [
3    { queue: 'nameOfQueue1', num: 190 },
4    { queue: 'nameOfQueue2', num: 12 },
5    { queue: 'nameOfQueue3', num: 207 },
6  ],
7  jobs: { processed: '8302', failed: '12', failing: 0 }
8}

view queue information using .then

1Queue.queueData(config).then((result) => {
2  console.log(result)
3});

view schedule information

1const result = await Queue.scheduledData(config);
2console.log(result)

Example output:

1{
2  scheduledJobs: 2
3}

include more information about the scheduled jobs

1const options = {
2  includeJobDetails: true
3};
4
5const result = await Queue.scheduledData(config, options);
6console.log(result)

Example output:

1{
2  scheduledJobs: 2,
3  scheduledJobsDetails: [
4    {
5      class: 'subtract',
6      queue: 'nameOfQueue1',
7      args: [ 2, 1 ],
8      runTime: 2021-08-15T19:36:27.000Z
9   }
10  ]
11}

integrate node-resque-data with express middleware

The below snippet will display the same example output displayed above but this time to an express route you specify.

1const {Queue} = require('node-resque-data')
2
3const config = {
4  queues: ['nameOfQueue1', 'nameOfQueue2', 'nameOfQueue3'],
5};
6
7const options = {
8  rawJSON: true
9};
10
11// add route via express middleware
12app.use('/some-route', Queue.serve, Queue.setup(config, options));

Visualise node-resque data

To acheive this simply remove the {rawJSON: true} object from the queue.setup function or even set it to false

This will display the node-resque queue data in a bar and pie chart.

Custom options:

Custom settings can be added by passing additional keys into the options object.

1const options = {
2  rawJSON: false,
3  customTitle: 'Your Custom title',
4  customHeader: 'Your Custom header value',
5};
6
7app.use('/some-route', Queue.serve, Queue.setup(config, options));

Custom option fields:

• rawJSON: boolean field, that determines if the page displays a raw JSON display of queue lengths or a visual display.
• customTitle: Allows you to customise the browser tab title
• customHeader: Allows you to customise the text shown in the header

Custom Css

Custom CSS can be added by passing a third parameter into the setup function.

This will allow you to totally change the look and feel of the UI

1const customCss = `
2  body {
3    color: red;
4    font-size: 8px;
5  };
6`;
7
8app.use('/some-route', Queue.serve, Queue.setup(queueUiConfig, options, customCss));

Run tests

npm run test

Run eslint

display linting warnings and errors

npm run lint

fix linting warnings and errors

npm run lint:fix