File tree Expand file tree Collapse file tree 2 files changed +44
-0
lines changed
Expand file tree Collapse file tree 2 files changed +44
-0
lines changed Original file line number Diff line number Diff line change @@ -89,6 +89,23 @@ npm install @nestjs-redis/client redis
8989import { RedisModule } from ' @nestjs-redis/client' ;
9090```
9191
92+ ## Debug Logging
93+
94+ Enable detailed logging across all toolkit packages by setting the ` REDIS_MODULE_DEBUG ` environment variable:
95+
96+ ``` bash
97+ REDIS_MODULE_DEBUG=true npm start
98+ ```
99+
100+ This provides comprehensive operational logging:
101+
102+ ```
103+ [RedisModule] [Connection=<empty>]: Creating Redis client...
104+ [RedisModule] [Connection=<empty>]: [Event=connect] Connection initiated to Redis server
105+ [RedisModule] [Connection=<empty>]: [Event=ready] Redis client is ready to accept commands
106+ [RedisModule] [Connection=<empty>]: Redis client connected
107+ ```
108+
92109## Compatibility
93110
94111| Package | Node.js | NestJS | Redis |
Original file line number Diff line number Diff line change @@ -94,6 +94,33 @@ export class AppService {
9494export class AppModule {}
9595```
9696
97+ ## Debug Logging
98+
99+ Enable detailed Redis connection logging by setting the ` REDIS_MODULE_DEBUG ` environment variable:
100+
101+ ``` bash
102+ REDIS_MODULE_DEBUG=true npm start
103+ ```
104+
105+ This provides comprehensive logging of Redis connection lifecycle events:
106+
107+ ```
108+ [RedisModule] [Connection=<empty>]: Creating Redis client...
109+ [RedisModule] [Connection=<empty>]: Connecting to Redis...
110+ [RedisModule] [Connection=<empty>]: [Event=connect] Connection initiated to Redis server
111+ [RedisModule] [Connection=<empty>]: [Event=ready] Redis client is ready to accept commands
112+ [RedisModule] [Connection=<empty>]: Redis client connected
113+
114+ ...
115+
116+ [RedisModule] [Connection=<empty>]: Closing Redis connection
117+ [RedisModule] [Connection=<empty>]: [Event=end] Connection closed (disconnected from Redis server)
118+ [RedisModule] [Connection=<empty>]: Redis connection closed
119+
120+ ```
121+
122+ All available event types can be checked at official [ ` node-redis ` docs] ( https://github.com/redis/node-redis?tab=readme-ov-file#events )
123+
97124## API
98125
99126- ` @InjectRedis(name?) `
You can’t perform that action at this time.
0 commit comments