pm2-redis

library2.1.0jsnpmunverified

PM2 module to monitor a Redis server with Keymetrics. Current stable version is 2.1.0. Released on npm in 2016, with no recent updates. It is used as a PM2 module installed via pm2 install, not as a standard npm dependency. It monitors Redis by collecting metrics like connected clients, memory usage, commands processed, and publishes them to Keymetrics (now PM2 Plus). It is one of several community modules for monitoring databases under PM2, but is not actively maintained.

devops storage

npm install pm2-redis

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PM2-REDIS

pm2-redis

devopsjavascriptv2.1.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default export

✓ pm2 install pm2-redis

✗ npm install pm2-redis

This package is a PM2 module, not a library for import in code. It is installed via pm2 install and configured via pm2 set. Do not npm install it.

install

✓ pm2 install pm2-redis

✗ npm install -g pm2-redis

Installing globally with npm will not work as a PM2 module. Use pm2 install.

configure

✓ pm2 set pm2-redis:<key> <value>

✗ Editing config files directly without pm2 set

Configuration must be done via pm2 set commands, not by modifying package files.

Install and configure pm2-redis as a PM2 module to monitor a Redis server.

# Install PM2 if not already installed npm install -g pm2 # Install pm2-redis module pm2 install pm2-redis # Configure Redis connection (optional, defaults to localhost:6379) pm2 set pm2-redis:ip 127.0.0.1 pm2 set pm2-redis:port 6379 pm2 set pm2-redis:password "yourpassword" # Check module status pm2 show pm2-redis # View logs pm2 logs pm2-redis

Debug

Known issues

deprecatedKeymetrics has been rebranded to PM2 Plus. The module may not work with newer versions of PM2.

fix

Consider using built-in PM2 module system or alternative monitoring solutions.

affects: >=2.0.0

gotchaModule must be installed via pm2 install, not npm install. Using npm install will not register it as a PM2 module.

fix

Use pm2 install pm2-redis instead of npm install.

affects: all

gotchaConfiguration changes require restarting the module to take effect.

fix

After setting configuration with pm2 set, restart the module: pm2 restart pm2-redis.

affects: all

gotchaDefault workerInterval is 2 seconds but minimum is 1 second. Setting lower than 1 may cause errors.

fix

Ensure workerInterval is set to a number >= 1.

affects: all

Errors

Common errors & fixes

Module pm2-redis not found

The module was not installed correctly using pm2 install.

fix

Run pm2 install pm2-redis (not npm install).

Error: Redis connection to 127.0.0.1:6379 failed - connect ECONNREFUSED

Redis server is not running or connection parameters are incorrect.

fix

Verify Redis is running and accessible. Update configuration via pm2 set pm2-redis:ip and :port if needed.

Error: NOAUTH Authentication required.

Redis server requires authentication but no password is provided or password is incorrect.

fix

Set password via pm2 set pm2-redis:password "yourpassword" and restart the module.

Upgrade

Version history

2.1.0latest on npm

Audit

Dependencies

pm2requiredRuntime dependency: module must be installed and run within PM2 process manager.

redisrequiredConnects to Redis server to gather monitoring statistics.

Agent activity

15 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/pm2-hive/pm2-redis ↗

packagepm2-redis ↗

homepagehttps://github.com/pm2-hive/pm2-redis ↗