[![NPM][npm-shield]][npm-url]
[![Downloads][downloads-shield]][downloads-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
![Vulnerabilities][vulnerabilities-shield]
[![License][license-shield]][license-url]

About The Project

$3

- Both redis & cluster are supported.
- Health: Checks health of redis & cluster server.
- Rigorously tested: With 20+ tests and 100% code coverage.

$3

| Statements | Branches | Functions | Lines |
| --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| !Statements | !Branches | !Functions | !Lines |

Getting Started

$3

This lib requires Node.js >=12.22.0, NestJS ^9.0.0, ioredis ^5.0.0.

$3

``sh


with npm

1, import TerminusModule and RedisHealthModule into the imports array:

`ts
// app.module.ts
import { Module } from '@nestjs/common';
import { TerminusModule } from '@nestjs/terminus';
import { RedisHealthModule } from '@songkeys/nestjs-redis-health';
import { AppController } from './app.controller';

@Module({
imports: [TerminusModule, RedisHealthModule],
controllers: [AppController]
})
export class AppModule {}
`

2, let's setup AppController:

`ts
// app.controller.ts
import { Controller, Get } from '@nestjs/common';
import { HealthCheckService, HealthCheck, HealthCheckResult } from '@nestjs/terminus';
import { RedisHealthIndicator } from '@songkeys/nestjs-redis-health';
import Redis from 'ioredis';

@Controller()
export class AppController {
private readonly redis: Redis;

constructor(private readonly health: HealthCheckService, private readonly redisIndicator: RedisHealthIndicator) {
this.redis = new Redis({ host: 'localhost', port: 6379, password: 'authpassword' });
}

@Get('health')
@HealthCheck()
async healthChecks(): Promise {
return await this.health.check([
() => this.redisIndicator.checkHealth('redis', { type: 'redis', client: this.redis, timeout: 500 })
]);
}
}
`

3, if your redis server is reachable, you should now see the following JSON-result when requesting http://localhost:3000/health with a GET request:

`json
{
"status": "ok",
"info": {
"redis": {
"status": "up"
}
},
"error": {},
"details": {
"redis": {
"status": "up"
}
}
}
`

> INFO: Read more about @nestjs/terminus here.

> HINT: Both TerminusModule and RedisHealthModule are not global modules.

Settings

$3

| Name | Type | Default | Required | Description |
| --------------- | --------- | ----------- | -------- | ----------------------------------------------------------------------------------------------------- |
| type | 'redis' | undefined | true | Server type. You must specify what Redis server type you use. Possible values are "redis", "cluster". |
| client | Redis | undefined | true | The client which the health check should get executed. |
| timeout | number | 1000 | false | The amount of time the check should require in ms. |
| memoryThreshold | number | undefined | false | The maximum amount of memory used by redis in bytes. |

$3

| Name | Type | Default | Required | Description |
| ------ | ----------- | ----------- | -------- | ----------------------------------------------------------------------------------------------------- |
| type | 'cluster' | undefined | true | Server type. You must specify what Redis server type you use. Possible values are "redis", "cluster". |
| client | Cluster | undefined | true | The client which the health check should get executed. |

License

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

[npm-shield]: https://img.shields.io/npm/v/@songkeys/nestjs-redis-health/latest?style=for-the-badge
[npm-url]: https://www.npmjs.com/package/@songkeys/nestjs-redis-health
[downloads-shield]: https://img.shields.io/npm/dm/@songkeys/nestjs-redis-health?style=for-the-badge
[downloads-url]: https://www.npmjs.com/package/@songkeys/nestjs-redis-health
[stars-shield]: https://img.shields.io/github/stars/songkeys/nestjs-redis?style=for-the-badge
[stars-url]: https://github.com/songkeys/nestjs-redis/stargazers
[issues-shield]: https://img.shields.io/github/issues/songkeys/nestjs-redis?style=for-the-badge
[issues-url]: https://github.com/songkeys/nestjs-redis/issues
[license-shield]: https://img.shields.io/npm/l/@songkeys/nestjs-redis?style=for-the-badge
[license-url]: https://github.com/songkeys/nestjs-redis/blob/main/LICENSE
[vulnerabilities-shield]: https://img.shields.io/snyk/vulnerabilities/npm/@songkeys/nestjs-redis-health?style=for-the-badge