Configuring System Event Thresholds

You can configure the set and clear thresholds that define when the following system events will be generated for the event broker.

Configuring System Service Event Thresholds

You can configure the following system service event thresholds:

The maximum number of client connections of any service type is dependent on the limits supported by the type of event broker that is used (for example, Solace PubSub+ 3560 with specific hardware blades, or Solace PubSub+ Standard).

Configuring Combined Connections Event Thresholds

To configure the threshold values that determine when to generate events for the combined client connections for all types of services for the entire event broker (that is, all client connections on any service on all Message VPNs), enter the following commands:

solace(configure/service)# event
solace(configure/service/event)# connections
solace(configure/service/event/connections)# thresholds {{[set-value <set-value>] [clear-value <clear-value>]} | {[set-percentage <set‑percentage>] [clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to the maximum total number of combined clients of all services that can be supported by the type of event broker used.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to the maximum total number of combined clients of all services that can be supported by the type of event broker and the version of NAB used.

<set-percentage> is a set threshold expressed as a percentage value from 0 to 100. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage value from 0 to 100. The default value is 60.

The no version of the command, no thresholds, reverts the thresholds back to the default values.

To view the maximum total number of SMF and Web transport client connections that can be supported, enter the show service User EXEC command.

Configuring SMF Service Connection Event Thresholds

To configure the threshold values for generating system event messages for simultaneous SMF client connections for the entire event broker - that is, for all SMF client connections on all Message VPNs - enter the following commands:

solace(configure)# service smf
solace(configure/service/smf)# event connections
solace(configure/service/smf/event/connections)# thresholds {{[set-value <set-value>] [clear-value <clear-value>]} | {[set-percentage <set‑percentage>] [clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to the maximum total number of SMF clients that can be supported by the type of event broker that the clients are connected to.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to the maximum total number of SMF clients that can be supported by the type of event broker that the clients are connected to.

<set-percentage> is a set threshold expressed as a percentage value from 0 to 100. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage value from 0 to 100. The default value is 60.

The no version of the command, no thresholds, reverts the thresholds back to the default values.

To view the maximum total number of SMF client connections that can be supported, enter the show service User EXEC command.

Configuring REST Outgoing Service Event Thresholds

To configure the threshold values for generating system events for outgoing REST client connections for the entire event broker - that is, for all outgoing REST client connections on all Message VPNs - enter the following commands:

solace(configure)# service rest
solace(configure/service/rest)# event
solace((configure/service/rest/event)# outgoing
solace(configure/service/rest/event/outgoing)# connections
solace(...rvice/rest/event/outgoing/connections)# thresholds {{[set-value <set-value>] [clear-value <clear-value>]} | {[set-percentage <set‑percentage>] [clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to the maximum total number of REST clients that can be supported by the type of event broker that the clients are connected to.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to the maximum total number of REST clients that can be supported by the type of event broker that the clients are connected to.

<set-percentage> is the set threshold expressed as a percentage value from 0 to 100. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage value from 0 to 100. The default value is 60.

The no version of the command, no thresholds, reverts the outgoing REST client connections thresholds back to the default values.

Configuring SSL-Encrypted Connections Service Event Thresholds

To configure the threshold values for generating system events for the total number of incoming and outgoing TLS/ SSL encrypted connections to the event broker - that is, for all TLS/SSL client connections on all Message VPNs - enter the following commands:

solace(configure)# service ssl
solace(configure/service/ssl)# event
solace(configure/service/ssl/event)# connections
solace(configure/service/ssl/event/connections)# thresholds {{[set-value <set-value>] [clear-value <clear-value>]} | {[set-percentage <set‑percentage>] [clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to the maximum total number of TLS/SSL clients that can be supported by the type of event broker that the clients are connected to.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to the maximum total number of TLS/SSL clients that can be supported by the type of event broker that the clients are connected to.

<set-percentage> is the set threshold expressed as a percentage value from 0 to 100. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage value from 0 to 100. The default value is 60.

The no version of the command, no thresholds, reverts the SSL connections thresholds back to the default values.

Configuring System Memory Usage Event Thresholds

An event broker generates memory usage events for the percentage of NAB egress buffers in use, the percentage of physical memory used, and the percentage of memory used by topic subscriptions. The memory usage threshold values are visible at the bottom of the output of the show memory User EXEC command.

solace> show memory
 

Memory (KB):
 
                    Total        Used        Free     Buffers      Cached
               ----------  ----------  ----------  ----------  ----------
Physical
  Memory          3693608     3515616      177992       25508      384764
  Low              416936      304068      112868
  High            3276672     3211548       65124
  Swap            2007992     2007992     1480144
Subscriptions
  Memory          1572864          15     1572849
 
IPC Buffers:
 
    Buffer                # Buffers                    Memory (KB)
Pool   Size(B)     Total    Used     Free       Total      Used      Free
--- ---------   ------- ------- -------   --------- --------- ---------
   0       256      8192       4    8188        2048         1      2047
   1      1920     53000       0   53000       99375         0     99375
   2     10240      1024       0    1024       10240         0     10240
   3    102400       450       0     450       45000         0     45000
   4   1048576        10       0      10       10240         0     10240
   5  10485760         1       0       1       10240         0     10240
 
Physical memory usage:  84.76%
Subscription memory usage:  0.00%

NAB Buffers:
 
Slot     NAB Buffer Load Factor
-------- ----------------------
1/6      0%
 
Event Threshold                           Set Value      Clear Value
---------------------------------- ---------------- ----------------
Subscriptions Memory (%)                         80               60
NAB Buffer Load Factor (%)                       80               60

NAB Buffer Load Factor Thresholds

To provide notice that NAB egress buffer usage on the event broker is getting high, a NAB Buffer Load Factor event based on the current percentage value of this gauge is generated before any slow subscribers are disconnected from the event broker.

To configure the event threshold values for the percentage of NAB egress buffer in use by the event broker, enter the following commands:

solace(configure)# memory-event 
solace(configure/memory-event)# nab-buffer-load-factor thresholds {set-percentage <set-percentage> | clear-percentage <clear-percentage>}

Where:

<set-percentage> is a set threshold expressed as a percentage value from 0 to 100. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage value from 0 to 100. The default value is 60.

The no version of the command, no nab-buffer-load-factor thresholds, reverts the thresholds back to their default values.

Configuring System Message Spool Event Thresholds

You can configure the set and clear thresholds that control when message spool system-level events are generated. You can configure any of the following message spool system-level event thresholds:

Cache Usage Thresholds

To configure the threshold values that determine when to generate events for the amount of NAB data buffer resources used by the Guaranteed Message cache, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# cache-usage thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value. The valid range is from 0 to 50.

<clear-value> is the clear threshold expressed as a count value. The valid range is from 0 to 50.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the max-cache-usage value. The default value is 80. The maximum cache usage is set through the cache-usage Message Spool CONFIG command (see Configuring Max Cache Usage).

<clear-percentage> is the clear threshold value expressed as a percentage (from 0 to 100) of the max-cache-usage value. The default value is 60.

The no version of this command, no cache-usage thresholds, resets the cache usage threshold values back to the default values.

Delivered Unacked Thresholds

To configure the threshold values that determine when to generate events for the total number of messages that have been delivered to clients, but have not been acknowledged by them, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# delivered-unacked thresholds {[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}

Where:

<set-percentage> is the set threshold value as a percentage (from 0 to 100) of the total number of messages that have been delivered to clients but have not been acknowledged by them. The default value is 80.

<clear-percentage> is the clear threshold as a percentage (from 0 to 100) of the total number of messages that have been delivered to clients but have not been acknowledged by them. The default value is 60.

The no version of this command, no delivered-unacked thresholds, resets the delivered-unacked thresholds back to the default values.

The maximum number of messages that can be delivered to clients, but remain unacknowledged by them, depends on the type of event broker used.

Disk Usage Thresholds

To configure the threshold values that determine when to generate events for the amount of disk space that is used, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# disk-usage thresholds {[set-percentage <set-percentage>][clear-percentage <clear‑percentage>]}

Where:

<set-percentage> is the set threshold value as a percentage (from 0 to 100) of the available disk space. The default value is 80.

<clear-percentage> is the clear threshold as a percentage (from 0 to 100) of the available disk space. The default value is 60.

The no version of this command, no disk-usage thresholds, resets the disk‑usage thresholds back to the default values.

Egress Flows Thresholds

To configure the threshold values that determine when to generate events for the total number of egress flows—that is, Guaranteed message client receive flows—in use on the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# egress-flows thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold value as a percentage (from 0 to 100) of the combined maximum number of egress flows for all Message VPNs. The default value is 80.

<clear-percentage> is the clear threshold set as a percentage (from 0 to 100) of the combined maximum number of egress flows for all Message VPNs. The default value is 60.

The no version of this command, no egress-flow thresholds, resets the egress-flow thresholds back to the default values.

The maximum number of egress flows is set on a per Message VPN‑basis. For information, see Message VPN-Level Guaranteed Messaging Configuration.

Endpoints Thresholds

To configure the threshold values that determine when to generate events for the total number of endpoints that are provisioned on the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# endpoints thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of endpoints allowed for the event broker. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage (from 0 to 100 of the maximum number of endpoints allowed for the event broker. The default value is 60.

The no version of this command, no endpoints thresholds, resets the endpoints thresholds back to the default values.

Ingress Flows Thresholds

To configure the threshold values that determine when to generate events for the total number of ingress flows—that is, Guaranteed message client publish flows—on the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# ingress-flows thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the combined maximum number of ingress flows for all Message VPNs. The default value is 80.

<clear-percentage> is the clear threshold value expressed as a percentage (from 0 to 100) of the combined maximum number of ingress flows for all Message VPNs. The default value is 60.

The no version of this command, no ingress-flows thresholds, resets the max-ingress-flows thresholds back to the default values.

The number of permitted ingress flows is set on a per Message VPN‑basis. For information, see Message VPN-Level Guaranteed Messaging Configuration.

Message Count Thresholds

To configure the threshold values that determine when to generate events for the total number of spooled messages for the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# message-count thresholds {[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}

Where:

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of messages that can be spooled for the system. The default value is 80.

<clear-percentage> is the clear threshold percentage expressed as a percentage (from 0 to 100) of the maximum number of spool messages that can be spooled for the system. The default value is 60.

The no version of this command, no message-count thresholds, resets the message-count thresholds back to the default values.

Spool Files Thresholds

Guaranteed messages are spooled to an event broker through the use of internal spool files. If event broker’s spool files are all in use, it cannot receive any more messages until some messages are acknowledged, thereby freeing some spool files; any further ingress messages are discarded, and nacks are returned to the publishing clients to inform them of the discards.

You can configure threshold values to control when events are generated to warn about the spool file usage.

To configure the thresholds, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# spool-files thresholds {[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}

Where:

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the available system-level spool files. The default value is 80.

<clear-percentage> is the clear threshold percentage expressed as a percentage (from 0 to 100) of the available system-level spool files. The default value is 60.

The no version of this command, no spool-files thresholds, resets the thresholds to the default values.

Spool Usage Thresholds

To configure the thresholds that determine when to generate events for message spool usage for the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# spool-usage thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold expressed as a percentage (from 0 to 100) of the maximum system-level message spool usage.

<clear-percentage> is the clear threshold expressed as a percentage (from 0 to 100) of the maximum system-level message spool usage.

The no version of this command, no spool-usage thresholds, resets event generation for the maximum system-level message spool usage back to the defaults.

For information on how to set the maximum system-level message spool usage, see Configuring Max Spool Usage.

Transacted Session Resources Thresholds

To configure the threshold values that determine when to generate events for the amount of system-wide buffer resources used to support the current number of messages pending in transacted sessions, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# transacted-session-resources thresholds {[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}

Where:

<set-percentage> is the set threshold expressed as a percentage (from 0 to 100) of the maximum number of transacted session resources for the event broker. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage (from 0 to 100) of the maximum number of transacted session resources for the event broker. The default value is 60.

The no version of this command, no transacted-session-resources thresholds, resets the transacted-session-resources event thresholds back to the defaults.

Transacted Sessions Thresholds

To configure the threshold values that determine when to generate events for the total number of simultaneous transacted sessions and/or XA Sessions on the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# transacted-sessions thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold expressed as a percentage (from 0 to 100) of the maximum number of simultaneous transacted sessions allowed for the event broker. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage (from 0 to 100) of the maximum number of simultaneous transacted sessions allowed for the event broker. The default value is 60.

The no version of this command, no transacted-sessions thresholds, resets the transacted-sessions event thresholds back to the default values.

Transaction Thresholds

To configure the threshold values that determine when to generate events for the total number of simultaneous transactions—both local transactions and transactions within XA transaction branches—on the event broker, enter the following commands:

solace(configure)# hardware message-spool
solace(configure/hardware/message-spool)# event
solace(configure/hardware/message-spool/event)# transactions thresholds {{[set-value <set-value>] [clear-value <clear-value>]}|{[set-percentage <set-percentage>][clear-percentage <clear-percentage>]}}

Where:

<set-value> is the set threshold expressed as a count value.

<clear-value> is the clear threshold expressed as a count value.

<set-percentage> is the set threshold expressed as a percentage (from 0 to 100) of the maximum number of simultaneous transactions allowed for the event broker. The default value is 80.

<clear-percentage> is the clear threshold expressed as a percentage (from 0 to 100) of the maximum number of simultaneous transactions allowed for the event broker. The default value is 60.

The no version of this command, no transactions thresholds, resets the transactions event thresholds back to the default values.