Spring Cloud Stream Solace - Sticky Load Balancing Implementation

samuel
samuel Member Posts: 6
edited June 2021 in General Discussions #1

Can any one please help me with a sample implementation of sticky load balancing with spring cloud stream solace.
My use case is account transaction information are posted to a solace topic to 6 different partitions. There will be consumer(s) reading from these partitions. Initially there will be 1 consumer which is hosted as part of spring cloud stream micro service. The micro service should be horizontally scalable and when that happens I want the spawned consumers to equally share the 6 partitions among themselves.

Comments

  • hong
    hong Guest Posts: 480 ✭✭✭✭✭
  • samuel
    samuel Member Posts: 6
    edited June 2021 #3

    Thanks for sharing the links. I have gone through these posts.
    Following is the configuration in my service (spring could stream with solace).
    I have manually created 2 exclusive queues (queue0, queue1) and have subscriptions on these queues.
    queue0 with subscriptions "scm/account/0/bal and scm/account/1/bal"
    queue1 with subscriptions "scm/account/2/bal and scm/account/3/bal"
    I am running two instances of the service and expecting the each instance to bind to 1 queue. But I am observing that the first instance which comes up binds to both the queues. All the messages on both the queues are being consumed by only this instance. I am still in the process of figuring out whats going wrong here. It would be great if you can help me understand whats going wrong here. Also wanted to understand if this feature is available to be used in conjunction with spring cloud stream.
    I am using spring-cloud-stream-binder-solace 3.1.0

    spring:
    stream:
    bindings:
    process-in-0:
    destination: queue0,queue1
    group: my_consumer_group
    consumer:
    partitioned: true

  • marc
    marc Member, Administrator, Moderator, Employee Posts: 955 admin

    Hey @samuel,
    If I understand you correctly, what you are seeing is what I would expect. That said, I agree it may not be ideal for your use case of having 2 apps that are the primary consumer on one queue and the backup on another. To explain what's happening: the Spring Cloud Stream binder leverages the functionality provided by the Solace Exclusive queue to achieve this "Primary", "Secondary", "Tertiary" pattern. Because of this the first Session/Flow to bind to each queue will be the active consumer and receive all messages delivered to that queue. In your case, since both of your apps are listening to both queues the first one that starts up will receive all messages from each queue and neither instance knows if/how many other instances are bound to the same queue. Only the broker has that logic.

    I'll have to think and get back to you if there is another option, but you may have to have a separate instance that serves as the backup. A few other options that come to mind is expiring messages to a DMQ as a work around but that sounds nasty or requesting that the Solace binder be enhanced to add functionality to start/stop individual bindings as defined here

    Side note - does that configuration of destination: queue0,queue1 actually work for you? I haven't tried to list multiple destinations on a single function.

    Not ideal news, but hopefully that helps and prevents you from wasting time figuring out why something is working how it is actually supposed to work 😝

  • samuel
    samuel Member Posts: 6

    Hi Marc, Thanks for the update.
    To your question having multiple queue destinations as a comma separated list does work and the app starts receiving messages from both the queues.
    I was thinking that by adding the consumer property spring cloud stream partitioned: true, the binder will ensure that there is only one instance which is connected as primary to a particular queue, so that the load can be balanced among the available instances. I believe that's how it works with spring cloud stream Kafka binder.
    The plan that I had was to deploy this micro service behind an auto scaling group, scaling the instances based on the cpu or memory utilisation of instance. So during a peak load if we have 5 queues, then we will end up having 5 instances of micro service each reading from a single queue. Similar to how consumer group and partitioning works with Kafka.

  • marc
    marc Member, Administrator, Moderator, Employee Posts: 955 admin

    Hi @samuel,

    To your question having multiple queue destinations as a comma separated list does work and the app starts receiving messages from both the queues.

    Thanks for that confirmation! I'll have to try that out.

    I was thinking that by adding the consumer property spring cloud stream partitioned: true, the binder will ensure that there is only one instance which is connected as primary to a particular queue, so that the load can be balanced among the available instances. I believe that's how it works with spring cloud stream Kafka binder. The plan that I had was to deploy this micro service behind an auto scaling group, scaling the instances based on the cpu or memory utilisation of instance. So during a peak load if we have 5 queues, then we will end up having 5 instances of micro service each reading from a single queue. Similar to how consumer group and partitioning works with Kafka.

    The Solace binder supports publish-subscribe and consumer groups patterns as defined by Spring Cloud Stream but does not support partitioning options in the framework so specifying partitioned: true won't do anything for our binder. That said you can still do partitioning with solace topics as defined in @Aaron's blog here. See the "Sticky Load-Balancing, or Keyed/Hashed Delivery" section. When doing that with Spring Cloud Stream I would recommend pre-creating your queues and having a separate app that manages the topic subscriptions on your queues. You can use Solace's "On Behalf Of" functionality to do this (there is some solid content out there if you google that).

  • samuel
    samuel Member Posts: 6

    Thanks Marc. Will read through the On Behalf Of functionality

  • msharpe
    msharpe Member Posts: 17

    To confirm the only load balancing solution with solace binder to ensure ordering is to run an instance single threaded, each pointing to its own queue?

    Any improvement to this planned, as we will need to run 100s of instances for any performance and spring boot apps are slow to start up,

  • marc
    marc Member, Administrator, Moderator, Employee Posts: 955 admin

    Hi @msharpe,

    Correct, when trying to consume order the broker can really only give a stream of events to one consumer at a time and the broker relies on the user to define what that stream of events is. So if you are trying to essentially partition your larger stream into subsets in which order matters then you would usually do this by publishing to a well known topic hierarchy and do fine grained filtering in the topic subscriptions assigned to your queues.

    @Aaron wrote a great blog on it here: https://solace.com/blog/consumer-groups-consumer-scaling-solace/. Be sure to check out the "Using Solace Topics for Partitioning" section. If that doesn't do what you need it to let us know as I'd love to hear more about the use case.

    Hope that helps!

  • msharpe
    msharpe Member Posts: 17

    Thanks Marc for the response. If we created say 100 partitions, and had 10 queues to start with.

    10 app instances would consume off the 10 queues and consume 10 partitions each. If we could run 10 threads within each instance and have each thread process a single partition only and maintain order it would be preferable than running 100 instances as it's more difficult to manage and rollout and allocate resources in shared kubernetes environment for example.

    Any thoughts much appreciated.

  • Aaron
    Aaron Member, Administrator, Moderator, Employee Posts: 594 admin

    Old thread ping! @msharpe did you ever get this working? But yes, I believe what you were proposing could/should work. Without knowing too much about Spring, if you wanted each thread to process only a single partition, then you'd have to do some "topic dispatch" when receiving a message off a queue... look at the topic it was published to and dispatch it to the appropriate thread. But you wouldn't necessarily need 10 threads-per-instance unless you really needed/wanted that for performance.... you could do it all with a single thread? You at least know that, for a given queue and its associated topic partition subscriptions, that order would be guaranteed for each of those partitions.

    There's a feature that's in the planning stages called "partitioned queues" that would hopefully relieve some of this "manual" configuration around topic partitioning. Not sure when it's coming though.

  • siavashsoleymani
    siavashsoleymani Member Posts: 19 ✭✭

    Hello @mar! do you have any plans for implementing the partition feature in the Solace itself and the Spring cloud stream project? because as I look at this article https://solace.com/blog/sticky-load-balancing-in-solace-pubsub-event-broker/ it is too complicated and needs much effort for each team in order to implement it.

  • marc
    marc Member, Administrator, Moderator, Employee Posts: 955 admin

    Hi @siavashsoleymani - the short answer is "yes". We are implementing a partitioned queue for our brokers right now and it should be available in the first half of CY2023 (I think). More info to come! Once it's available in our brokers we'll of course be looking to add support into the Solace binder for Spring Cloud Stream.

  • chatumoh
    chatumoh Member Posts: 7

    @marc

    Is there an update on adding support for partitioning to Solace Spring Cloud Stream binder ? Is it available with v3.4 or v3.5 ?