Redis Connection Test

Test Redis connection and credentials

Overview

This node tests the connection and credentials for a Redis server. It is useful for verifying that your Redis instance is accessible and functioning correctly before running more complex workflows that depend on Redis operations. The node supports multiple test types, including basic connectivity (PING), read/write operations (SET/GET/DEL), retrieving server information, or running all these tests together.

Practical examples:

Quickly verify if your Redis server is reachable and responding.
Confirm that your credentials allow you to perform read/write operations.
Retrieve key server details such as version, mode, and uptime.
Run a comprehensive check combining all above tests to ensure full Redis functionality.

Properties

Name	Meaning
Test Type	Selects the type of test to run: - Basic Connection: Test basic Redis connection (PING) - Read/Write Test: Test read/write operations (SET/GET/DEL) - Server Info: Get Redis server information - Complete Test: Run all tests above

Output

The node outputs a JSON object containing detailed results of the selected test(s). The structure includes:

timestamp: ISO string of when the test was run.
connectionType: The type of connection used (e.g., connection string or host/port).
connectionDetails: Summary of connection info (masked connection string or host:port).
testType: The test type executed.
tests: An object with keys corresponding to each test performed (basic, readwrite, serverInfo), each containing:
- status: "success" or "error".
- message: A human-readable message with success or failure indication.
- Additional fields depending on the test:
  - For basic: result (usually "PONG"), responseTime in milliseconds.
  - For readwrite: operations showing results of SET, GET, DEL commands.
  - For serverInfo: info object with Redis server details like version, mode, OS, process ID, port, uptime.
overallStatus: "success" if all tests passed, "partial_success" if some failed.
summary: A summary message indicating overall test result.

The node does not output binary data.

Dependencies

Requires an active Redis server accessible with provided credentials.
Needs an API key credential or equivalent authentication token configured in n8n for Redis access.
Uses the ioredis library internally to manage Redis connections and commands.

Troubleshooting

Common issues and error messages:

Connection refused: Indicates the Redis server is not running or unreachable at the specified host/port. Check server status and network/firewall settings.
Host not found: The hostname or IP address is incorrect or DNS resolution failed. Verify the connection details.
Connection timeout: Network issues or firewall blocking the connection. Ensure Redis server is reachable within timeout limits.
Authentication required / Invalid password: Credentials are missing or incorrect. Double-check the password or API key used.
PING timeout: The Redis server did not respond to the PING command within 5 seconds. Could indicate server overload or network latency.
Value mismatch: SET/GET failed: The read/write test failed because the value retrieved did not match the value set. This may indicate permission issues or Redis misconfiguration.

To resolve errors, verify connection parameters, credentials, and network accessibility. Use the detailed error messages returned by the node to pinpoint the problem.