Administration

Add a Redis database

Before using any of the tools to work with your database, you must first add the database so RedisInsight can connect to it.
Each of these database configurations requires specific steps to add them to RedisInsight: Standalone Redis Redis cluster
Redis Sentinel Redis with TLS authentication Elasticache Note: Currently, RedisInsight supports Redis versions 4 and
newer. Add a standalone Redis database This is the simplest setup of a Redis database with just a single Redis server.

Automatically Discovering Databases

RedisInsight lets you automatically add Redis Enterprise Software and Redis Enterprise Cloud databases. Note: For Redis
Cloud, auto-discovery is supported only for Flexible or Annual subscriptions. Auto-discovery for Redis Software To
automatically discover and add Redit Software databases to RedisInsight: In RedisInsight, select ADD REDIS DATABASE.
Select Automatically Discover Databases. Select Redis Enterprise. Enter the connection details and then select DISCOVER
DATABASES.

Adding Databases Programmatically

If you have a lot of Redis databases or you are using RedisInsight as part of some automated workflow, you might want to
add databases programmatically. Now this is possible using our experimental REST API. Below is the documentation for the
endpoints required to add databases. Note that this API should not be considered stable at this point and might change or
break entirely in future releases. Do not rely on this API for production.

Adding Databases via GET URL

If you want to automate adding a Redis database without filling the database form, you might want to add database via GET
URL. Below is the documentation for the URL required to add databases. Add Redis database Used to add Redis databases
to RedisInsight. URL : /add/ Method : GET Query Parameters These are the required query parameters for any type of
database. Parameter Type Required/Optional Description host string required Hostname of your Redis database.

Authenticate database users

You can enforce authentication of users who share your databases by running Redisinsight with variables
RIAUTHPROMPT, RIAUTHTIMER, and RILOGLEVEL. For more information on variables, see Configure RedisInsight. By
setting the variables, enforce the prompt for username and password each time the database is opened and at a specific
time interval while users work with the database. You can maintain multiple tabs with the same database without having to
enter username and password in each one.

Proxy
Trusted origins By default, RedisInsight trusts only the origin to which RedisInsight binds to. If RedisInsight is run behind a
proxy, the origin where the requests come from is not trusted if the proxy’s origin is not the origin where RedisInsight binds
to. While RedisInsight does start and is reachable, no operations are allowed. Because the origin of requests/proxy is always
known, the trusted origins must be manually set via the RITRUSTEDORIGINS environment variable.

Performance Metrics
RedisInsight Overview provides you the quick overview about your Redis instance through graphical representation. It
displays the total memory and keys for your instance. Number of connections received, clients connected, Network input
and output and various other information.

Cluster Management
RedisInsight Cluster Management provides a graphical user interface (GUI) to manage your Redis Cluster. Cluster
Management comes with three different views to analyze your cluster architecture. Master Layout - This view only contains
information about the masters present in the Redis Cluster. The information present is - slot ranges, host, port and few
metrics gathered from redis INFO Command. Master-Replica Layout - This view contains masters along with their replicas.

Browser
RedisInsight Browser lets you explore keys in your redis server. You can add, edit and delete a key. You can even update the
key expiry and copy the key name to be used in different places of the application. Note: RedisInsight restricts visualization
of keys that are greater than 2GB in size.

CLI
RedisInsight CLI lets you run commands against a redis server. You don’t need to remember the syntax - the integrated help
shows you all the arguments and validates your command as you type. Key Bindings Emacs and Vim keybindings are
supported. Action Emacs Vim Previous history item C-p k Next history item C-n j Move cursor to the begining C-a 0 Move
cursor to the end C-e $ Move cursor to the right by one character C-f h Move cursor to the left by one character C-b l Enter
insert mode - i Enter normal mode - ESC

Memory analysis
RedisInsight Memory analysis helps you analyze your Redis database, which can reduce memory use and improve
application performance. Analysis can be done in two ways: online mode - In this mode, RedisInsight downloads an rdb file
from your connected Redis instance and analyzes it to create a temp file with all the keys and metadata required for
analysis. In case there is a master-replica connection, RedisInsight downloads the dump from the replica instead of the
master in order to avoid affecting the performance of the master.

Pro ler
RedisInsight Profiler runs Redis MONITOR command, which analyzes every command sent to the redis instance. It parses
the output of the MONITOR command and generates a summarized view. All the commands sent to the redis instance are
monitored for the duration of the profiling. Profiler gives information about the number of commands processed,
commands/second and number of connected clients. It also gives information about top prefixes, top keys and top
commands.

Slowlog
RedisInsight Slowlog is a list of slow operations for your redis instance. These can be used to troubleshoot performance
issues. Each entry in the list displays the command, duration and timestamp. Any transaction that exceeds slowlog-log-
slower-than microseconds are recorded up to a maximum of slowlog-max-len after which older entries are discarded. Clear
Slowlog - Clear slowlog clears all the slowlog entries from your redis server.

Con guration
RedisInsight configuration allows to update your redis instance’s config with its easy to use config editor. Each of the keys
shown corresponds to an entry in the Redis configuration file. Most of the configuration settings can be applied without
restarting the server. Also, it comes with an option of rewriting your current settings to your redis.conf file so that these
settings remain even when server restarts. Configurations are also separated into categories like- Advanced config,
Security, Lua Scripting etc.
 View Java Serialized Objects in Redis
RedisInsight detects java serialized objects and converts them to a nicely formatted JSON object, along with the fully
qualified class name. It doesn’t matter what you store. Whether it is a hibernate object, or a user session or a plain old java
object, RedisInsight reverse-engineers and show it to you nicely. Just for fun, we tried out how such an object would look
without the formatting.

Troubleshooting RedisInsight
When RedisInsight doesn’t behave as expected, use these steps to see what the problem is. For additional configuration
options, such as changing the default port, go to: https://docs.redislabs.com/latest/ri/installing/configurations/ Logs To get
detailed information about errors in RedisInsight, you can review the log files with the .log extension in: Docker: In the /db/
directory inside the container. Mac: In the /Users/<your-username>/.redisinsight directory. Windows: In the C:\Users\
<your-username>\.redisinsight directory. Linux: In the /home/<your-username>/.

Updated: August 27, 2020