Bridge Config (bridge.ncconf)

The bridge configuration file contains information regarding all registered bridges for geo replication. The bridge.ncconf file is installed with NCache and is used whenever you add an existing bridge in the NCache Management Center. All bridge related configurations are stored in a single bridge.ncconf file. The user can change the configuration of a bridge from the NCache Management Center or from the bridge.ncconf file.

Note

This file is located at %NCHOME%\config in Windows or /opt/ncache/config in Linux.

Bridge Config Syntax

The cache configuration file is explained below.

<configuration>
  <bridge-config config-id="64e33aab-966c-4ff3-a51e-05cfb77f6fc4" config-version="0" deployment-version="0" id="myBridge" bridge-nodes="20.200.20.35,20.200.20.32" num-bridge-nodes="2" bridge-active="20.200.20.35" bridge-port="10029" opt-timeout="60" src-cache="" topology="active-passive" replicator-virtual-queue-size="2048MB" auto-start="False">
    <log enabled="True" trace-errors="True" trace-notices="False" trace-warnings="False" trace-debug="False"/>
    <queue optimized="False" size="2048"/>
    <perf-counter enabled="True"/>
  </bridge-config>
</configuration>

Understanding the Bridge Config Tags

The following section explains the tags mentioned as part of the file syntax.

<bridge-config>

<bridge-config config-id="64e33aab-966c-4ff3-a51e-05cfb77f6fc4" config-version="0" deployment-version="0" id="myBridge" bridge-nodes="20.200.20.35,20.200.20.32" num-bridge-nodes="2" bridge-active="20.200.20.35" bridge-port="10029" opt-timeout="60" src-cache="" topology="active-passive" replicator-virtual-queue-size="2048MB" auto-start="False">

config-id: Identifies the bridge cache configurations.
config-version: Specifies the number of updates to the bridge configuration, maintaining version consistency across all nodes.
deployment-version: Specifies the number of changes made to the bridge deployment, ensuring version consistency across all nodes.
id: Specifies a unique ID to identify the bridge cache.
bridge-nodes: Specifies the IPs of Server nodes involved in making up this bridge.
num-bridge-nodes: Determines the number of servers involved in making up the bridge node.
bridge-active: Represents the active node in the bridge.
bridge-port: Port number on which the bridge is hosted.
opt-timeout: (Operation Timeout) Specifies the time after which the bridge will consider itself disconnected from the connected caches. The default value is 60 seconds.
topology: Specifies the topology used for the cache clusters that are part of the bridge.
replicator-virtual-queue-size: It is the size of a virtual queue for the replicator that replicates data from the bridge to the target cache. The default size is 2048 MB.
auto-start: When set to True, it automatically starts the bridge on service restart. The default value is False.

<log>

NCache maintains a log file to write traces for information and debugging purposes. NCache provides different types of traces, as shown in the above XML tag. Using these tags user can enable\disable the various traces. By default only the “Error” trace is enabled, rest of the traces are disabled. Error trace does not affect the cache performance but for other traces, we recommend not to enable them in a production environment as they affect the performance of NCache. Here log files for each cache will be created at %NCHOME%\config in Windows and /opt/ncache/config for Linux which contains information related to the enabled traces.

<log enabled="True" trace-errors="True" trace-notices="False" trace-warnings="False" trace-debug="False"/>

enabled: This allows you to maintain a log file by specifying a Boolean value. By default, it is False as logging can create an overhead and degrade application performance.
trace-errors: Logs error traces, essential for identifying and troubleshooting critical issues. By default, it is True.
trace-notices: Logs notice traces for general informational messages. By default, it is False.
trace-warnings: Logs warning traces, useful for detecting and addressing potential issues. By default, it is False.
trace-debug: Logs detailed debug traces, helpful for diagnosing problems and analyzing system behavior during development or testing. By default, it is False.

<queue>

This tag configures settings for a data queue.

<queue optimized="False" size="2048"/>

optimized: When set to True, it enables the bridge queue optimization. By default, it is False.
size: Specifies the upper limit of queue size in MB. The amount of items in the queue is limited by the maximum queue size and amount of free memory. The default value is 2048.

<perf-counter>

When configured, NCache will update the published PerfMon counters.

<perf-counter enabled="True"/>

enabled: When set to True, NCache will update the published PerfMon counters.

<cache>

<cache cache-id="demoClusteredCache.WestCoast" status="active" servers-list="20.200.20.38" bulk-operation-size="500" enable-compression="False" connection-retry-interval="3" heart-beat-enabled="True" replicator-virtual-queue-size="2048MB" is-connected="True" is-master="False"/>

cache-id: Specifies a unique ID to identify the cache connect to the bridge.
status: Determines the status of the cache connected to the bridge. It can either be active or passive depending on the selected topology.
servers-list: Determines the server nodes comprising the cache clusters.
bulk-operation-size: Specifies an upper limit on the size of the bundled operation that is to be replicated on the target cache. The default size is 500.
enable-compression: Allows you to enable compression while sending operations on its Target Cache. The default value is False.
connect-retry-interval: Specifies the interval between the two consecutive retries to connect with the target cache, if not already connected. The default size is 3.
heart-beat-enabled: Specifies if a heartbeat has been enabled for the cache.
replicator-virtual-queue-size: Specifies the size of a virtual queue for the replicator that replicates data from the bridge to the target cache. The default size is 2048 MB.
is-connected: Specifies if the cache is connected to the bridge.