Client Failover
- Last UpdatedJun 26, 2026
- 2 minute read
Use client failover to help maintain data flow when the primary client connection is unavailable.
Client failover lets you define backup endpoints, specify the order in which they are used, and control how the adapter retries or reconnects during connection interruptions.
Note: This configuration is not available for the Azure Event Hubs adapter.
Client-level failover means the adapter itself monitors its connection to the database and switches to a backup if the primary fails. This allows the adapter to keep collecting and sending data without needing help from the server or manual intervention.
Use the Client Failover configuration to register an adapter instance with a failover group managed by a failover endpoint. The failover endpoint monitors group members and assigns Primary and Secondary roles, helping ensure continued data collection if an adapter instance becomes unavailable.
Configure the failover group ID, and endpoint connection parameters as required for your environment. See Optional parameters for additional information on defining the remaining client failover parameters.
Required parameters
The following is a list of required parameters for client failover:
|
Parameter |
Description |
|---|---|
|
Endpoint |
The URL of a destination that supports client failover registration. Supported destinations include CONNECT data services and on-premise Failover service. For example: Client Failover service http://<hostname>:<port>/api/v1/configuration/System/ClientFailover CONNECT data services <namespace region>.datahub.connect.aveva.com/api/v1/Tenants/<tenant id>/Namespaces/<namespace id>/ClientFailover/ |
|
Failover Group Id |
In the adapter instance, the ID of the failover group where the adapter is registered. |
|
Failover Timeout |
The failover timeout value of the failover group. This defines how frequently the adapter sends a heartbeat to the failover endpoint. The heartbeat is sent at every FailoverTimeout / 2 interval. The timespan should be entered in the following format: hh:mm:ss |
|
Mode |
The failover mode of the registered adapter. The available values are Hot, Warm, Cold. Note: The Structured Data Files adapter only supports warm and cold failover. For additional information, see the Failover modes section in your adapter documentation. |
Note: Failover group name, description and failover timeout cannot be changed once created. To change it, the group must be deleted on the failover service side and recreated.