Skip to content

Conversation

@Kami
Copy link
Member

@Kami Kami commented Aug 20, 2018

This pull request adds some basic documentation on our metrics framework and various metrics exposed by StackStorm.

Background

A while ago, @bigmstone merged a great PR which added a basic metrics framework and some basic instrumentation to our code base.

While working on some HA stuff (long term automated and continuous benchmarks) I noticed we are missing a lot of important metrics (aka a lot of important code is not instrumented). My goal is to solve that and add additional instrumentation in StackStorm/st2#4310 (some of that is already there, some I'm still working on).

With all those metrics in place we should now provide a much better operational visibility and operator should have a much better idea on what is going on.

While documenting the exposed metrics I also noticed that our metric naming is not consistent, so I will also fix that in StackStorm/st2#4310. Naming is one of those things where "WDBC" (I made that one up, aka TDD for docs - write docs before code) sometimes makes sense :D

NOTE: I explicitly only documented statsd backend - it's the one we were and I am / will be testing. We also have some code in place for ptometheus backend, but it hasn't been tested much and I would rather have us support one backend fully and correctly then half support multiple backends.

I also know @armab would prefer us to support prometheus backend, but again, I'm being realistic with our commitments and timing and I'd rather have us support one bakend well to begin with.

TODO

Goal is to merge StackStorm/st2#4310 in time for v2.9.0 so our goal should be to go over this list and identify if there are any other important metrics missing and if they are, instrument the code and document them here.

Some important metrics which are currently not there and I plan to add:

  • How many of the processed rules (trigger instances) rules into action execution (rules which matched criteria) - counter
  • Same information as above, but on per rule ref basis

@Kami Kami added this to the 2.9.0 milestone Aug 20, 2018
@Kami Kami changed the title [WIP] Add some documentation on metrics and instrumentation Add some documentation on metrics and instrumentation Aug 20, 2018
@bigmstone
Copy link
Contributor

This is looking pretty good to me.

@LindsayHill
Copy link
Contributor

Content is good, and long-awaited. I think this should either be included in reference/monitoring, or at least cross-referenced from there.

@Kami Kami merged commit 938b156 into master Aug 22, 2018
@Kami Kami deleted the metrics_docs branch August 22, 2018 14:46
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.

4 participants