Client Statistics

The Solace APIs provide various statistics for each session, which can be useful when debugging applications. For a list of all supported Session statistics, refer to the API Developer Reference documentation for the appropriate messaging API.

C API

  • solClient_session_getTxStats()
  • solClient_session_getTxStat()
  • solClient_session_getRxStats()
  • solClient_session_getRxStat()
  • solClient_flow_getRxStats()
  • solClient_flow_getRxStat()

JCSMP

  • Session.getSessionStats()

Client Throughput

There are a number of client types of interest when monitoring performance:

  • Each application session will have a corresponding client on the event broker.
  • Bridges will have a corresponding local and remote client for each bridge.

Each message VPN using replication (DR) will have a corresponding client.

Endpoint Throughput

There are a number of endpoint types of interest when monitoring performance:

  • Application endpoints
  • Persistent bridges will have a durable queue on the remote side of the bridge
  • Replicated message-vpns will have a durable queue on both DR-Active and DR-Standby event broker. The queue name will always be #MSGVPN_REPLICATION_DATA_QUEUE.

Multi-Node Routing (MNR) Statistics

When using direct messaging with multiple event brokers in a networked environment, it may be necessary to tune MNR neighbor links based on observed client connection statistics. Client queue statistics can be viewed using the following command,

show cspf neighbor stats queues

For more details on managing message delivery resources, refer to Message Delivery Resources.

Session Errors

A session corresponds to a single connection to the event broker. Applications must track the state of the session in order to deal with connection failures. Each of the APIs handle session errors in different ways, the API documentation should be consulted for a thorough understanding of session error handling.