Solace System Clients Test

Clients connect to the target Solace PubSub+ Event Broker through Message VPNs using different protocols such as SMF, REST, web service, etc. Clients in different Message VPNs are allowed to subscribe to identical topics, and clients in different Message VPNs can publish messages to topics that match those client subscriptions. However, based on Message VPN membership, only clients connected to the same Message VPN as a particular publisher receive messages from that publisher.

Solace PubSub+ Event Brokers support the following message delivery modes:

At-most-once delivery: There are two options that are provided namely - Direct and Non-Persistent message delivery. Non-Persistent message delivery mode is primarily used to fulfill JMS specification requirements. For Solace Messaging APIs, non-persistent messages perform the same function as Persistent messages. Direct messaging is meant for use with high-speed applications that can tolerate occasional message loss. Producers can publish messages to a topic, and when these messages are received by the event broker, they are delivered to Consumers with matching topic subscriptions. Non-Persistent messaging delivery mode is primarily used to fulfill JMS specification requirements. It is also used in message promotion and demotion.
At-least-once delivery: Solace PubSub+ Event Brokers provide this through Persistent (Guaranteed) messaging, which is often referred to as Guaranteed messaging. Persistent messaging is a combination of: sending persistent messages with proper publication confirmation handling, and at least once delivery. Guaranteed messages are never lost.
Transacted delivery: Solace PubSub+ Event Brokers support session based and XA transactions.

Message discards can occur if an event broker’s egress per-client priority queues fill up with received messages. When this occurs, the oldest messages on the queues can be discarded to allow new incoming messages to be enqueued. Egress per-client priority queues could fill up in a situation where “slow subscribers” are not consuming messages quickly enough.

If the clients are not connected to the broker or if there are too many incoming /outgoing message discards, then, administrators should initiate troubleshooting to analyze the real reason which may range from connectivity issues to clients being slow subscribers. To help administrators perform such analysis at a faster pace, eG Enterprise offers the Solace System Clients test.

This test reports the count of clients connected to the target Solace PubSub+ Event Broker and also provides the split up count of the clients connected using REST, MQTT, web service and SMF protocols/services. This test also helps administrators identify the message delivery mode through which maximum number of messages were sent from/received by the target broker - is it direct? or persistent? or non-persistent? This test also throws light on incoming and outgoing message discards and exactly pinpoints to the type of message discard that is frequently noticed on the target broker.

Target of the test : A Solace PubSub+ Event Broker

Agent deploying the test : A remote agent

Outputs of the test : One set of results for the target Solace PubSub+ Event Broker being monitored

Configurable parameters for the test
Parameter	Description
Test Period	How often should the test be executed.
Host	The IP address of the target host for which this test is to be configured.
Port	Refers to the port at which the Solace PubSub+ Event Broker listens to.
UserName and Password	By default, the eG agent executes SEMP ( Solace Element Management Protocol) APIs on the target broker to collect the required metrics. For the eG agent to execute the SEMP APIs, a special user with read only privilege is required. Specify the credentials of such a user in the UserName and Password text boxes. To know how to create such a user, refer to Creating a New User for Monitoring Solace PubSub+ Event Broker.
Confirm Password	Confirm the Password by retyping it in the Confirm Password text box.
SSL	By default, this flag is set to No indicating that the Solace PubSub+ Event Broker is not SSL-enabled by default. Set this flag to Yes if the Solace PubSub+ Event Broker is SSL-enabled.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Total clients	Indicates the total number of clients that are allowed to connect to the target broker.	Number
Connected clients	Indicates the total number of clients that are currently connected across all protocols to the target broker.	Number
MQTT clients connected	Indicates the number of clients connected to the target broker via MQTT protocol.	Number	Compare the value of this measure with Total REST clients connected, Total SMF clients connected and Total web service clients connected measures to identify the protocol/service through which maximum number of clients were connected to the target broker.
Total REST clients connected	Indicates the number of clients connected to the target broker via REST API.	Number	Compare the value of this measure with MQTT clients connected, Total SMF clients connected and Total web service clients connected measures to identify the protocol/service through which maximum number of clients were connected to the target broker.
Total SMF clients connected	Indicates the number of clients connected to the target broker via native SMF (Solace Message Format) protocol.	Number	Compare the value of this measure with MQTT clients connected, Total REST clients connected and Total web service clients connected measures to identify the protocol/service through which maximum number of clients were connected to the target broker.
Total web service clients connected	Indicates the number of clients connected to the target broker via web service.	Number	Compare the value of this measure with MQTT clients connected, Total REST clients connected and Total SMF clients connected measures to identify the protocol/service through which maximum number of clients were connected to the target broker.
Total clients connected with compression	Indicates the number of clients that use data compression while connecting to the target broker.	Number
Total SSL clients connected	Indicates the total number of clients connected to the broker through SSL.	Number
Total client messages traffic received	Indicates the amount of bytes of client messages received by the target broker during the last measurement period.	MB	These measures are a good indicator of load on the target broker.
Total client messages traffic sent	Indicates the amount of bytes of client messages sent from the target broker during the last measurement period.	MB
Total client messages received	Indicates the total number of client messages received by the target broker during the last measurement period.	Number	These measures are a good indicator to figure out the message handling ability of the target broker.
Total client messages sent	Indicates the total number of client messages sent from the target broker during the last measurement period.	Number
Client direct messages traffic received	Indicates the amount of bytes of direct messages received by the target broker during the last measurement period.	MB	Direct messaging provides a reliable, but not guaranteed, delivery of messages from the Solace message bus to consuming clients, and is the default message delivery system for Solace PubSub+. It doesn't require any configuration beyond that required to set up and start other features. By default, direct messaging is always available to all clients connecting to an event broker. Characteristics of direct messages Delivered to subscribing clients in the order in which publishers publish them. Don't require acknowledgment of receipt by subscribing clients. Aren't spooled on the message bus for consuming clients. Aren't retained for a client when it's not connected to an event broker. Can be discarded when congestion or system failures are encountered.
Client direct messages traffic sent	Indicates the amount of bytes of direct messages sent from the target broker during the last measurement period.	MB
Client direct messages received	Indicates the number of direct messages received by the target broker during the last measurement period.	Number	Compare the value of this measure with Client non-persistent messages received and Client direct messages received measures to figure out the messages of which type was maximum received by the target broker - is it non-persistent messages? or direct messages?
Client direct messages sent	Indicates the number of direct messages sent from the target broker during the last measurement period.	Number	Situations where direct messages aren't delivered A client disconnects from an event broker while messages are being published. A client fails to consume messages at the published rate and egress message buffer overflow results. Compare the value of this measure with Client non-persistent messages sent and Client persistent messages transmitted measures to figure out the messages of which type was maximum sent from the target broker - is it non-persistent messages? or persistent messages?
Client persistent messages traffic received	Indicates the amount of bytes of persistent messages received by the target broker during the last measurement period.	MB
Client persistent messages traffic sent	Indicates the amount of bytes of persistent messages sent from the target broker during the last measurement period.	MB
Client persistent messages received	Indicates the number of persistent messages received by the target broker during the last measurement period.	Number	Compare the value of this measure with Client non-persistent messages received and Client direct messages received measures to figure out the messages of which type was maximum received by the target broker - is it non-persistent messages? or direct messages?
Client persistent messages sent	Indicates the number of persistent messages sent from the target broker during the last measurement period.	Number	Compare the value of this measure with Client direct messages sent and Client non-persistent messages sent measures to figure out the messages of which type was maximum sent from the target broker - is it non-persistent messages? or direct messages?
Client non-persistent messages traffic received	Indicates the amount of bytes of non-persistent messages received by the target broker during the last measurement period.	MB
Client non-persistent messages traffic sent	Indicates the amount of bytes of non-persistent messages sent from the target broker during the last measurement period.	MB
Client non-persistent messages received	Indicates the number of non-persistent messages received by the target broker during the last measurement period.	Number	Compare the value of this measure with Client persistent messages received and Client direct messages received measures to figure out the messages of which type was maximum received by the target broker - is it persistent messages? or direct messages?
Client non-persistent messages sent	Indicates the non-persistent messages sent from the target broker during the last measurement period.	Number	Compare the value of this measure with Client direct messages sent and Client persistent messages transmitted measures to figure out the messages of which type was maximum sent from the target broker - is it persistent messages? or direct messages?
Incoming rate	Indicates the rate at which amount of bytes of incoming messages were received by the target broker.	MB/sec
Incoming messages rate	Indicates the rate at which incoming messages were received by the target broker.	Messages/sec	A sudden/gradual increase in the value of this measure is a cause of concern. Administrators may need to look out for any malicious attacks on the target broker.
Total incoming discards	Indicates the total number of incoming messages that were discarded by the target broker during the last measurement period..	Number
Incoming discards due to no subscription match	Indicates the number of incoming messages that were discarded because the messages did not match any subscription during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to topic parse error	Indicates the number of incoming messages that were discarded because the topic of the messages could not be parsed during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to parse error	Indicates the number of incoming messages that were discarded because the messages could not be parsed during the last measurement period.	Number	Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to too big messages	ndicates the number of incoming messages discarded because of a message spool limit during the last measurement period.	Number	Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to TTL exceeded	Indicates the number of incoming messages that were discarded because the Time-to-Live window for the messages expired during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to web parse error	Indicates the number of incoming web messages that were discarded because the messages could not be parsed during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to publish topic ACL	Indicates the number of incoming messages that were discarded because the publisher was restricted by an ACL rule during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to messagespool discards, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to messagespool discards	Indicates the number of incoming messages discarded because of a message spool limit during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to message promotion congestion and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to message promotion congestion	Indicates the number of incoming messages discarded due to congestion from persisting DIRECT messages during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards and Incoming discards due to messagespool congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Incoming discards due to messagespool congestion	Indicates the number of guaranteed incoming messages discarded because of low-priority discard rules during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Incoming discards due to no subscription match, Incoming discards due to topic parse error, Incoming discards due to parse error, Incoming discards due to too big messages, Incoming discards due to TTL exceeded, Incoming discards due to web parse error, Incoming discards due to publish topic ACL, Incoming discards due to messagespool discards and Incoming discards due to message promotion congestion measures to identify the incoming message discard that was noticed more frequently on the target broker.
Outgoing rate	Indicates the rate at which amount of bytes of outgoing messages were received by the target broker.	MB/sec
Outgoing messages	Indicates the rate at which number of outgoing messages were received by the target broker.	Messages/sec
Total outgoing discards	Indicates the total number of outgoing messages that were discarded by the target broker during the last measurement period.	Number
Outgoing discards due to transmit congestion	Indicates the number of outgoing messages that were discarded due to overflow of the outbound message buffer during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to compression congestion	Indicates the number of outgoing messages that were discarded due to overflow of the compression buffer during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to messages elided	Indicates the number of outgoing messages that were discarded due to client eliding rules during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to TTL exceeded	Indicates the number of outgoing messages that were discarded because the Time-to-Live window for the messages expired during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to payload could not be formatted	Indicates the number of outgoing messages that were discarded due to errors noticed while processing outbound message payload during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to message promotion congestion	Indicates the number of outgoing messages from this client that were discarded due to inability to promote the message to persistent during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to messagespool congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to messagespool congestion	Indicates the number of guaranteed outgoing messages that were rejected to sender due to msg-spool issue on a queue with Reject-Msg-to-Sender-on-Discard set during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to clients not connected and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to clients not connected	Indicates the number of outgoing messages that were discarded due to the clients not being connected during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion and Outgoing discards due to messagespool discards measures to identify the outgoing message discard that was noticed more frequently on the target broker.
Outgoing discards due to messagespool discards	Indicates the number of outgoing messages that were discarded due to persisted endpoint overflow during the last measurement period.	Number	Ideally, the value of this measure should be zero. Compare the value of this measure with Outgoing discards due to transmit congestion, Outgoing discards due to compression congestion, Outgoing discards due to messages elided, Outgoing discards due to TTL exceeded, Outgoing discards due to payload could not be formatted, Outgoing discards due to message promotion congestion, Outgoing discards due to messagespool congestion and Outgoing discards due to clients not connected measures to identify the outgoing message discard that was noticed more frequently on the target broker.