The goal of this demo is to illustrate a real world example of using messaging between microservices in the cloud. This demo illustrates the Aggregator Microservice Design Pattern using an event driven architecture with messaging to communicate between Microservices, specifically Solace Messaging in VMware Tanzu (formerly Pivotal Cloud Foundry).
This project is similar to the following Solace Labs Demo: SolaceLabs/solace-messaging-demo. The difference is that this project uses the Spring Cloud Connector for Solace Messaging and is currently not suitable outside of Cloud Foundry. The SolaceLabs/solace-messaging-demo project uses the Solace Java Spring Boot project to connect to Solace Messaging and therefore currently is not suited to a Cloud Foundry environment. Going forward we will move to a single demo which works in both environments and is platform agnostic.
- Overview
- Deploying to Cloud Foundry
- Demo Components
- Using the Demo
- Contributing
- Authors
- License
- Resources
As illustrated in the architecture diagram above, this demo is composed of the following parts:
- A RESTful Web Application receives incoming requests. In this demo, the job requests are number of work units, rate, and delay characteristics.
- The work requests are sent to a non-exclusive queue in the Solace Messaging Service.
- The worker applications process messages from the Solace queue. The application can be horizontally scaled using Cloud Foundry to increase the overall processing throughput of the system.
- When a Worker is done with a work request, it sends the response. For the purposes of this demo, the Aggregator Application tracks and displays status of each job in the summary table below.
- The Aggregator Application and Worker Applications depend on a Solace Messaging Service for Cloud Foundry.
- All of the apps are pushed to Cloud Foundry through the CLI or VMware Tanzu Apps Manager.
This demo depends on Solace Messaging for Cloud Foundry being installed and available in the Cloud Foundry marketplace. If that is not already done, use the following links:
The demo applications specify a dependency on a Solace Messaging service instance named solace-messaging-demo-instance. To create the required Solace messaging service instance, do the following:
cf create-service solace-messaging shared solace-messaging-demo-instance
Clone this GitHub repository and build. For example:
git clone https://github.com/SolaceLabs/sl-cf-solace-messaging-demo.git
cd sl-cf-solace-messaging-demo
./gradlew build
You need to deploy both the Aggregator and Worker application to Cloud Foundry. The included manifest.yml can be used to deploy both applications using the Cloud Foundry CLI from the project root directory:
$ cf push
As shown in the overview, this demo is made up of two Cloud Foundry applications. Both are Spring Boot Java Applications which make use of the Solace Messaging Spring Cloud Connectors Extention to establish the connection to Solace Messaging. The two applications are:
- Aggregator
- Worker
application name: cf-solace-messaging-demo-aggregator-app
This application is a web based application that serves a simple web page. In that web pages you can enter requests which for this demo are described as jobs. The application then sends the requests as messages on the Solace Messaging service and it waits and correlates the subsequent replies.
application name: cf-solace-messaging-demo-worker-app
The worker application is a Solace Messaging application that binds and listens to a Solace Non-Exclusive Queue. When it receives requests, it parses them, finds the work contents and simulates work by sleeping based on the parameters in the request. Once done it sends a correlated response back to the Solace Messaging Service to notify the Aggregator application.
You can access the demo Web UI, by browsing to the Aggregator application's URL. You can find this URL from Apps Manager or through the Cloud Foundry CLI as follows:
$ cf apps
Getting apps in org demo / space demo as demoUser...
OK
name requested state instances memory disk urls
cf-solace-messaging-demo-aggregator-app started 1/1 512M 1G cf-solace-messaging-demo-aggregator-app.cloudfoundry.io
cf-solace-messaging-demo-worker-app started 1/1 512M 1G cf-solace-messaging-demo-worker-app.cloudfoundry.io
In this case the URL would be:
cf-solace-messaging-demo-aggregator-app.cloudfoundry.io
The Web UI will look similar to this:
To add a new job, you fill in the web form by adding the following:
- Unique Job ID
- Work Count - This equates to number of messages to sent.
- Send Rate - How fast the Aggregator should send the messages. Sending faster than the workers can process creates a work backlog in the Solace queue. This is evident in the UI through larger than expected latency.
- Min Delay - The lower bound for work delays. For each work message, the Aggregator will assign a random delay between the min and max.
- Max Delay - The upper bound for work delays.
Once a Job is added to the system, you will see it in the summary table at the bottom. Under Job Requests, the Aggregator status is reflected. The Job Summaries, provides insight into how quickly responses are coming back from the Worker Applications. If you create a scenario where the work is being sent faster than it can be produced (the send rate is faster than the min delay), the you can use the CF scale command to scale the Worker applications and increase the overall throughput of the system. This is the horizontal scaling aspect of the demo.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
See the list of contributors who participated in this project.
This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.
Here are some interesting links if you're new to these concepts: