Install Guide
Overview
The Redis Client app provides extension commands that read and write Redis keys and lists from a query, along with Redis connect profiles. It does not provide a logger. After installation, just create a connect profile and you can use the commands.
Prepare the Redis server
- A Redis server in a Standalone or Sentinel setup is required (Cluster is not supported). The app has been verified on Redis 7.2.
- The Sonar server must be able to reach the Redis server port (6379 by default). With Sentinel, it must also reach the Sentinel port (26379 by default) and the master address that Sentinel reports.
- If authentication is enabled, you need a password or an ACL account. Connecting through Sentinel requires permission to run the
SENTINELcommand. - If your TLS-enabled Redis uses a private CA certificate, register the CA certificate in the JVM trust store of the Sonar server. The host you connect to must also match the SAN of the certificate.
The Redis account used by the connect profile must be allowed to run the Redis commands behind the extension commands you use.
| Extension command | Required Redis command |
|---|---|
| redis-get | GET |
| redis-lrange | LRANGE |
| redis-set-batch | SET |
| redis-lpush-batch | LPUSH |
| redis-del-batch | DEL |
Logpresso settings
Step 1: Add a connect profile
In System > Connect Profiles, click Add and select the type that matches your Redis setup.
- A single Redis server: Redis Client (Standalone)
- A master managed by Sentinel: Redis Client (Sentinel)
Redis Client (Standalone)
| Type | Item | Setting |
|---|---|---|
| Required | Host | IP address or hostname of the Redis server |
| Required | Port | 1 to 65535, 6379 by default |
| Optional | User | Redis ACL username. Leave empty to use password-only authentication |
| Optional | Password | Redis password |
| Optional | Database | 0 to 15, 0 by default |
| Optional | SSL/TLS | Enable TLS connection. false by default |
| Optional | Timeout | Connection/command timeout in milliseconds. 0 to 1800000, 2000 by default |
Redis Client (Sentinel)
| Type | Item | Setting |
|---|---|---|
| Required | Sentinels | Comma-separated host:port list of Sentinel nodes, e.g. 192.0.2.1:26379,192.0.2.2:26379 |
| Required | Master name | Name of the master monitored by Sentinel |
| Optional | Sentinel password | Password of the Sentinel nodes. Leave empty if Sentinel has no authentication |
| Optional | Sentinel SSL/TLS | Enable TLS connection to the Sentinel nodes. false by default |
| Optional | User | Redis ACL username of the master. Leave empty to use password-only authentication |
| Optional | Password | Password of the master |
| Optional | Database | 0 to 15, 0 by default |
| Optional | SSL/TLS | Enable TLS connection to the master. false by default |
| Optional | Timeout | Connection/command timeout in milliseconds. 0 to 1800000, 2000 by default |
Step 2: Verify the connection
Run the following query in Analytics > Logs to check that the connect profile works. Replace my_redis with the name of the connect profile you created in Step 1.
If the connection succeeds, a row with key and value is returned. The value is empty if the key does not exist. On failure, the cause is shown in the _error field.

