# @nestjs-redisx/metrics [](https://www.npmjs.com/package/@nestjs-redisx/metrics) [](https://www.npmjs.com/package/@nestjs-redisx/metrics) [](https://opensource.org/licenses/MIT) Prometheus metrics plugin for NestJS RedisX. Exposes Redis command latencies, connection pool stats, cache hit rates, and custom metrics via a `/metrics` endpoint — or straight into your application's existing prom-client registry (`registry: 'default'`). `prom-client` is a peer dependency, installed automatically by npm 7+ and pnpm 8+ (yarn classic: add it to your dependencies). ## Installation ```bash npm install @nestjs-redisx/core @nestjs-redisx/metrics ioredis ``` ## Quick Example ```typescript 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/](https://nestjs-redisx.dev/en/reference/metrics/) ## Using with AI Assistants For better code generation with AI tools (Cursor, Claude Code, GitHub Copilot, etc.), point your agent to the full API reference: ``` https://nestjs-redisx.dev/llms-full.txt ``` ## License MIT