StackStorm / StackStorm/st2

Additional metrics instrumentation for various services and code paths

Open
#4,314 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement metrics
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

#4310 made a lot of improvements to the instrumentation and metrics code. This means we now have instrumentation and metrics in place for most of the critical code paths.

This will provide us and users with a much better insight into workings of a StackStorm cluster.

Having said that, there are still places for which we don't have any instrumentation and we should improve that in the future:

  • Sensors (number of running sensors, number of emitted trigger instances by a particular sensor)
  • Timers (number of active timers, number of active timers per timer / trigger type, timer information for emitting trigger instance inside a timer)
  • Stream service (current number of open connections)
  • All api services (request size, response sizes - gauge)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the instrumentation and metrics improvements described in #4310, then inspect the existing metrics in the relevant services and code paths. The remaining scope covers sensors, timers, and API request and response sizes; done means the unchecked metrics are instrumented with suitable coverage and verified against existing metrics behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.