SDKPerf
SDKPerf is a tool for validating performance, checking configuration, and exploring features associated with your Solace PubSub+ event broker.
SDKPerf is a non-production tool and not officially supported under our Customer Support policy. You may find SDKPerf useful for developmental and testing purposes; it is provided for "as-is" usage.
Download the latest version of SDKPerf.
Versions
SDKPerf is available for the following programming languages and technologies.
| SDKPerf for C | sdkperf_c is a C++ application which uses the PubSub+ Messaging API for C. It is available on the following operating systems.
|
| SDKPerf for CS | sdkperf_cs is a C# application that uses the PubSub+ Messaging APIs for .NET. It is available on Windows. |
| SDKPerf for Java & JMS | sdkperf_java contains two client implementations in a single package: it supports both the PubSub+ Messaging API for Java (JCSMP) and the PubSub+ Messaging API for JMS. The bin directory contains convenience scripts that make it clear which API is in use (for example, sdkperf_java and sdkperf_jms). Both sdkperf_java and sdkperf_jms works on all platforms that the PubSub+ Messaging APIs support that have at least Java 1.8. |
| SDKPerf for JavaScript | sdkperf_js is a JavaScript application which uses the PubSub+ Messaging API for JavaScript. It is accessed through a simple web page which presents the various tool options in a graphical format. |
| SDKPerf for MQTT | sdkperf_mqtt uses the Java SDKPerf platform and implements an MQTT client using the Paho Java API. It works against all MQTT event brokers including the Solace PubSub+ event broker. sdkperf_mqtt works on all platforms that have at least Java 1.8. |
| SDKPerf for Python | sdkperf_py uses the Python SDKPerf platform. This version requires Python version 3.7 or greater. |
| SDKPerf for REST | sdkperf_rest uses the Java SDKPerf platform and implements an HTTP client that follows the Solace REST Messaging Protocol. It is a quick and easy way to explore the Solace REST Messaging Protocol. sdkperf_rest will work on all platforms that have at least Java 1.8. |
Tool Dependencies
Often the correct functioning of certain SDKPerf command options requires associated configuration on the PubSub+ event broker and is important to consider as you explore various different command-line tools. The following are some specific dependencies.
- SDKPerf JMS—All JMS connections to event brokers depend on being able to look up the connection factory from a JNDI store. So, at a minimum, you need to enable JNDI look-ups within a Message VPN and configure a connection factory.
- SDKPerf REST—On the REST message consume side, SDKPerf REST acts as an HTTP server with the ability to correctly terminate Solace REST messaging connections and receive messages. For SDKPerf REST to receive messages, the event broker must be configured appropriately with a REST delivery point and a REST consumer within the Message VPN.
Many of the SDKPerf command line examples shown below assume this event broker configuration has been completed in order for the commands to work.
Quick Start
Give these commands a try if you just want to quickly get started with SDKPerf to send and receive messages. All the options and more examples are explained further in the sections that follow. Start with this one:
sdkperf –cip=HOST -stl=a/topic –ptl=a/topic –mn=1 -msa=10 –md
That's it! It publishes a ten byte message to topic a and subscribes to the same topic, displaying the messages it receives. Topic wildcards can be used for the subscription option. You can learn all about Solace topics in Topic Support & Syntax.
If you set up a new Message VPN and use a non-default username, use the -cu option, with –cp if you’re using a password. We didn’t use this before because SDKPerf uses the default username and JavaScript if you don’t specify one:
sdkperf –cip=HOST -stl=a/topic –ptl=a/topic –mn=1 -msa=10 –md –cu USERNAME@MSGVPN
If you're using Solace queues, provision your queue and substitute the -stl and -ptl options with the -sql and -pql options:
sdkperf –cip=HOST -sql=a/durable/queue –pql=a/durable/queue –mn=1 -msa=10 –md
If you want to connect to a PubSub+ Cloud account using Solace Message Format (SMF) over TCP, you must include the host address with port number, your password, user name and VPN as shown below:
sdkperf –cip=HOST:PORT -cp=PASSWORD -cu=USERNAME@VPN -ptl=a/topic –mn=5
That's just a quick introduction. You can go further by learning more about SDKPerf options, architecture, and application flow, along with examples in the following sections.
Architecture
The SDKPerf tools all share a common architecture across all the supported APIs and platforms. The following figure shows this architecture at a high level.
Because SDKPerf is a tool for testing messaging, internally it is modeled as a common core and a bunch of messaging clients implementations. The SDKPerf core platform exposes a client interface which it uses to generically interact with clients across any API. This allows for the SDKPerf tool to work in the same manner across all APIs and protocols it supports. This is depicted in the architecture figure where you can see that for each API or protocol there is a corresponding SDKPerf client implementation that makes use of the API protocol and implements SDKPerf's client interface. This allows the SDKPerf platform to code to focus on the performance and functional testing required in a client-agnostic way.
Application Flow
As a command line application SDKPerf will follow a specific application flow for a given invocation. On each invocation of SDKPerf, it does the following:
- Connect clients
- Add any required subscriptions and/or bind to endpoints
- Start publishing
- Wait until publishing is done
- Remove any subscriptions that were added
- Disconnect clients
- Cleanup and report stats
If the set of command line options used does not result in messages being published, the application will wait for SIGINT (Ctrl-C) instead of waiting until publishing has been completed.