Unleash / unleash / 32375756713

87%

master: 91%

Build Type

push

github

Committed by web-flow

Commit Message

feat(metrics): instrument the API token caches (v1 + v2)

Before we begin the token cache validation, we **add new metrics** to
make sure changes are on the right direction.

We firstly label `cache = api-token-v1 | api-token-v2 `so the two
versions of tokens are directly comparable.
 
#### What is already measured 
no need to repeat it for API tokens:
the DB_TIME / FUNCTION_TIME - we can use it to check the times of the
lookups

#### What we intend to measure:
- `token_cache_lookup_total `+ `token_cache_lookup_duration_seconds` :
hit ratio and how expensive the scan actually is
- `token_cache_size ` - how many tokens installs really have. Gonna say
a lot of the follow-up design ;)
- `token_cache_refresh_total` - refreshes currently fail into a log line
and nothing else, so a pod that stops refreshing is worth an alert
- `token_cache_alias_hit_total` - we expect/hope to see 0, if so, we
happily drop alias on final phase
- `token_cache_negative_flush_total ` - `/edge/validate` is
unauthenticated and the negative cache clears wholesale at 1000 entries

#### What we have skipped:
- labels per tenants 
- byte counters
- anything for LRU/revalidation - it's not here yet 😇 

Notes:
- moved `this.eventBus` assignment above the constructor's
`fetchActiveTokens() `in v1 - it emits on it now and would've hit
undefined


📩 The most important metric is to validate that every token change
actually writes an event. To add this metric, we need a new index
(already planned to create it in a later phase). So, this part [comes in
another
PR](https://github.com/bricks-software/unleash-enterprise/pull/1544) to
accompany the required changes (and not overdo this one here)

---------

Co-authored-by: irstavr <irstavr@gmail.com>
Co-authored-by: irini.stavrakantonaki <irini.stavrakantonaki@getunleash.io>

Coverage Stats

3859 of 5019 branches covered (76.89%)

32 of 37 new or added lines in 6 files covered. (86.49%)

3 existing lines in 2 files now uncovered.

15902 of 18181 relevant lines covered (87.46%)

800.99 hits per line