Feature request - server side type filters in stream API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
Looking at consuming the eventstream directly, and the execution events are very frequent but I'm only interested in st2.announcement__chatops.
Having a queryable type filter on the stream API would really improve the performance of hubot-stackstorm for large installations because of the sheer noise of st2.liveaction__update.
Stumbled on a roadblock
https://github.com/StackStorm/st2/blob/1df8f4cdd4fc4e3bd1eac79732d1b3aac1be4745/st2stream/st2stream/listener.py#L110
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with st2stream/st2stream/listener.py around the linked line and trace how eventstream subscriptions are handled. Identify the stream API entry point and how event types are represented, then verify the design against the requested st2.announcement__chatops filter and the noisy st2.liveaction__update events. Done means consumers can request a type filter and receive only matching events.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100