Redis Event Bus Module

The Redis Event Bus Module uses Redis to implement Medusa's pub/sub events system.

It's powered by BullMQ and io-redis. BullMQ is responsible for the message queue and worker, and io-redis is the underlying Redis client that BullMQ connects to for events storage.

In production, it's recommended to use this module.

---

Register the Redis Events Bus Module#

Prerequisites1

Redis installed and Redis server running↗

Add the module into the modules property of the exported object in medusa-config.ts:

medusa-config.ts
1import { Modules } from "@medusajs/framework/utils"2
3// ...4
5module.exports = defineConfig({6  // ...7  modules: [8    {9      resolve: "@medusajs/medusa/event-bus-redis",10      options: { 11        redisUrl: process.env.EVENTS_REDIS_URL,12      },13    },14  ],15})

Environment Variables#

Make sure to add the following environment variables:

Terminal
❯EVENTS_REDIS_URL=<YOUR_REDIS_URL>

Redis Event Bus Module Options#

Option	Description	Required	Default
redisUrl	A string indicating the Redis connection URL.	Yes	-
redisOptions	An object of Redis options. Refer to the Redis API Reference for details on accepted properties.	No	-
queueName	A string indicating BullMQ's queue name.	No	events-queue
queueOptions	An object of options to pass to the BullMQ constructor. Refer to BullMQ's API reference for allowed properties.	No	-
workerOptions	An object of options to pass to the BullMQ Worker constructor. Refer to BullMQ's API reference for allowed properties.	No	-
jobOptions	An object of options to pass to jobs added to the BullMQ queue. Refer to BullMQ's API reference for allowed properties.	No	-

Test the Module#

To test the module, start the Medusa application:

npm
yarn
pnpm

You'll see the following message in the terminal's logs:

Terminal
❯Connection to Redis in module 'event-redis' established

Edit this page