Redis Client

Download 1
Last updated Nov 18, 2026

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 SENTINEL command.
  • 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 commandRequired Redis command
redis-getGET
redis-lrangeLRANGE
redis-set-batchSET
redis-lpush-batchLPUSH
redis-del-batchDEL
Note
The keep-ttl option of redis-set-batch works only on Redis 6.0 or later.

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)

TypeItemSetting
RequiredHostIP address or hostname of the Redis server
RequiredPort1 to 65535, 6379 by default
OptionalUserRedis ACL username. Leave empty to use password-only authentication
OptionalPasswordRedis password
OptionalDatabase0 to 15, 0 by default
OptionalSSL/TLSEnable TLS connection. false by default
OptionalTimeoutConnection/command timeout in milliseconds. 0 to 1800000, 2000 by default

Add a Redis Client (Standalone) connect profile

Redis Client (Sentinel)

TypeItemSetting
RequiredSentinelsComma-separated host:port list of Sentinel nodes, e.g. 192.0.2.1:26379,192.0.2.2:26379
RequiredMaster nameName of the master monitored by Sentinel
OptionalSentinel passwordPassword of the Sentinel nodes. Leave empty if Sentinel has no authentication
OptionalSentinel SSL/TLSEnable TLS connection to the Sentinel nodes. false by default
OptionalUserRedis ACL username of the master. Leave empty to use password-only authentication
OptionalPasswordPassword of the master
OptionalDatabase0 to 15, 0 by default
OptionalSSL/TLSEnable TLS connection to the master. false by default
OptionalTimeoutConnection/command timeout in milliseconds. 0 to 1800000, 2000 by default

Add a Redis Client (Sentinel) connect profile

Note
Only accounts that are granted access to the connect profile can run the extension commands. To let other accounts use it, grant them access to the connect profile.

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.

redis-get profile=my_redis key=healthcheck

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.