Connect a Redis server
Add a Redis connection, test it and see its keys.
In short
Cache Tester is a browser and editor for a Redis server your team runs, such as a session store or a lookup cache. Add a connection, then scan keys, change values, run commands and read the server's health. Every change is recorded with who made it.
Before you start
- Who: In an organization you need "Use Cache Tester" (a Member holds it, a Viewer does not). On a connection your level decides the rest. View sees tests, runs and history. Run runs saved tests. Edit works on the keys. Manage changes where it points and who it is shared with.
- Plan: Cache Tester is part of every plan, Free included. Your plan sets how many connections you keep and how many writing commands you may run an hour and a day; reads are free.
- First: the Redis connection string. The cache must accept connections from the {{brand}} server.
Add a connection
- Open Cache Tester › "Connections" and press "New connection". (With no connection yet, a Connect a Redis server card asks for the string and tests it before it saves.)
- Paste the "Connection string", for example cache.example.com:6379,password=secret,ssl=true.
- Leave "Name" blank to name the connection after its host, or enter one your team will recognize, such as Session store (QA).
- Choose the Tier - Production for anything real - and set "Default db" if the application uses a database other than db0.
- Press "Test connection" to check the address first, or "Save and test" to save and check in one step.
Good to know
- A good test reads, for example, Reachable in 12 ms - Redis 7.2.4 (standalone), then db0: 12,408 keys, 9,900 with a TTL. A saved connection keeps the result as Last checked.
- The connection string is encrypted when you save it and never shown again. When you edit a connection, leave it blank to keep the stored one.
- {{brand}} opens the connection, not your browser: the cache must accept connections from the {{brand}} server.
- The module must be switched on in Settings. Adding a connection needs Manage cache connections and changing keys needs Edit cache keys; every plan includes both.
- Your plan limits how many connections you keep: Free 2, Pro 20, Business 50, Enterprise 500.
- On "Connections", click a row to see the connection beside the list - whether it answered, who it is shared with, its endpoint and team - and "Open" to go to its keys. Narrow the list by tier or search, and save the narrowing as a view.
The connection string carries a password Paste it only into the Connection string field. A name, key value, command or chat message is stored as written and others can read it. If a string was exposed, change the password on the server and edit the connection.
If something goes wrong
- The test fails: see Fix a connection that will not connect.
- "That connection string names no host.": start the string with host:port.
- "A team connection has to be created in an organization workspace.": switch workspace before you save.
Related
- /help/cache-tester/workspace-tour
- /help/cache-tester/connection-tiers
- /help/cache-tester/fix-a-connection
- /help/cache-tester/browsing-and-editing-keys