@nestjs-redisx/metrics

Prometheus metrics plugin for NestJS RedisX. Exposes Redis command latencies, connection pool stats, cache hit rates, and custom metrics via a /metrics endpoint. prom-client is bundled.

Installation

npm install @nestjs-redisx/core @nestjs-redisx/metrics ioredis

Quick Example

import { RedisModule } from '@nestjs-redisx/core';
import { MetricsPlugin } from '@nestjs-redisx/metrics';

@Module({
  imports: [
    RedisModule.forRoot({
      clients: { host: 'localhost', port: 6379 },
      plugins: [
        new MetricsPlugin({ prefix: 'redisx_', exposeEndpoint: true }),
      ],
    }),
  ],
})
export class AppModule {}

// Scrape: curl http://localhost:3000/metrics

Documentation

Full documentation: nestjs-redisx.dev/en/reference/metrics/

License

MIT