Configuring VPN Event Thresholds

You can configure the set and clear thresholds that control when Message VPN events are generated for a given Message VPN. You can configure any of the following event thresholds:

Connections Thresholds

To configure the threshold values that determine when to generate events for the combined number of client connections of all service types (that is, SMF, Web transport, and incoming REST connections) that simultaneously connect in a Message VPN, enter the following commands:

solace(configure)# message-vpn <vpn-name>
solace(configure/msg-vpn)# event
solace(configure/msg-vpn/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 client and combined Web transport/REST clients that can be supported by the type of event broker (for example, Solace PubSub+ 3530 or Solace PubSub+ 3560) and the version of NAB used.

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

<set-percentage> is the set threshold value expressed as a percentage (from 0 to 100) of the maximum number of client connections that can simultaneously connect to the given Message VPN. The default is 80. (For information on setting the max-connections, see Configuring Maximum Connections.)

<clear-value> is the clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of client connections that can simultaneously connect to the given Message VPN. The default is 60.

The no version of this command (no connections thresholds) reverts the thresholds back to the default values for the Message VPN.

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

Egress Message Rate Thresholds

To configure the threshold values that determine when to generate events for the configured aggregate egress message rate in a Message VPN, enter the following commands:

solace(configure)# message-vpn <vpn-name>
solace(configure/msg-vpn)# event
solace(configure/msg-vpn/event)# egress-message-rate thresholds {set-value <set-value> | clear-value <clear-value>}

Where:

<set-value> is the set threshold expressed as a count value (measured in messages/second).

<clear-value> is a clear threshold expressed as a count value (measured in messages/second).

The no version of the command (no egress-message-rate thresholds) reverts the thresholds back to the default values.

Ingress Message Rate Thresholds

To configure the threshold values that determine when to generate events for the configured aggregate ingress message rate in a Message VPN, enter the following commands:

solace(configure)# message-vpn <vpn-name>
solace(configure/msg-vpn)# event
solace(configure/msg-vpn/event)# ingress-message-rate thresholds {set-value <set-value> | clear-value <clear-value>}

Where:

<set-value> is the set threshold expressed as a count value (measured in messages/second).

<clear-value> is a clear threshold expressed as a count value (measured in messages/second).

The no version of the command (no ingress-message-rate thresholds) reverts the thresholds back to the default values.

Large Message Threshold

The large message threshold generates events when the size of a message in a Message VPN exceeds a specified size.

To configure the large message threshold, enter the following commands:

solace(configure)# message-vpn <vpn-name>
solace(configure/msg-vpn)# event
solace(configure/msg-vpn/event)# large-message-threshold <size>

Where:

<size> is an integer value that represents the maximum message size in KB.

Once triggered, this event must be reset through the clear-event Admin EXEC command. For more information, see Clearing One-Shot Events.

The no version of the command (no large-message-threshold) reverts the threshold value back to the default.

Service Thresholds

For a given Message VPN, you can configure the thresholds at which events are generated for clients that use a specific service type. You can configure the set and clear event thresholds for the following types of services:

AMQP

To configure the threshold values that determine when to generate events for the incoming REST connections made to a Message VPN, enter the following commands:

solace(configure/message-vpn/event)# service amqp
solace(configure/message-vpn/event/service/amqp)# connections
solace(...ent/service/rest/incoming/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.

<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 AMQP connections allowed for the Message VPN. 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 AMQP connections allowed for the Message VPN. The default value is 60.

The no version of this command (no thresholds) resets the AMQP connections thresholds back to the default values.

For information on setting the maximum number of incoming AMQP connections for a Message VPN, see Set Maximum Number of AMQP Connections.

MQTT

To configure the threshold values that determine when to generate events for the incoming REST connections made to a Message VPN, enter the following commands:

solace(configure/message-vpn/event)# service mqtt
solace(configure/message-vpn/event/service/mqtt)# connections
solace(...ent/service/rest/incoming/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.

<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 MQTT connections allowed for the Message VPN. 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 MQTT connections allowed for the Message VPN. The default value is 60.

The no version of this command (no thresholds) resets the MQTT connections thresholds back to the default values.

For information on setting the maximum number of incoming MQTT connections for a Message VPN, see Setting the Maximum Number of MQTT Connections.

REST

To configure the threshold values that determine when to generate events for the incoming REST connections made to a Message VPN, enter the following commands:

solace(configure/message-vpn/event)# service rest
solace(configure/message-vpn/event/service/rest)# incoming connections
solace(...ent/service/rest/incoming/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.

<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 incoming REST connections allowed for the Message VPN. 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 incoming REST connections allowed for the Message VPN. The default value is 60.

The no version of this command (no thresholds) resets the incoming REST connections thresholds back to the default values.

For information on setting the maximum number of incoming REST connections for a Message VPN, see Setting the Max Incoming Connections.

SMF

To configure the threshold values that determine when to generate events for the number of SMF client connections made to a Message VPN, enter the following commands:

solace(configure/message-vpn/event)# service smf connections
solace(configure/message-vpn/event/service/smf/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.

<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 simultaneous SMF client connections allowed for the Message VPN. The default value is 80.

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

The no version of this command (no thresholds) resets the SMF connections thresholds back to the default values.

For information on configuring the maximum number of SMF clients that can be simultaneously connected to a given Message VPN on an event broker, see Configuring Services.

Web Transport

To configure the threshold values that determine when to generate events for the number of Web transport client connections made to a Message VPN, enter the following commands:

solace(configure/message-vpn/event)# service web-transport connections
solace(...ssage-vpn/event/service/web-transport/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.

<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 incoming Web transport connections allowed for the Message VPN. 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 incoming Web transport connections allowed for the Message VPN. The default value is 60.

The no version of this command (no thresholds) resets the Web transport connections thresholds back to the default values.

For information on configuring the maximum number of Web transport clients that can be simultaneously connected to a given Message VPN on an event broker, see Configuring Services.

Subscriptions Thresholds

To configure the threshold values that determine when to generate events for the number of subscriptions allowed for a Message VPN, enter the following commands:

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

Where:

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

<clear-value> is a 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 local client subscriptions (both primary and backup) allowed for the Message VPN. The default is 80. (For information on setting the max-connections, see Configuring Maximum Subscriptions.)

<clear-value> is a clear threshold value expressed as a percentage (from 0 to 100) of the maximum number of local client subscriptions (both primary and backup) allowed for the Message VPN. The default is 60.

The no version of the command (subscriptions no thresholds) disables event generation for subscriptions in a Message VPN.