Solace Message VPNs Test
Message VPNs allow for many separate applications to share a single Solace PubSub+ software or appliance event broker while still remaining independent and separated. Basically, Message VPNs enable the virtualization of an event broker into many individual virtual event brokers.
Message VPNs allow for the segregation of topic space and messaging space by creating fully separate messaging domains. Message VPNs also group clients connecting to a network of Solace PubSub+ event brokers so that messages published within a particular group are only visible to clients that belong to that group. Each client connection is associated with a single Message VPN.
If the clients could not establish connections to the Message VPN or if the Message VPNs are overloaded with message traffic or if the Message VPN encounters multiple errors while clients are connected, then, the Message VPNs may encounter significant delays in catering the subscriptions. To avoid such delays and to ensure that the Message VPNs process the messages at a faster pace, it is essential to keep track on the request processing ability and the status of the Message VPNs on the target Solace PubSub+ Event Broker. The Solace Message VPNs test helps administrators in this regard!
This test auto-discovers the Message VPNs configured on the target Solace PubSub+ Event Broker and for each Message VPN, this test reports the configuration and operations status. This test also helps administrators figure out which type of service was used by the clients to connect to each Message VPN - is it AMQP? or MQTT? or REST? or Web transport? or SMF? Using this test, administrators can determine the Message VPNs that send maximum number of incoming/outgoing messages, maximum client data messages and client control messages, etc. This test also help administrators in analyzing the message processing ability of the Message VPNs. This way, the test provides near-accurate indicators of the load on the Message VPNs.
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 each Message VPN configured on the target Solace PubSub+ Event Broker that is being monitored
| 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. |
| Measurement | Description | Measurement Unit | Interpretation | ||||||
|---|---|---|---|---|---|---|---|---|---|
|
Enabled status |
Indicates the current configuration status of this Message VPN. |
|
The values reported by this measure and its numeric equivalents are mentioned in the table below:
Note: By default, this measure reports the Measure Values listed in the table above to indicate the current configuration status of each Message VPN. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1. |
||||||
|
Local state |
Indicates the local status of this Message VPN. |
|
The values reported by this measure and its numeric equivalents are mentioned in the table below:
Note: By default, this measure reports the Measure Values listed in the table above to indicate the local status of each Message VPN. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1. |
||||||
|
Operational status |
Indicates the operational status of this Message VPN. |
|
The values reported by this measure and its numeric equivalents are mentioned in the table below:
Note: By default, this measure reports the Measure Values listed in the table above to indicate the operational status of each Message VPN. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1. |
||||||
|
Is management message VPN? |
Indicates whether/not this Message VPN is designated as the Management Message VPN. |
|
System-level syslog events are always published in a Message VPN that has been designated as the Management Message VPN for the event broker. A Solace PubSub+ event broker can only have one of its enabled Message VPNs configured as the Management Message VPN. If no Management Message VPN is configured, then system-level syslog events are not published on the event broker. The values reported by this measure and its numeric equivalents are mentioned in the table below:
Note: By default, this measure reports the Measure Values listed in the table above to indicate whether/not the Message VPN is designated as the Management Message VPN. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1. |
||||||
|
Distributed cache-management enabled? |
Indicates whether/not Distributed Cache Management service is enabled for this Message VPN. |
|
Distributed Cache Management services allows the event broker that the Message VPN is hosted on to manage the configuration of PubSub+ Cache Instances and to synchronize them. The event broker with a Message VPN that has Distributed Cache Management services enabled acts as the Designated Router for that Message VPN. By default, when a Message VPN is created, Distributed Cache Management services are enabled. The values reported by this measure and its numeric equivalents are mentioned in the table below:
Note: By default, this measure reports the Measure Values listed in the table above to indicate whether/not Distributed Cache Management service is enabled for each Message VPN. The graph of this measure however, is represented using the numeric equivalents only i.e., 0 or 1. |
||||||
|
Unique local subscriptions |
Indicates the total number of unique local subscriptions that the clients can add to this Message VPN. |
Number |
|
||||||
|
Unique remote subscriptions |
Indicates the total number of unique remote subscriptions that the clients can add to this Message VPN. |
Number |
|
||||||
|
Total unique subscriptions |
Indicates the total number of unique subscriptions that the clients can add to this Message VPN. |
Number |
|
||||||
|
Configured maximum subscriptions |
Indicates the maximum number of local client subscriptions that can be added to this Message VPN. |
Number |
If the Total unique subscriptions measure exceeds the value of this measure, it indicates that a few unique subscriptions are remote subscriptions. |
||||||
|
Subscriptions usage |
Indicates the percentage of subscriptions that is currently in use on this Message VPN. |
Percent |
Compare this value across the Message VPNs to identify the Message VPN with maximum subscription usage. |
||||||
|
Add subscriptions messages received |
Indicates the number of add subscription messages received by this Message VPN during the last measurement period. |
Number |
|
||||||
|
Add subscriptions messages sent |
Indicates the number of add subscriptions messages sent from this Message VPN during the last measurement period. |
Number |
|
||||||
|
Denied subscribe topic ACLs |
Indicates the total number of topics that the clients were not allowed to subscribe to by connecting to this Message VPN using the Subscriber ACLs during the last measurement period. |
Number |
Access Control Lists (ACLs) are used to manage whether clients may connect to Message VPNs, which topics clients are allowed to publish to, and which topics and share names clients are allowed to subscribe to in that Message VPN. Each of these access controls require a defined default action (allow or disallow connection, allow or disallow publishing to topics, allow or disallow subscribing to topics, and allow or disallow subscribing to share names), and you can configure explicit exceptions to those default actions. |
||||||
|
Denied subscribe topics reversed |
Indicates the total number of topics that the clients were not allowed to subscribe by connecting to this Message VPN since the topic was reversed to the publisher during the last measurement period. |
Number |
|
||||||
|
Denied unsubscribe topic ACLs |
Indicates the total number of topics that the clients were not allowed to unsubscribe to by connecting to this Message VPN using the Subscriber ACLs during the last measurement period. |
Number |
|
||||||
|
Denied subscribe permissions |
Indicates the total number of subscriptions that the clients were not allowed to subscribe to by connecting to this Message VPN during the last measurement period. |
Number |
|
||||||
|
Denied unsubscribe permissions |
Indicates the total number of subscriptions that the clients were not allowed to unsubscribe to by connecting to this Message VPN during the last measurement period. |
Number |
|
||||||
|
AMQP connections |
Indicates the number of clients connected to this Message VPN using AMQP service. |
Number |
Administrators can compare the value of this measure across the Message VPNs to determine which Message VPN is connected to the maximum number of clients using AMQP service. |
||||||
|
Maximum AMQP connections |
Indicates the maximum number of clients that can be simultaneously connected to this Message VPN using AMQP service. |
Number |
|
||||||
|
AMQP connections usage |
Indicates the percentage of clients connected to this Message VPN using AMQP service. |
Percent |
|
||||||
|
MQTT connections |
Indicates the number of clients connected to this Message VPN using MQTT service. |
Number |
Administrators can compare the value of this measure across the Message VPNs to determine which Message VPN is connected to the maximum number of clients using MQTT service. |
||||||
|
Maximum MQTT connections |
Indicates the maximum number of clients that can be simultaneously connected to this Message VPN using MQTT service. |
Number |
|
||||||
|
MQTT connections usage |
Indicates the percentage of clients connected to this Message VPN using MQTT service. |
Percent |
|
||||||
|
Incoming REST connections |
Indicates the number of incoming REST client connections to this Message VPN. |
Number |
Compare the value of this measure across the Message VPNs to find out which Message VPN receives maximum number of incoming REST client connections. |
||||||
|
Maximum REST incoming connections |
Indicates the maximum number of incoming REST client connections configured for this Message VPN. |
Number |
|
||||||
|
Incoming REST connections usage |
Indicates the percentage of incoming REST clients connections to this Message VPN that are currently in use. |
Percent |
|
||||||
|
Outgoing REST connections |
Indicates the number of outgoing REST client connections to this Message VPN. |
Number |
Compare the value of this measure across the Message VPNs to find out which Message VPN receives maximum number of outgoing REST client connections. |
||||||
|
Maximum REST outgoing connections |
Indicates the maximum number of outgoing REST client connections configured for this Message VPN. |
Number |
|
||||||
|
Outgoing REST connections usage |
Indicates the percentage of incoming REST clients connections to this Message VPN that are currently in use. |
Percent |
|
||||||
|
SMF connections |
Indicates the number of clients connected to this Message VPN using SMF service. |
Number |
Administrators can compare the value of this measure across the Message VPNs to determine which Message VPN is connected to the maximum number of clients using SMF service. |
||||||
|
Maximum SMF connections |
Indicates the maximum number of clients that can be simultaneously connected to this Message VPN using SMF service. |
Number |
|
||||||
|
SMF connections usage |
Indicates the percentage of clients connected to this Message VPN using SMF service. |
Percent |
|
||||||
|
Web connections |
Indicates the total number of clients connected to this Message VPN using Web transport service. |
Number |
Administrators can compare the value of this measure across the Message VPNs to determine which Message VPN is connected to the maximum number of clients using Web transport service. |
||||||
|
Maximum web transport connections |
Indicates the maximum number of clients that can be simultaneously connected to this Message VPN using Web transport service. |
Number |
|
||||||
|
Web connections usage |
Indicates the percentage of clients connected to this Message VPN using Web transport service. |
Percent |
|
||||||
|
Total client connections |
Indicates the total number of clients that are currently connected to this Message VPN. |
Number |
Compare the value of this measure across the Message VPNs to determine which Message VPN handles the maximum number of client connections. |
||||||
|
Maximum client connections |
Indicates the maximum number of clients that can be configured to simultaneously connect to this Message VPN. |
Number |
|
||||||
|
Connections usage |
Indicates the percentage of clients connected to this Message VPN. |
Percent |
|
||||||
|
Client control messages traffic received |
Indicates the number of bytes of client control messages that were received by this Message VPN during the last measurement period. |
MB |
Compare the value of this measure across Message VPNs to identify the Message VPN that sent/received maximum amount of bytes of client control messages.
|
||||||
|
Client control messages traffic sent |
Indicates the number of bytes of client control messages that were sent through this Message VPN during the last measurement period. |
MB |
|||||||
|
Client data messages traffic received |
Indicates the number of bytes of data messages that were received by this Message VPN during the last measurement period. |
MB |
Compare the value of this measure across Message VPNs to identify the Message VPN that sent/received maximum amount of bytes of client data messages.
|
||||||
|
Client data messages traffic sent |
Indicates the number of bytes of data messages that were sent through this Message VPN during the last measurement period. |
MB |
|||||||
|
Total client messages traffic received |
Indicates the total number of bytes of client messages that were received by this Message VPN during the last measurement period. |
MB |
Compare the value of this measure across Message VPNs to determine which Message VPN sent/received maximum amount of bytes of data messages. |
||||||
|
Total client messages traffic sent |
Indicates the total number of bytes of client messages that were sent through this Message VPN during the last measurement period. |
MB |
|||||||
|
Client data messages received |
Indicates the number of client data messages that were received by this Message VPN during the last measurement period. |
Number |
Compare the value of this measure across Message VPNs to identify the Message VPN that sent/received maximum number of client data messages. |
||||||
|
Client data messages sent |
Indicates the number of client data messages that were sent through this Message VPN during the last measurement period. |
Number |
|||||||
|
Client control messages received |
Indicates the number of client control messages that were received by this Message VPN during the last measurement period. |
Number |
Compare the value of this measure across Message VPNs to identify the Message VPN that sent/received maximum number of client control messages. |
||||||
|
Client control messages sent |
Indicates the number of client control messages that were sent through this Message VPN during the last measurement period. |
Number |
|||||||
|
Total client messages received |
Indicates the total number of client messages received by this Message VPN during the last measurement period. |
Messages |
Compare the value of this measure across Message VPNs to identify the Message VPN that sent/received maximum number of client messages.
|
||||||
|
Total client messages sent |
Indicates the total number of client messages sent through this Message VPN during the last measurement period. |
Messages |
|||||||
|
Login messages received |
Indicates the total number of client login messages that were received by this Message VPN during the last measurement period. |
Number |
Compare the value of this measure across Message VPNs to identify the Message VPN that sent/received maximum number of login messages.
|
||||||
|
Login messages sent |
Indicates the total number of client login messages that were sent through this Message VPN during the last measurement period. |
Number |
|||||||
|
Current incoming rate |
Indicates the amount of bytes of incoming messages that were received by this Message VPN. |
Mbps |
Compare the value of this measure across Message VPNs to identify the Message VPN that receives maximum data in terms of incoming messages. |
||||||
|
Current incoming messages rate |
Indicates the rate at which the incoming messages were received by this Message VPN. |
Messages/sec |
Compare the value of this measure across Message VPNs to identify the Message VPN that receives maximum number of incoming messages per second. |
||||||
|
Incoming discards |
Indicates the total number of incoming messages that were discarded by this Message VPN. |
Number |
Administrators can compare the value of this measure across Message VPNs to find out which Message VPN discarded the maximum number of incoming messages. |
||||||
|
Incoming discards due to message-spool congestion |
Indicates the number of guaranteed incoming messages that were discarded by this Message VPN because of low-priority discard rules during the last measurement period. |
Number |
|
||||||
|
Incoming discards due to message-promotion-congestion |
Indicates the number of incoming messages that were discarded by this Message VPN due to congestion from persisting DIRECT messages during the last measurement period. |
Number |
|
||||||
|
Incoming discards due to message spool discards |
Indicates the number of incoming messages that were discarded by this Message VPN because of a message spool limit during the last measurement period |
Number |
|
||||||
|
Incoming discards due to too big messages |
Indicates the number of incoming messages that were discarded by this Message VPN because the message was larger than allowed size during the last measurement period. |
Number |
|
||||||
|
Incoming discards due to no subscriptions match |
Indicates the number of incoming messages that were discarded by this Message VPN because the messages did not match any subscription during the last measurement period. |
Number |
|
||||||
|
Incoming discards due to parse error |
Indicates the number of incoming messages that were discarded by this Message VPN because the messages could not be parsed during the last measurement period. |
Number |
Compare the value of this measure across Message VPNs to identify the Message VPN from which maximum number of incoming messages were discarded since the messages could not be parsed. |
||||||
|
Incoming discards due to publish topic ACL |
Indicates the number of incoming messages that were discarded by this Message VPN because the publisher was restricted by an ACL rule during the last measurement period. |
Number |
|
||||||
|
Incoming discards due to topic parse error |
Indicates the number of incoming messages to this Message VPN that were discarded because the topic of the messages could not be parsed during the last measurement period. |
Number |
|
||||||
|
Incoming discards due to ttl exceeded |
Indicates the number of incoming messages to this Message VPN that were discarded because the Time-to-Live window for the messages expired during the last measurement period. |
Number |
|
||||||
|
Current outgoing rate |
Indicates the amount of bytes of outgoing messages that were sent from this Message VPN. |
Mbps |
Compare the value of this measure across Message VPNs to identify the Message VPN that sends maximum data in terms of outgoing messages. |
||||||
|
Current outgoing messages rate |
Indicates the rate at which outgoing messages were sent from this Message VPN. |
Messages/sec |
Compare the value of this measure across Message VPNs to identify the Message VPN that sends maximum number of outgoing messages per second. |
||||||
|
Outgoing discards |
Indicates the total number of outgoing messages that were discarded by this Message VPN during the last measurement period. |
Number |
Administrators can compare the value of this measure across Message VPNs to find out which Message VPN discarded the maximum number of outgoing messages. |
||||||
|
Outgoing discards due to message-spool discards |
Indicates the number of outgoing messages that were discarded due to the message spool discards encountered by this Message VPN during the last measurement period. |
Number |
|
||||||
|
Outgoing discards due to client not connected |
Indicates the number of outgoing messages that were discarded due to the clients not being connected to this Message VPN during the last measurement period. |
Number |
|
||||||
|
Outgoing discards due to compression congestion |
Indicates the number of outgoing messages from this Message VPN that were discarded due to overflow of the compression buffer during the last measurement period. |
Number |
|
||||||
|
Outgoing discards due to message elided |
Indicates the number of outgoing messages from this Message VPN that were discarded due to client eliding rules during the last measurement period. |
Number |
|
||||||
|
Outgoing discards due to message promotion congestion |
Indicates the number of outgoing messages from this Message VPN that were discarded due to inability to promote the message to persistent during the last measurement period. |
Number |
|
||||||
|
Outgoing discards due to message spool congestion |
Indicates the number of guaranteed outgoing messages from this Message VPN 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 |
|
||||||
|
Outgoing discards due to transmit congestion |
Indicates the number of outgoing messages from this Message VPN that were discarded due to overflow of the outbound message buffer during the last measurement period. |
Number |
|
||||||
|
Outgoing discards due to ttl exceeded |
Indicates the number of outgoing messages from this Message VPN that were discarded because the Time-to-Live window for the messages expired during the last measurement period. |
Number |
|
||||||
|
Connection accepted |
Indicates the number of connections that were successfully accepted from this message VPN. |
Number |
|
||||||
|
Connection rejected |
Indicates the number of connections from this message VPN that were rejected. |
Number |
A connection might be usually rejected due to authentication, authorization, or configuration issues. A consistently high value is a cause of concern. Administrators can initiate troubleshooting to understand the underlying causes. |
||||||
|
Connection rejected due to plain text shutdown |
Indicates the number of connections from this message VPN that were rejected due to plain text shutdown. |
Number |
Plain text shutdown refers to a situation where connections that are not encrypted are disallowed. A consistently high value is a cause of concern. Organizations must maintain a secure messaging environment to protect sensitive data from unauthorized access and potential security threats associated with plain text transmissions. |
||||||
|
Connection rejected due to SSL shutdown |
Indicates the number of connections from this message VPN that were rejected due to SSL shutdown. |
Number |
SSL shutdown is the process of terminating or closing an SSL/TLS (Secure Sockets Layer / Transport Layer Security) connection between a client and the Solace message broker. When an SSL shutdown occurs, the root cause needs to be investigated. It could be due to various reasons such as client-side issues, network disruptions, or broker-side settings. |
||||||
|
Connection rejected due to web plain text shutdown |
Indicates the number of connections from this message VPN that were rejected due to web plain text shutdown. |
Number |
Web plain text shutdown refers to a situation where a connection is denied because the client attempted to establish a connection using a plain text web protocol, such as HTTP, instead of the secured version, HTTPS. Administrators need to ensure that all connections adhere to the enforced security policies, with HTTPS being used for secure communications. |
||||||
|
Connection rejected due to web ssl shutdown |
Indicates the number of connections from this message VPN that were rejected due to web SSL shutdown. |
Number |
Web SSL shutdown is a situation where a connection is declined because the SSL/TLS handshake failed or was terminated prematurely. Administrators must find out the underlying causes to ensure secure and reliable communication between clients and the Solace message VPN. |
