Viewing Client Configuration Information

You can use show User EXEC commands to monitor and validate client configurations and status on the given Solace PubSub+ event broker:

Showing Client Information
Showing Client Profile Information
Showing Client Username Information
Showing Aggregated Client Statistics
Clearing Client Statistics

Showing Client Information

To show a client’s configuration and status, enter the following User EXEC command:

solace> show client <name> [client-username <username>] [message-vpn <vpn-name>] [{{stats [congestion | queues]} | {connections [wide]}} | {subscriptions} | {{message-spool | message-spool-stats | {transaction-stats [session <session-id>]}} [{ingress | egress} [flow <flow-id>]]} | {sorted-stats [<stats-to-show>] [sort-by <stats-to-sort-by>] [clear-high-water-marks]} | {web-transport}] [detail] [primary] [backup] [static] slow-subscriber

Where:

<name> is the full name of the client, or part of the client 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 clients.

<username> is the full username of the client username account, or part of the username 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 client username accounts.

<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.

stats asks to show client traffic statistics

Entering show client * stats without specifying a client will display statistics for all existing clients individually on a client-by-client basis.

congestion asks to show congestion discards statistics in descending order

queues asks to show client queue information

connections asks to show TCP connection status information for the event broker and clients

connections wide asks to show detailed TCP connection status information for the event broker and clients in a wide screen computer display format (300+ character width). Descriptions of the displayed columns are provided in the Output from Show Client Connections Wide table below.

subscriptions asks to show client subscription information

message-spool asks show the client message spool configuration and status

message-spool-stats asks to show the client message spool statistics

transaction-stats asks to show transacted session statistics

session <session-id> asks to show the transacted session statistics for the user session specified by <session-id>. Valid values are 0 through 4294967295

ingress asks to show ingress message spool information and statistics

egress asks to show egress message spool information and statistics

flow <flow-id> asks to show the message flow identifier associated with an ingress or egress message flow and specified by <flow-id>. Valid values are 0 through 16383

sorted-stats asks to show the client statistics specified by <stats-to-show>, sorted in descending order

<stats-to-show> asks to show the any of the following statistics, entered as a list separated with commas (no spaces). Valid entries are:

total-client-messages-sent
total-client-messages-received
total-client-bytes-sent
total-client-bytes-received
total-egress-discards
round-trip-time-smooth-us
high-water-mark-work
current-ingress-message-rate-per-second
current-egress-message-rate-per-second
average-ingress-message-rate-per-minute
average-egress-message-rate-per-minute
current-ingress-byte-rate-per-second
current-egress-byte-rate-per-second
average-ingress-byte-rate-per-minute
average-egress-byte-rate-per-minute
num-subscriptions

sort-by asks to sort the client statistics shown by the ‘sorted-stats’ parameter by the statistic specified by <stats-to-sort-by>

<stats-to-sort-by> specifies the statistics to sort by for the ‘sorted-stats’ output, entered as a list separated with commas (no spaces). Valid entries are identical to those listed for <stats-to-show>. If more than one entry is present, multiple sets of statistics are shown, each sorted based on only one criteria.

clear-high-water-marks asks to clear the high water mark statistics

web-transport asks to show statistics for Web client transport connections

detail asks to show detailed information on the specified client

primary asks to show information only for clients associated with the primary virtual router

backup asks to show information only for clients associated with the backup virtual router

static asks to show information only for clients associated with the static virtual router

slow-subscriber asks to show information only for clients that are considered to be slow subscribers. Slow subscribers are clients that consistently fail to consume their messages at the offered message rate, which causes their egress queues to fill up. (Clients can also be considered slow subscribers if they fail to respond to TCP keepalives or the event broker must send timed TCP retransmissions to the clients.) To determine how slow a subscriber is, the event broker measures the number of seconds in the last minute when it had data to send but the client’s TCP window was closed. This slowness is expressed as a percentage.

To view a subscriber’s blocked percentage in the CLI output, enter the show client <name> connections wide User EXEC command.

Output from Show Client Connections Wide

The following table describes the information that the show client <name> connections wide command returns.

Output from Show Client Connections Wide
Column	Description
The username	The name of the client currently associated with the connection.
Proto	The protocol used: tcp – a TCP connection to a remote client using a C, .NET, Java, or JMS API web – a TCP connection underlying an HTTP session to a remote client using a JavaScript API intnl – an internal connection used by the event broker
Receive-Queue Bytes	The number of bytes currently in the event broker receive queue for the TCP connection.
Receive-Queue Segs	The number of TCP segments currently in the event broker receive queue for the TCP connection.
Send-Queue Bytes	The number of bytes currently queued for the client in both the client’s egress queues (visible in the output of ‘show client <name> stats’ queues) and the TCP send queue.
Send-Queue Msgs	The number of messages currently queued for the client in its egress queues (visible in the output of ‘show client <name> stats queues’).
Local Address	The IP address and TCP port on the event broker side of the connection.
Client Address	The IP address and TCP port on the client side of the connection.
State	The state of the TCP connection. See RFC 793 for further details.
Maximum Seg Size	The maximum segment size (MSS) configured for the client connection. The MSS is configured in the client profile. See RFC 879 for further details.
Bytes Sent	The number of bytes sent by the event broker on the TCP connection. This is a 32-bit number that rolls over at 4GiB.
Bytes Rcvd	The number of bytes received by the event broker on the TCP connection. This is a 32-bit number that rolls over at 4GiB.
Retransmit Time (ms)	The retransmission timeout (RTO) in milliseconds for the TCP connection. See RFC 2988 for further details.
RoundTrip Smth (µs)	The smoothed round-trip time (SRTT) in microseconds for the TCP connection. See RFC 2988 for further details.
RoundTrip Min (µs)	The minimum round-trip time in microseconds for the TCP connection. See RFC 2988 for further details.
RoundTrip Var (µs)	The round-trip time variation (RTTVAR) in microseconds for the TCP connection. See RFC 2988 for further details.
Advertised Windw Size	The receive window size in bytes advertised to the client on the remote end of the TCP connection. See RFC 793 for further details.
Transmit Windw Size	The send window size in bytes. See RFC 793 for further details.
Bandwidth Windw Size	This is an experimental value that is not used by the event broker.
Congestion Windw Size	The congestion window size in bytes (cwnd). See RFC 5681 for further details.
Slow Start Threshold	The slow start threshold in bytes (ssthresh). See RFC 5681 for further details.
Received OutOfOrder	The number of TCP segments received out of order.
Fast Retransmit	The number of TCP segments retransmitted due to the receipt of duplicate acknowledgments (‘ACKs’). See RFC 5681 for further details.
Timed Retransmit	The number of TCP segments re-transmitted due to timeout awaiting an ACK. See RFC 793 for further details.
Connection Uptime (s)	The connection uptime in seconds.
Blk (%)	The blocked percentage indicates the percentage of time during which the event broker has data to send on the TCP connection but cannot send it (for example due to a closed send window).
Intf	The physical interface through which Ethernet frames for the TCP connection are sent.

Clearing Client Statistics

To clear the statistics for one or more clients, enter the following Privileged EXEC command. Once the clear command is entered, the current statistics are reset to zero, and they begin to be recorded again.

solace# clear client <name> [message-vpn <vpn-name>] [primary] [backup] [static] stats

Where:

<name> is the full name of the client, or part of the client 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 clients.

primary indicates to only clear statistics for clients associated with the primary virtual router.

backup indicates to only clear statistics for clients associated with the backup virtual router.

static indicates to only clear statistics for clients associated with the static virtual router.

Showing Client Profile Information

To show client profile configurations, enter the following User EXEC command:

solace> show client-profile [<name>] [message-vpn <vpn-name>] [detail]

Where:

<name> is the name of the client profile. Entering no name displays all client profiles configured on the event broker.

<vpn-name> is Message VPN that the client profile belongs to. The vpn-name can be the full name of the Message VPN, 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 client profile information, including a list of all client username accounts using the profile

Showing Client Username Information

To show a client username configuration and status, enter the following User EXEC command:

solace> show client-username <name> [message-vpn <vpn-name>] [stats | detail | guaranteed-endpoints-owned]

Where:

<name> is the full username of the client username account, or part of the username 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 the wildcard character * for the username displays all client username accounts.

<vpn-name> is Message VPN that the client username belongs to. The vpn-name can be 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.

stats asks to show client username statistics

detail asks to show detailed client username information

guaranteed-endpoints-owned asks to show guaranteed endpoints owned by the client username

Clearing Client Username Statistics

To clear the statistics for one or more client usernames, enter the following Privileged EXEC command:

solace> enable
solace# clear client-username <name> [message-vpn <vpn-name>] stats

Where:

<name> is the full name of the client username, or part of the client username 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 clients.

Showing Aggregated Client Statistics

To view global client statistics information on the event broker, whereby the statistics displayed are an aggregate of all existing client statistics, enter the following User EXEC command:

solace> show stats client [detail]

Where:

detail asks to show detailed client statistics

The following table describes the information logged in the detailed client statistics.

Description of Detailed Client Statistics
Statistic	Description
Client Statistics:
Total Clients	The total number of connections on the event broker.
Total Clients Connected	The total number of connected clients.
Non-Compressed	The total number of connected clients connected with compression disabled.
Compressed	The total number of connected clients connected with compression enabled.
SSL	The total number of clients connected using the SSL or TSL protocol.
Non-SSL	The total number of clients connected without the SSL or TSL protocol.
Service SMF	The total number of clients connected using the Solace Message Format (SMF) protocol.
Service Web Transport	The total number of clients connected using the web-socket protocol.
Service REST	The total number of clients connected using REST.
Service MQTT	The total number of clients connected using the MQTT protocol.
Statistics for Client Messages:
Total Client Messages	The total number of messages that were received and sent.
Client Data Messages:
Client Data Messages	The total number of data messages that were received and sent.
Persistent	The total number of persistent data messages that were received and sent.
Non-persistent	The total number of non-persistent data messages that were received and sent.
Direct	The total number of direct data messages that were received and sent.
Large Messages	The total number of large data messages that were received and sent.
DTO Messages	The total number of DTO data messages that were received and sent.
Client Control Messages:
Client Control Messages	The total number of client control messages that were received and sent.
Login	The total messages that were received and sent for client login.
Certificate Revocation Check	The total number of certificate revocation checks that were made to authenticate clients.
Allowed Valid	The total number of clients that were authenticated and their certificates returned a valid response to the revocation check.
Allowed Revoked	The total number of clients that were authenticated and their certificates returned an invalid response to the revocation check.
Allowed Unknown	The total number of clients that were authenticated and their certificates couldn't be determined by the revocation check.
Denied Unknown	The total number of clients that were denied because their certificates couldn't be determined by the revocation check.
Denied Revoked	The total number of clients that were denied because their certificates returned an invalid response to the revocation check.
Denied Duplicate Clients	The total number of clients that were denied because they were duplicate clients.
Denied Authorization Failed	The total number of clients that were denied because their authorization failed.
Denied Client Connect ACL	The total number of clients that were denied because of a client Connect ACL disallowing their IP addresses.
Current Rate (1 sec)	The current rate per second of messages received and messages sent.
Average Rate (60 sec)	The average rate per 60 seconds of messages received and messages sent (see note below).
Update	The total messages that were received and sent for client updates.
JNDI Current Rate (1 sec)	The current rate per second of JNDI lookups received and sent by the clients.
JNDI Average Rate (60 sec)	The average rate per 60 seconds of JNDI lookups received and sent by the clients (see note below).
KeepAlive	The total number of KeepAlive messages received and sent by the API.
Assured Control	The total number of Assured Control messages that were received and sent.
Add Subscription Messages (Statistics for added subscriptions):
Client Adds	The total number of added subscriptions received and sent by the clients.
Subscription Manager Adds	The total number of added subscriptions received and sent by the subscription manager.
Already Exists	The total number of subscriptions that already exist.
Not Enough Space	The total number of occurrences where added subscriptions reached the not-enough-space threshold.
Max Exceeded	The total number of occurrences where added subscriptions exceeded the maximum threshold.
Parse Error	The total number of errors that occurred while parsing added subscriptions.
Denied Subscribe Topic ACL	The total number of subscription adds that were denied because of Subscriber ACLs.
Denied Subscribe Topic Reserved	The total number of subscription adds that were denied because they were reserved subscriptions.
Shared Subscription Permission Denied	The total number of clients that were not granted permission to add a shared subscription.
Subscription Manager (The state of the subscription manager client for added subscriptions):
No Permission	The total number of occurrences where the subscription manager didn't have permission to control added subscriptions for other clients.
Client Name Not Found	The total number of occurrences where a client name was not found by the subscription manager.
Shared Subscription Permission Denied	The total number of shared subscription adds that were not granted permission by the subscription manager.
Remove Subscription Messages (Statistics for removed subscriptions):
Client Removes	The total number of removed subscriptions received and sent by the clients.
Subscription Manager Removes	The total number of removed subscriptions received and sent by the subscription manager.
Not Found	The total number of subscriptions that were not found.
Parse Error	The total number of errors that occurred while parsing removed subscriptions.
Denied Unsubscribe Topic ACL	The total number of topics that clients were not allowed to unsubscribe to by the Subscriber ACLs.
Subscription Manager (The state of the subscription manager client for removed subscriptions):
No Permission	The total number of occurrences where the subscription manager didn't have permission to control removed subscriptions for other clients.
Client Name Not Found	The total number of occurrences where a client name was not found by the subscription manager.

Avg. Rate (60 sec interval)—A statistical value that shows an approximation (not an average) based on a smoothing function with a 60 second time constant.
Elided—A value that shows the number of messages discarded due to the use of the message eliding function.
Message Spool Congestion—A value that shows the number of promoted messages discarded by the event broker. This situation occurs when messages are arriving faster than they can be spooled.
Message Spool Egress Discards—A value that shows the number of Guaranteed messages deleted or discarded due to expired time-to-live (TTLs), administrative deletion, or both.
Client Not Connected—A value that shows the number of messages discarded due to disconnected client applications.

Clearing Client Statistics

To clear the statistics for one or more clients, enter the following Privileged EXEC command. Once this clear command is entered, the current statistics are reset to zero, and then they begin to be recorded again.

solace> enable
solace# clear client <name> [message-vpn <vpn-name>] [primary] [backup] [internal] stats

Where:

primary asks to clear statistics only for primary clients

backup asks to clear statistics only for backup clients

internal asks to clear statistics only for internal clients

To clear all global statistics stored for clients, as well as individual client statistics, enter the clear stats client Privileged EXEC command. Once the clear command is entered, the current statistics are reset to zero, and then they begin to be recorded again.

solace> enable
solace# clear stats client

Provide feedback