Configuring Cache Cluster Event Thresholds

For a number of operating conditions experienced by PubSub+ Cache Instances, you can configure high and low thresholds at the Cache Cluster level that determine which events are published to the message bus.

To configure event threshold parameters for the PubSub+ Cache Instances in a given Cache Cluster, enter the following commands:

solace# configure
solace(config)# distributed-cache <name> message-vpn <vpn-name>
solace(config-distributed-cache)# cache-cluster <name>
solace(config-distributed-cache-cluster)# event

The CLI is now at a configuration level at which you can configure set and clear thresholds for Cache Cluster events.

To view the existing event configurations for a Cache Cluster, enter the show cache-cluster detail User EXEC command. Refer to Show Cache Cluster.

Data Byte Rate Thresholds

To configure the set and clear event thresholds for the rate of cached data experienced by the Cache Cluster (measured in bytes per second), enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# data-byte-rate
solace(config-distributed-cache-cluster-event-data-byte-rate)# thresholds {set-value <set-value>} {clear-value <clear-value>}

Where:

<set-value> is the high set threshold value from 1 to 4294967295. An event is triggered each time the value reaches or exceeds this threshold. The default value is 250000000 (2 Gbps). The set value must be larger than the clear value.

<clear-value> is the low clear threshold value from 0 to 4294967295. An event is cleared each time the value falls below this threshold. The default value is 187500000 (1.5 Gbps).

The no version of this command, no data-byte-rate thresholds, reverts the threshold values back to the defaults.

Data Message Rate Thresholds

To configure the set and clear event thresholds for the cached data message rate experienced by the Cache Cluster (measured in messages per second), enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# data-message-rate
solace(config-distributed-cache-cluster-event-data-message-rate)# thresholds {set-value <set-value>} {clear-value <clear-value>}

Where:

<set-value> is the high set threshold value from 1 to 4294967295. An event is triggered each time the value reaches or exceeds this threshold. The default value is 4800. The set value must be larger than the clear value.

<clear-value> is the low clear threshold value from 0 to 4294967295. An event is cleared each time the value falls below this threshold. The default value is 3600.

The no version of this command, no data-message-rate thresholds, reverts the threshold values back to the defaults.

Max Memory Thresholds

To configure the set and clear event thresholds for the maximum memory consumption of each PubSub+ Cache instance within the Cache Cluster, enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# max-memory
solace(config-distributed-cache-cluster-event-max-memory)# thresholds {set-value <set-value>} {clear-value <clear-value>}

Where:

<set-value> is the high set threshold value for the maximum memory consumption (as a percentage) of each Cache Instance. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 80. The set value must be larger than the clear value.

<clear-value> is the low clear threshold value for the maximum memory consumption (as a percentage) of each PubSub+ Cache Instance. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 60.

The no version of this command, no max-memory thresholds, reverts the threshold values back to the defaults.

Max Topics Thresholds

To configure the set and clear event thresholds for the maximum number of topics each PubSub+ Cache Instance in the Cache Cluster can cache, enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# max-topics
solace(config-distributed-cache-cluster-event-max-topics)# thresholds {set-value <set-value>} {clear-value <clear-value>}

Where:

<set-value> is the high set threshold value for the maximum number of topics (as a percentage) that each Cache Instance can cache. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 80. The set value must be larger than the clear value.

<clear-value> is the low clear threshold value for the maximum number of topics (as a percentage) that each PubSub+ Cache Instance can cache. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 60.

The no version of this command, no max-topics thresholds, reverts the threshold values back to the defaults.

Request Queue Depth Thresholds

To configure the set and clear event thresholds for the cache request depth of each PubSub+ Cache Instance in the Cache Cluster, enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# request-queue-depth
solace(config-distributed-cache-cluster-event-req-q-depth)# thresholds {set-value <set-value>} {clear-value <clear-value>}

Where:

<set-value> is the high set threshold value for the cache request queue depth (as a percentage) for each PubSub+ Cache Instance in the Cache Cluster. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 80. The set value must be larger than the clear value.

<clear-value> is the low clear threshold value for the cache request queue depth (as a percentage) for each PubSub+ Cache Instance in the Cache Cluster. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 60.

The no version of this command, no request-queue-depth thresholds, of this command reverts the threshold values back to the defaults.

Request Rate Thresholds

To configure the set and clear event thresholds for each PubSub+ Cache Instance in the Cache Cluster, enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# request-rate
solace(config-distributed-cache-cluster-event-req-rate)# thresholds {set-value <set-value>} {clear-value <clear-value>}

Where:

<set-value> is the high set threshold value (as a percentage) for the cache request queue depth for each PubSub+ Cache Instance in the Cache Cluster. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 80. The set value must be larger than the clear value.

<clear-value> is the low clear threshold value (as a percentage) for the cache request queue depth for each PubSub+ Cache Instance in the Cache Cluster. The valid values are from 1 to 100. An event is triggered each time the value reaches or exceeds this threshold. The default value is 60.

The no version of this command, no request-rate thresholds, reverts the threshold values back to the default.

Response Rate Thresholds

To configure the set and clear event thresholds for the frequency of cache response rate (measured in messages per second) for each PubSub+ Cache Instance in the Cache Cluster, enter the following Distributed Cache CONFIG commands:

solace(config-distributed-cache-cluster-event)# response-rate
solace(config-distributed-cache-cluster-event-resp-rate)# thresholds {set-value <set-value> | clear-value <clear-value>}

Where:

<set-value> is the high set threshold value from 1 to 4294967295. An event is triggered each time the value rises above this threshold. The default value is 80000. The set value must be larger than the clear value.

<clear-value> is the low clear threshold value from 0 to 4294967295. An event is cleared each time the value falls below this threshold. The default value is 1000.

The no version of this command, no request-rate thresholds, reverts the threshold values back to the defaults.