[qpid.heartbeat] configuration on a distributed environment

[DaniduWijendra]

Description:
When configuring a distributed environment on APIM-4.x servers, it would be better if we could provide a note mentioning that the following configuration is required to add on the control plane nodes.

[qpid.heartbeat]
delay = 60
timeout_factor = 2.0

Otherwise, we could observe the following errors on control plane nodes when the connection between the control plane and the gateway becomes idle. This may affect to API deployment issues on the gateway nodes.

ERROR {org.wso2.andes.transport.network.mina.MinaNetworkHandler} - Exception caught by Mina java.io.IOException: Connection timed out
 at java.base/sun.nio.ch.FileDispatcherImpl.read0(Native Method)
 at java.base/sun.nio.ch.SocketDispatcher.read(SocketDispatcher.java:39)
 at java.base/sun.nio.ch.IOUtil.readIntoNativeBuffer(IOUtil.java:276)
 at java.base/sun.nio.ch.IOUtil.read(IOUtil.java:245)
 at java.base/sun.nio.ch.IOUtil.read(IOUtil.java:223)
 at java.base/sun.nio.ch.SocketChannelImpl.read(SocketChannelImpl.java:358)
 at org.wso2.org.apache.mina.transport.socket.nio.SocketIoProcessor.read(SocketIoProcessor.java:218)
 at org.wso2.org.apache.mina.transport.socket.nio.SocketIoProcessor.process(SocketIoProcessor.java:198)
 at org.wso2.org.apache.mina.transport.socket.nio.SocketIoProcessor.access$400(SocketIoProcessor.java:45)
 at org.wso2.org.apache.mina.transport.socket.nio.SocketIoProcessor$Worker.run(SocketIoProcessor.java:485)
 at org.wso2.org.apache.mina.util.NamePreservingRunnable.run(NamePreservingRunnable.java:51)
 at java.base/java.lang.Thread.run(Thread.java:834)
TID: [-1234] [] [2024-08-23 01:21:01,890] ERROR {org.wso2.andes.server.protocol.AMQProtocolEngine} - IOException caught in/<ip>:45906(admin), session closed implictly: java.io.IOException: Connection timed out

[1] https://apim.docs.wso2.com/en/4.1.0/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-distributed-setup/

Suggested Labels:
APIM-4.0.0
APIM-4.1.0
APIM-4.2.0

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues: