@thezeus/bull-monitor v1.0.2

About The Project

This is a wrap around @bull-monitor/express for easy use with NestJs.

Getting Started

Prerequisites

This lib requires NestJS ^9.0.0, @nestjs/bull ^0.6.2.

Installation

# with npm
npm install @thezeus/bull-monitor @nestjs/bull bull
npm install --save-dev @types/bull

Usage

// app.module.ts
import { Module } from "@nestjs/common";
import { BullModule } from "@nestjs/bull";
import { BullMonitorModule } from "@thezeus/bull-monitor";
import { bullConfig } from "@config/queue"

@Module({
  imports: [
    BullModule.forRoot({
      ...bullConfig
    }),
    BullMonitorModule.register({
      route: "q-monitor",
      config: {
        queues: [
          {
            name: "OTP_SENDER"
          },
          ...otherQueueConfig
        ],
        ...otherMonitorConfig
      }
    }),
    middleware: [MyCustomNestJsMiddleware]
  ]
})
export class AppModule {}

This will create a dashboard which will be available through your_application_url/q-monitor. For bullConfig and otherQueueConfig reference see here, and for otherMonitorConfig reference see here. You can use the middleware option to setup your own authentication.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• Bull Monitor
• Official NestJs Documentation