Consumers

Messages are read or consumed from the Stream by Consumers. We support pull and push-based Consumers and the example scenario has both, let’s walk through that.

Creating Pull-Based Consumers

The NEW and DISPATCH Consumers are pull-based, meaning the services consuming data from them have to ask the system for the next available message. This means you can easily scale your services up by adding more workers and the messages will get spread across the workers based on their availability.

Pull-based Consumers are created the same as push-based Consumers, you just don’t specify a delivery target.

  1. nats con ls ORDERS
  1. No Consumers defined

We have no Consumers, lets add the NEW one:

I supply the --sample options on the CLI as this is not prompted for at present, everything else is prompted. The help in the CLI explains each:

  1. nats con add --sample 100
  1. ? Select a Stream ORDERS
  2. ? Consumer name NEW
  3. ? Delivery target
  4. ? Start policy (all, last, 1h, msg sequence) all
  5. ? Filter Stream by subject (blank for all) ORDERS.received
  6. ? Maximum Allowed Deliveries 20
  7. Information for Consumer ORDERS > NEW
  9. Configuration:
  11.         Durable Name: NEW
  12.            Pull Mode: true
  13.              Subject: ORDERS.received
  14.          Deliver All: true
  15.         Deliver Last: false
  16.           Ack Policy: explicit
  17.             Ack Wait: 30s
  18.        Replay Policy: instant
  19.   Maximum Deliveries: 20
  20.        Sampling Rate: 100
  22. State:
  24.   Last Delivered Message: Consumer sequence: 1 Stream sequence: 1
  25.     Acknowledgment floor: Consumer sequence: 0 Stream sequence: 0
  26.         Pending Messages: 0
  27.     Redelivered Messages: 0

This is a pull-based Consumer (empty Delivery Target), it gets messages from the first available message and requires specific acknowledgement of each and every message.

It only received messages that originally entered the Stream on ORDERS.received. Remember the Stream subscribes to ORDERS.*, this lets us select a subset of messages from the Stream.

A Maximum Delivery limit of 20 is set, this means if the message is not acknowledged it will be retried but only up to this maximum total deliveries.

Again this can all be done in a single CLI call, lets make the DISPATCH Consumer:

  1. nats con add ORDERS DISPATCH --filter ORDERS.processed --ack explicit --pull --deliver all --sample 100 --max-deliver 20

Additionally, one can store the configuration in a JSON file, the format of this is the same as $ nats con info ORDERS DISPATCH -j | jq .config:

  1. nats con add ORDERS MONITOR --config monitor.json

Creating Push-Based Consumers

Our MONITOR Consumer is push-based, has no ack and will only get new messages and is not sampled:

  1. nats con add
  1. ? Select a Stream ORDERS
  2. ? Consumer name MONITOR
  3. ? Delivery target monitor.ORDERS
  4. ? Start policy (all, last, 1h, msg sequence) last
  5. ? Acknowledgement policy none
  6. ? Replay policy instant
  7. ? Filter Stream by subject (blank for all)
  8. ? Maximum Allowed Deliveries -1
  9. Information for Consumer ORDERS > MONITOR
  11. Configuration:
  13.       Durable Name: MONITOR
  14.   Delivery Subject: monitor.ORDERS
  15.        Deliver All: false
  16.       Deliver Last: true
  17.         Ack Policy: none
  18.      Replay Policy: instant
  20. State:
  22.   Last Delivered Message: Consumer sequence: 1 Stream sequence: 3
  23.     Acknowledgment floor: Consumer sequence: 0 Stream sequence: 2
  24.         Pending Messages: 0
  25.     Redelivered Messages: 0

Again you can do this with a single non-interactive command:

  1. nats con add ORDERS MONITOR --ack none --target monitor.ORDERS --deliver last --replay instant --filter ''

Additionally one can store the configuration in a JSON file, the format of this is the same as $ nats con info ORDERS MONITOR -j | jq .config:

  1. nats con add ORDERS --config monitor.json

Listing

You can get a quick list of all the Consumers for a specific Stream:

  1. nats con ls ORDERS
  1. Consumers for Stream ORDERS:
  3.         DISPATCH
  4.         MONITOR
  5.         NEW

Querying

All details for a Consumer can be queried, lets first look at a pull-based Consumer:

  1. $ nats con info ORDERS DISPATCH
  2. Information for Consumer ORDERS > DISPATCH
  4. Configuration:
  6.       Durable Name: DISPATCH
  7.          Pull Mode: true
  8.            Subject: ORDERS.processed
  9.        Deliver All: true
  10.       Deliver Last: false
  11.         Ack Policy: explicit
  12.           Ack Wait: 30s
  13.      Replay Policy: instant
  14.      Sampling Rate: 100
  16. State:
  18.   Last Delivered Message: Consumer sequence: 1 Stream sequence: 1
  19.     Acknowledgment floor: Consumer sequence: 0 Stream sequence: 0
  20.         Pending Messages: 0
  21.     Redelivered Messages: 0

More details about the State section will be shown later when discussing the ack models in depth.

Stream vs Consumer sequence numbers

The two number are not directly related: the Stream sequence number is the pointer to the exact message, while the Consumer sequence number is an ever-increasing counter for consumer actions.

So for example a stream with 1 message in it would have stream sequence of 1, but if the consumer attempted 10 deliveries of that message consumer sequence would be 10 or 11.

Consuming Pull-Based Consumers

Pull-based Consumers require you to specifically ask for messages and ack them, typically you would do this with the client library Request() feature, but the nats utility has a helper:

First, we ensure we have a message:

  1. nats pub ORDERS.processed "order 1"
  2. nats pub ORDERS.processed "order 2"
  3. nats pub ORDERS.processed "order 3"

We can now read them using nats:

  1. nats con next ORDERS DISPATCH
  1. --- received on ORDERS.processed
  2. order 1
  4. Acknowledged message

Consumer another one

  1. nats con next ORDERS DISPATCH
  1. --- received on ORDERS.processed
  2. order 2
  4. Acknowledged message

You can prevent ACKs by supplying --no-ack.

To do this from code you’d send a Request() to $JS.API.CONSUMER.MSG.NEXT.ORDERS.DISPATCH:

  1. nats req '$JS.API.CONSUMER.MSG.NEXT.ORDERS.DISPATCH' ''
  1. Published [$JS.API.CONSUMER.MSG.NEXT.ORDERS.DISPATCH] : ''
  2. Received [ORDERS.processed] : 'order 3'

Here nats req cannot ack, but in your code you’d respond to the received message with a nil payload as an Ack to JetStream.

Consuming Push-Based Consumers

Push-based Consumers will publish messages to a subject and anyone who subscribes to the subject will get them, they support different Acknowledgement models covered later, but here on the MONITOR Consumer we have no Acknowledgement.

  1. nats con info ORDERS MONITOR

Output extract

  1. ...
  2.   Delivery Subject: monitor.ORDERS
  3. ...

The Consumer is publishing to that subject, so let’s listen there:

  1. nats sub monitor.ORDERS
  1. Listening on [monitor.ORDERS]
  2. [#3] Received on [ORDERS.processed]: 'order 3'
  3. [#4] Received on [ORDERS.processed]: 'order 4'

Note the subject here of the received message is reported as ORDERS.processed this helps you distinguish what you’re seeing in a Stream covering a wildcard, or multiple subjects, subject space.

This Consumer needs no ack, so any new message into the ORDERS system will show up here in real-time.