What information does bridge.ncconf contain?

The bridge.ncconf file contains configuration information for registered NCache Bridges, including Bridge nodes, communication settings, connected caches, logging, replication queues, and performance counters.

How are connected caches represented in bridge.ncconf?

Each connected cache is represented by a cache element containing replication and connection settings, along with a nested server element specifying the cache endpoint.

What is the Bridge queue size in the example configuration?

The Bridge queue size is configured as 2048 MB.

Is Bridge auto-start enabled in the example configuration?

No. The auto-start attribute is set to False. When set to True, the Bridge starts automatically when the NCache service restarts.

Bridge Config (bridge.ncconf)

Q: Where is the bridge.ncconf file located in NCache?

The bridge.ncconf file is located in %NCHOME%\config on Windows and /opt/ncache/config on Linux.

The bridge.ncconf file contains configuration information for registered NCache Bridges used in multi-site replication, including Bridge nodes, communication settings, connected caches, replication queues, logging, and performance counters. This file is installed with NCache and is automatically updated whenever a Bridge is added or configured through the NCache Management Center.

The bridge.ncconf file maintains Bridge configuration settings and the connection information for caches associated with each Bridge. You can manage these settings through the NCache Management Center.

Note

This file is located in %NCHOME%\config on Windows and /opt/ncache/config on Linux.

Bridge Config Syntax

The following XML shows an example of the Bridge configuration stored in bridge.ncconf.

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <bridge-config config-id="64e33aab-966c-4ff3-a51e-05cfb77f6fc4" auto-start="False" deployment-version="1" config-version="2" id="defaultBridge" bridge-nodes="20.200.20.12" num-bridge-nodes="1" bridge-active="20.200.20.12" bridge-port="9818" opt-timeout="60" src-cache="" topology="active-active" replicator-virtual-queue-size="2048MB">
    <log enabled="True" trace-errors="True" trace-notices="False" trace-warnings="False" trace-debug="False"/>
    <queue optimized="False" size="2048"/>
    <perf-counter enabled="True"/>
    <cache cache-id="defaultcache.env1" status="active" 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">
      <server name="20.200.20.12" is-load-balancer="False"/>
    </cache>
  </bridge-config>
</configuration>

Understanding the Bridge Config Tags

The following sections describe the configuration elements and attributes used in the bridge.ncconf file.

<bridge-config>

The <bridge-config> element defines the configuration of a Bridge, including its identity, participating nodes, communication port, and replication settings.

<bridge-config config-id="64e33aab-966c-4ff3-a51e-05cfb77f6fc4" auto-start="False" deployment-version="1" config-version="2" id="defaultBridge" bridge-nodes="20.200.20.12" num-bridge-nodes="1" bridge-active="20.200.20.12" bridge-port="9818" opt-timeout="60" src-cache="" topology="active-active" replicator-virtual-queue-size="2048MB">

config-id: Specifies a unique identifier for the Bridge configuration.
auto-start: Specifies whether the Bridge starts automatically when the NCache service restarts. When set to True, the Bridge starts automatically. The default value is False.
deployment-version: Specifies the version of the Bridge deployment configuration. This value changes when the Bridge deployment is updated.
config-version: Specifies the version of the Bridge configuration. This value is used to maintain configuration consistency across Bridge nodes.
id: Specifies the unique name of the Bridge. In this example, the Bridge is named defaultBridge.
bridge-nodes: Specifies the IP address or comma-separated list of IP addresses of the server nodes configured to host the Bridge.
num-bridge-nodes: Specifies the number of server nodes configured for the Bridge.
bridge-active: Specifies the IP address of the active Bridge node.
bridge-port: Specifies the port used for Bridge communication. In this example, the Bridge uses port 9818.
opt-timeout: Specifies the timeout interval after which the Bridge considers its connection with a connected cache to be disconnected. The configured value is 60 seconds.
src-cache: Specifies the source cache associated with Bridge replication. In this example, the attribute is empty.
topology: Specifies the replication topology configured for the Bridge. In this example, the topology is set to active-active.
replicator-virtual-queue-size: Specifies the size of the virtual queue used by the replicator to replicate operations from the Bridge to the target cache. The configured value is 2048MB.

<log>

The <log> element controls logging for the Bridge. NCache records Bridge-related messages according to the configured trace levels. Error logging can be used for regular monitoring, while detailed traces can be enabled when troubleshooting Bridge operations.

Bridge log files are stored in %NCHOME%\log-files on Windows and /opt/ncache/log-files on Linux.

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

enabled: Specifies whether logging is enabled for the Bridge. When set to True, NCache records messages according to the configured trace levels. The configured value is True.
trace-errors: Enables logging of error messages to help identify and troubleshoot Bridge-related failures. The configured value is True.
trace-notices: Enables logging of informational messages related to Bridge operations. The configured value is False.
trace-warnings: Enables logging of warning messages that indicate potential issues with Bridge operations. The configured value is False.
trace-debug: Enables detailed debugging messages for troubleshooting Bridge operations. The configured value is False.

Note

Detailed logging can affect performance. Enable additional trace levels when troubleshooting and disable them when they are no longer required.

<queue>

The <queue> element defines the queue settings used to manage replication operations between caches connected through the Bridge.

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

optimized: Specifies whether Bridge queue optimization is enabled. When set to True, queue optimization is enabled. The configured value is False.
size: Specifies the maximum size of the Bridge queue in MB. The number of operations stored in the queue depends on the configured queue size and available memory. The configured value is 2048 MB.

<perf-counter>

The <perf-counter> element specifies whether performance counters are enabled for monitoring Bridge operations.

<perf-counter enabled="True"/>

enabled: Specifies whether performance counters are enabled for the Bridge. When set to True, NCache exposes Bridge performance counters for monitoring. The configured value is True.

<cache>

The <cache> element defines the configuration of a cache connected to the Bridge. It contains the cache identifier, replication settings, connection status, and server endpoint information.

Each connected cache is represented by a separate <cache> element containing its associated <server> configuration.

<cache cache-id="defaultcache.env1" status="active" 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">
  <server name="20.200.20.12" is-load-balancer="False"/>
</cache>

cache-id: Specifies the unique identifier of the cache connected to the Bridge. In this example, the cache identifier is defaultcache.env1.
status: Specifies the replication status of the connected cache. The value can be active or passive, depending on the replication configuration. In this example, the cache status is active.
bulk-operation-size: Specifies the maximum number of replication operations grouped into a single batch before being sent to the target cache. The configured value is 500.
enable-compression: Specifies whether compression is enabled when sending replication operations to the target cache. When set to True, compression is enabled. The configured value is False.
connection-retry-interval: Specifies the interval in seconds between consecutive connection retry attempts when the Bridge attempts to reconnect to the cache. The configured value is 3 seconds.
heart-beat-enabled: Specifies whether heartbeat monitoring is enabled for the connected cache. When set to True, heartbeat monitoring is enabled. The configured value is True.
replicator-virtual-queue-size: Specifies the size of the virtual queue used to manage replication operations for the connected cache. The configured value is 2048MB.
is-connected: Indicates whether the cache is connected to the Bridge. When set to True, the cache is marked as connected. The configured value is True.
is-master: Specifies whether the connected cache acts as the master in an active-passive replication configuration. When set to True, the cache acts as the master for replication operations. The configured value is False.

<server>

The <server> element is defined within the <cache> element and specifies the endpoint that the Bridge uses to connect to the associated cache. The endpoint can be a cache server IP address, hostname, or load balancer address.

<server name="20.200.20.12" is-load-balancer="False"/>

name: Specifies the IP address, hostname, or load balancer endpoint used by the Bridge to connect to the cache. In this example, the server IP address is 20.200.20.12.
is-load-balancer: Specifies whether the endpoint defined by name represents a load balancer. When set to True, the Bridge uses the specified load balancer endpoint. When set to False, the endpoint represents a cache server. The configured value is False.

Bridge Config (bridge.ncconf)

Note

Bridge Config Syntax

Understanding the Bridge Config Tags

<bridge-config>

<log>

Note

<queue>

<perf-counter>

<cache>

<server>

See Also

Contact Us