Monitoring VPN Configurations and Stats

To show the configuration and membership of a Message VPN on the event broker, as well as statistics, enter the following command:

solace> show message-vpn <vpn-name> {[[detail | stats [detail] | service [stats]] | [subscriptions [primary] [backup] [static]]] | replication [stats | detail | client-certificate] | rest [{restdelivery-point <rdp-name> [stats | queue-binding <queue-binding-name>] [count <num-elements>] [detail] | rest-consumer <rest-consumer-name> [rest-delivery-point <rdp-name>] [stats | outgoing-connections [tcp [wide]] | authentication | client-certificate | ssl | detail] [count <num-elements>]}] | authorization [authorization-group <name> [detail]] [count <num-elements>] | mqtt mqtt-session <client-id-pattern> [owner <owner-pattern>] [primary] [backup] [detail | subscriptions [qos <qos-value>] | stats | client | queue] | bridging}

Where:

<vpn-name> is the full name of the Message VPN, or part of the Message VPN name with the wildcard character ? used to represent one character of the name, or the wildcard character * used to represent zero or more characters of the name, where entering only the wildcard character * for the name displays all Message VPNs.

detail asks to show detailed information on the Message VPN

stats asks to show Message VPN statistics

detail asks to show detailed Message VPN statistics

service asks to show SEMP, SMF, MQTT, AMQP, and/or Web Transport services information

stats asks to show statistics information on services
subscriptions asks to show Message VPN subscription information
primary asks to show subscriptions for the primary virtual router, and is the default if no parameter is entered
backup asks to show subscriptions for the backup virtual router
static asks to show subscriptions for the static virtual router

:  In addition to SMF topic subscriptions, the show message-vpn command may also display Message Queuing Telemetry Transport (MQTT) topic subscriptions. Because this command must be able to represent both SMF and MQTT topic syntax, if a topic subscription uses characters with special meaning for the topic syntax it uses (for example, wildcards), those characters may be displayed in the output as escaped characters.

replication asks to show replication information for the Message VPN

client-certificate asks to show the certificate configured for Message VPN replication
stats asks to show statistics information on Message VPN replication
detail asks to show detailed information on Message VPN replication

rest asks to show information about Message VPN REST settings

rest-delivery-point asks to show information on a specified REST Delivery Point
rest-consumer asks to show information on a specified REST consumer
detail asks to show display detailed information about the REST Consumer

authorization asks to client authorization information

authorization-group <name> asks to show information for the given authorization group
detail asks to show display detailed information about the given authorization group
count <num-elements> sets a limit for the maximum number of authorization groups to display information for

mqtt mqtt-session asks to show MQTT session information

<client-id-pattern> asks to filter the outputted MQTT session information by the given client ID (a string value)
owner <owner-pattern> [string] asks to filter the outputted MQTT session information by an owner of the MQTT session (a string, by default * is used)
primary asks to filter the outputted MQTT session information for the primary virtual router
backup asks to filter the outputted MQTT session information for the backup virtual router
detail asks to show detailed information on for each MQTT session
subscriptions asks to show subscriptions for each MQTT session
qos <qos-value> asks to show topic subscriptions that have the given QoS level
stats asks to show statistics for each MQTT session
client asks to show the client of each MQTT session
queue asks to show the queue that belongs to each MQTT session

bridging asks to show information on Message VPN bridge configuration

The following examples display the show message-vpn command usage for a Solace PubSub+ appliance:

Example 1: Message VPN Config Info

Possible Message VPN states displayed for “Local Status:” are Disabled, Down, Up, or Unconfigured:

  • Disabled means the Message VPN is not administratively enabled.
  • Down means the Message VPN is administratively enabled, but external clients are not yet allowed to connect because the internal client of the Message VPN (that is, #client) has not yet connected and loaded the required subscriptions.
  • Up means the Message VPN is administratively enabled and external clients are allowed to connect.
  • Unconfigured means the Message VPN has only been learned through multiple-node routing protocols and has not actually been configured on the event broker. Local clients cannot connect to unconfigured Message VPNs, and no per-Message VPN statistics are maintained for them.

solace> show message-vpn default

			Message VPN:                         default
			Configuration Status:                Enabled
			Local Status:                        Up
			Distributed Cache Management:        Enabled
			SSL to plain text downgrade allowed: No
			REST mode:                           Messaging
			Total Local Unique Subscriptions:    6
			Total Remote Unique Subscriptions:   0
			Total Unique Subscriptions:          6
			Maximum Subscriptions:               500000
			Configured Maximum Subscriptions:    500000
			Export Subscriptions:                No (100% complete)
			Preferred Ip Version:                ipv6
			Active Incoming Connections:         1
			  Service SMF:                       1
			  Service Web-Transport:             0
			  Service REST:                      0
			  Service MQTT:                      0
			  Service AMQP:                      0
			Active Outgoing Connections:
			  Service REST:                      0
			Max Incoming Connections:            1000
			  Service SMF:                       1000
			  Service Web-Transport:             1000
			  Service REST:                      1000
			  Service MQTT:                      1000
			  Service AMQP:                      1000
			Max Outgoing Connections:
			  Service REST:                      1000
			Basic Authentication :               Enabled
			  Auth Type:                       no authentication
			  Auth Profile:
			  Radius Domain:
			Client Certificate Authentication :  Disabled
			  Maximum Chain Depth:             3
			  Validate Certificate Dates:      Enabled
			  Allow API Provided Username:     Disabled
			  Username Source:                 common-name
			  Revocation Check Mode:           allow-valid
			Kerberos Authentication :            Disabled
			  Allow API Provided Username:     Disabled
			OAuth Authentication Enabled :       No
			  Default Provider Name:

			SEMP over Message Bus:               Enabled
			  Admin commands:                    Enabled
			    Client commands:                 Enabled
			    Distributed Cache commands:      Enabled
			  Show commands:                     Enabled
			  Legacy Show Clear commands:        Disabled

			Large Message Threshold:             1024 (KB)
			Event Log Tag:
			Publish Topic Format:                SMF
			Publish Client Event Messages:       Disabled
			Publish Message VPN Event Messages:  Disabled
			Publish Subscription Event Messages: Disabled
			  No unsubscribes on disconnect:     Disabled
			  Event topic format:                N/A

			Event Threshold                           Set Value      Clear Value
			---------------------------------- ---------------- ----------------
			Incoming Connections                       80%(800)         60%(600)
			  Service SMF                              80%(800)         60%(600)
			  Service Web-Transport                    80%(800)         60%(600)
			  Service REST                             80%(800)         60%(600)
			  Service MQTT                             80%(800)         60%(600)
			  Service AMQP                             80%(800)         60%(600)
			Ingress Message Rate (msg/sec)              4000000          3000000
			Egress Message Rate (msg/sec)               4000000          3000000
			Subscriptions                           80%(400000)      60%(300000)
		

Example 2: Basic VPN Stats

  • The statistical values displayed by “Avg. Rate (60 sec interval)” are not an average, but an approximation based on a smoothing function which has a 60 second time constant.
  • The value displayed by “Elided” is the number of messages discarded due to the use of the message eliding function.
  • The value displayed by “Message Spool Congestion” is the number of Guaranteed messages discarded by the event broker because of messages arriving faster than they can be spooled.
  • The value displayed by “Message Spool Egress Discards” is the number of Guaranteed messages deleted or discarded due to expired TTLs, administrative deletion, or both.
  • The value displayed by "Client Not Connected" is the number of messages discarded due to disconnected client applications.

solace> show message-vpn default stats

 

			Message VPN:                         default
			Configuration Status:                Enabled
			Local Status:                        Up
			Distributed Cache Management:        Enabled
			SSL to plain text downgrade allowed: No
			REST mode:                           Messaging
			Total Local Unique Subscriptions:    6
			Total Remote Unique Subscriptions:   0
			Total Unique Subscriptions:          6
			Maximum Subscriptions:               500000
			Configured Maximum Subscriptions:    500000
			Export Subscriptions:                No (100% complete)
			Preferred Ip Version:                ipv6
			Active Incoming Connections:         1
			  Service SMF:                       1
			  Service Web-Transport:             0
			  Service REST:                      0
			  Service MQTT:                      0
			  Service AMQP:                      0
			Active Outgoing Connections:
			  Service REST:                      0
			Max Incoming Connections:            1000
			  Service SMF:                       1000
			  Service Web-Transport:             1000
			  Service REST:                      1000
			  Service MQTT:                      1000
			  Service AMQP:                      1000
			Max Outgoing Connections:
			  Service REST:                      1000

			Basic Authentication :               Enabled
			  Auth Type:                       no authentication
			  Auth Profile:
			  Radius Domain:
			Client Certificate Authentication :  Disabled
			  Maximum Chain Depth:             3
			  Validate Certificate Dates:      Enabled
			  Allow API Provided Username:     Disabled
			  Username Source:                 common-name
			  Revocation Check Mode:           allow-valid
			Kerberos Authentication :            Disabled
			Allow API Provided Username:     Disabled
			OAuth Authentication Enabled :       No
			  Default Provider Name:
									Received                    Sent
							    --------------------    --------------------
			Total Client Messages                                 7                        4
			  Client Data Messages                                0                        0
			  Persistent                                          0                        0
			    Non-persistent                                    0                        0
			    Direct                                            0                        0
			    Large Messages                                    0
			    DTO Messages                                      0
			Client Control Messages                               7                        4
			  Login                                               1                        1
			    Certificate Revocation Check                                               0
			      Allowed Valid                                                            0
			      Allowed Revoked                                                          0
			      Allowed Unknown                                                          0
			      Denied Unknown                                                           0
			      Denied Revoked                                                           0
			      Denied Duplicate Clients                                                 0
			      Denied Authorization Failed                                              0
			      Denied Client Connect ACL                                                0
			Update                                               0                         0
			KeepAlive                                            0                         0
			Assured Control                                      0                         0
			Add Subscription Messages
			  Client Adds                                        6                         3
			  Subscription Manager Adds                          0                         0
			  Already Exists                                                               0
			  Not Enough Space                                                             0
			  Max Exceeded                                                                 0
			  Parse Error                                                                  0
			  Denied Subscribe Topic ACL                                                   0
			  Denied Subscribe Topic Reserved                                              0
			  Shared Subscription Permission Denied                                        0
			  Subscription Manager
			    No Permission                                                              0
			    Client Name Not Found                                                      0
			    Shared Subscription Permission Denied                                      0
			Remove Subscription Messages
			  Client Removes                                     0                         0
			  Subscription Manager Removes                       0                         0
			  Not Found                                                                    0
			  Parse Error                                                                  0
			  Denied Unsubscribe Topic ACL                                                 0
			  Subscription Manager
			    No Permission                                                              0
			    Client Name Not Found                                                      0

			Total Client Bytes                                  444                      423
			  Client Data Bytes                                   0                        0
			    Persistent                                        0                        0
			    Non-persistent                                    0                        0
			    Direct                                            0                        0
			Client Control Bytes                                444                      423

			Compressed Bytes                                      0                        0

								Ingress (msg/sec)      Egress (msg/sec)
								--------------------  --------------------
			Current Rate (1 sec sample)                           0                        0
			Avg. Rate (60 sec interval)                           0                        0

								Ingress (bytes/sec)    Egress (bytes/sec)
								--------------------  --------------------
			Current Rate (1 sec sample)                           0                        0
			Avg. Rate (60 sec interval)                           0                        0

			****************************** Ingress Discards *****************************

			Total Ingress Discards                                                        0
			  No Subscription Match                                                       0
			  Topic Parse Error                                                           0
			  Parse Error                                                                 0
			  Message Too Big                                                             0
			  Publish Topic ACL                                                           0
			  Message Spool Congestion                                                    0
			  Message Spool Ingress Discards                                              0

			****************************** Egress Discards ******************************

			Total Egress Discards                                                         0
			  Transmit Congestion                                                         0
			  Compression Congestion                                                      0
			  Elided                                                                      0
			  TTL Exceeded                                                                0
			  Client Not Connected                                                        0
			  Message Spool Egress Discards                                               0
		

Example 3: Message VPN Replication Stats

The following example displays replication details for the Message VPN.

solace>show message-vpn vpn-1 replication stats

			Message VPN:                       default
			Admin Status:                      shutdown
			Config Status:                     standby
			Local Bridge:
			  State:                           n/a
			  Name:                            n/a
			  Queue State:                     n/a
			  Authentication:
			    Scheme:                        Basic
			    Basic:
			      Client Username:
			      Password Configured:         No
			    Client Certificate:
			      Certificate File:
			      Using Server Certificate:    No
			  Compressed:                      No
			  SSL:                             No
			  Message Spool:
			    Window Size:                   255
			  Unidirectional:
			    Client Profile:                #client-profile
			    Retry Delay:                     3
			Remote Bridge:
			  State:                           n/a
			  Name:                            n/a
			Queue:
			  State:                           n/a
			  Quota (MB):                      1500
			  Reject Msg to Sender on Discard: Yes
			Ack Propagation:
			  Interval in Messages:            20
			Sync Replication:
			  Eligible:                        n/a
			    Duration:                      n/a
			Mate Flow Congested:             n/a
			  Duration:                      n/a
			  Reject Msg When Sync Ineligible: No
			Transaction Replication Mode:      async

			Statistics While Active:
			  Message Processing:
			    Sync Messages Queued To Standby:                           0
			    Sync Messages Queued To Standby As Async:                  0
			    Async Messages Queued To Standby:                          0
			    Promoted Messages Queued To Standby:                       0
			    Pruned Locally Consumed Messages:                          0
			  Sync Replication:
			    Transitions To Ineligible:                                 0
			    Ineligible High Water Mark:                      0d 0h 0m 0s
			    Eligible High Water Mark:                        0d 0h 0m 0s
			    Mate Flow Congested High Water Mark:             0d 0h 0m 0s
			    Mate Flow Not Congested High Water Mark:         0d 0h 0m 0s
			  Ack Propagation:
			    Messages Sent To Standby:                                  0
			    Reconcile Request From Standby:                            0
			    Reconcile Scan in Progress:                                No
			Statistics While Standby:
			  Message Processing:
			    Messages Received From Active:                             0
			  Ack Propagation:
			    Messages Received from Active:                             0
			    Reconcile Request Sent to  Active:                         0
			    Out of Sequence Ack Received:                              0
			Transaction Replication:
			  Transactions Requests:                                       0
			    Success:                                                   0
			      Prepare:                                                 0
			      Commit:                                                  0
			      Rollback:                                                0
			    Fail:                                                      0
			      Prepare:                                                 0
			      Commit:                                                  0
			      Rollback:                                                0

Clearing Message VPN Statistics

To clear the statistics for one or more Message VPNs, enter the following command:

solace# clear message-vpn <vpn-name> stats

Where:

<vpn-name> is the full name of the Message VPN, or part of the Message VPN name with the wildcard character ? used to represent one character of the name, or the wildcard character * used to represent zero or more characters of the name, where entering only the wildcard character * for the name clears the statistics for all Message VPNs.