You're Invited: Meet the Socket team at BSidesSF and RSAC - April 27 - May 1.RSVP
Socket
Sign inDemoInstall
Socket

redis-healthcheck

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

redis-healthcheck

Checks the health of a Redis server using an ioredis or node_redis client

0.1.1
latest
Source
npm
Version published
Weekly downloads
266
7.69%
Maintainers
1
Weekly downloads
 
Created
Source

redis-healthcheck

Checks the health of a Redis server.

This project is a shameless copy+paste form redis-status, but adapted to work with ioredis clients as well.

Instead of passing the connection config (like in redis-status), in redis-healthcheck you pass a previously created client, an instance of ioredis or node_redis.

Using ioredis, this works both for single Redis deployments and for Sentinel as well.

installation

npm install --save redis-healthcheck

or

yarn add redis-healthcheck

usage

const Redis = require('ioredis')
const RedisHealthcheck = require('redis-healthcheck')

const config = { /* host, port, password, ... */ }
const client = new Redis(config)

const redisHealthcheck = RedisHealthcheck({
  client,
  name: 'my redis', // any name you want to see in the error messages
  memoryThreshold: 10485760, // in bytes, used to report abnormal memory usage
})

redisHealthcheck.checkStatus((err) => {
  // the callback is called with a string as `err` in case of failure, or undefined in case of success
})

Keywords

redis

FAQs

Package last updated on 25 Oct 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts