Skip to content

Support streaming RE waiting hook watcher updates over a new ZMQ topic - #357

Draft
jwlodek wants to merge 14 commits into
bluesky:mainfrom
jwlodek:stream-watcher-updates
Draft

Support streaming RE waiting hook watcher updates over a new ZMQ topic#357
jwlodek wants to merge 14 commits into
bluesky:mainfrom
jwlodek:stream-watcher-updates

Conversation

@jwlodek

@jwlodek jwlodek commented Aug 4, 2026

Copy link
Copy Markdown
Member

Resolves #353. Adds an additional zmq topic for streaming RE waiting hook progress updates. Adds additional CLI/config options to enable the feature + a waiting hook compatible class that posts the updates from the RE to zmq. Clients can then use these updates to construct progress bars and the like.

Motivation and Context

Currently, a common piece of feedback from BL staff that use queueserver is that there isn't enough feedback on the state of a scan as it is taking place. Being able to re-create something similar to the bluesky ProgressBarManager by using streamed RE updates should ameliorate this issue.

Summary of Changes for Release Notes

Fixed

Added

  • Add new progress streaming config option to schema
  • Update config with progress streaming option
  • Add additional progress streaming topic & related boilerplate
  • Add waiting hook api compatible watcher class that is used for getting watcher updates from RE to progress msg queue
  • Add progress streaming to manager start options
  • Add new progress streaming classes to init
  • On startup, if progress streaming is on, set the RE waiting hook to the watcher stream manager
  • Add unit tests for watcher stream manager
  • Break info publishing out from the console publishing CLI flag. Make progress publishing follow the same format.
  • Update some help messages for CLI flags

Changed

  • Info message publishing is now controlled with a separate flag, rather than being tied to console publishing

Removed

How Has This Been Tested?

Added unit tests, and explicit local integration test

@jwlodek
jwlodek requested a review from dmgav August 4, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow for streaming RE watcher updates to remote clients via zmq/websocket

1 participant