Redis cannot used in secure mode with APIM throttling.

[janithcmw]

Description

When trying out throttling with Redis based on the documentation[1] the following error was observed when Redis is expecting authentication.

ERROR - ThrottleWindowReplicator Could not replicate throttle data
redis.clients.jedis.exceptions.JedisDataException: Cannot use Jedis when in Multi. Please use Transaction or reset jedis state.
	at redis.clients.jedis.BinaryJedis.checkIsInMultiOrPipeline(BinaryJedis.java:1895) ~[org.apache.servicemix.bundles.jedis_3.3.0.1.jar:?]
	at redis.clients.jedis.Jedis.get(Jedis.java:183) ~[org.apache.servicemix.bundles.jedis_3.3.0.1.jar:?]
	at org.wso2.carbon.apimgt.gateway.RedisBaseDistributedCountManager.getTimestamp_aroundBody12(RedisBaseDistributedCountManager.java:204) ~[org.wso2.carbon.apimgt.gateway_9.28.116.jar:?]
	at org.wso2.carbon.apimgt.gateway.RedisBaseDistributedCountManager.getTimestamp(RedisBaseDistributedCountManager.java:1) ~[org.wso2.carbon.apimgt.gateway_9.28.116.jar:?]
	at org.apache.synapse.commons.throttle.core.SharedParamManager.getSharedTimestamp(SharedParamManager.java:172) ~[synapse-commons_4.0.0.wso2v20.jar:?]
	at org.apache.synapse.commons.throttle.core.ThrottleWindowReplicator$ReplicatorTask.run(ThrottleWindowReplicator.java:111) ~[synapse-commons_4.0.0.wso2v20.jar:?]
	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:515) ~[?:?]
	at java.util.concurrent.FutureTask.runAndReset(FutureTask.java:305) ~[?:?]
	at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:305) ~[?:?]
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128) ~[?:?]
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628) ~[?:?]
	at java.lang.Thread.run(Thread.java:829) [?:?]

[1] https://apim.docs.wso2.com/en/latest/design/rate-limiting/advanced-topics/configuring-rate-limiting-api-gateway-cluster/#configuring-a-redis-cluster-with-api-manager

Steps to Reproduce

1. Eneble auth in Redis server.

2. According to the Redis documentation[1] it is required to pass 'requirepass' property to enable security for Redis.

3. Then verify the authentication using the AUTH command in redis-cli.

4. Add the following configurations to the APIM 'deployment.toml' file.

[apim.redis_config]
host = "localhost"
port = "6379"
user = "root"
password = "root"

5. Invoke an API with uses subscription burst control. Then the above log can be seen based on the configured frequency for the property 'throttling.replication.frequency'

[1] https://redis.io/docs/management/security/acl/

Affected Component

APIM

Version

4.2.0

Environment Details (with versions)

N/A

Relevant Log Output

N/A

Related Issues

No response

Suggested Labels

No response