envoyproxy / envoyproxy/ratelimit

Proposal: flag to use tags instead of metric names to distinguish rate limit configs

Open
#162 3 comments 3 reactions 0 assignees View on GitHub
help wanted
Dominant language
Go
Stars
2.7k
Forks
535
PR merge metrics
No merged PRs in 30d

Description

Checking in here before sending out code for this.

The proposal is to add a setting like 'STATS_WITH_TAGS' that changes from reporting config stats like:

`ratelimit.service.rate_limit.._..total_hits`
`ratelimit.service.rate_limit...total_hits`

To something more like:

`ratelimit.service.rate_limit.total_hits config=._.`
`ratelimit.service.rate_limit.total_hits config=.._.`

The non-tagged stats would be deprecated, and on a long-term timeframe maybe the stats reporting would migrate away from the gostats library to the opentelemetry library when it's considered sufficiently mature.

Motivations:
- Some (all?...) dashboard systems make it easier to do aggregation over tags vs over metrics. For example, today both `ratelimit.service.rate_limit..over_limit` and `ratelimit.service.rate_limit..over_limit_with_cache` are metric names, and the dashboarding system I'm working with seems to have inflexible aggregration + globbing so that there doesn't seem to be a way to make a graph including the "over_limit" that doesn't also include the "over_limit_with_cache"
- statsd doesn't have an official protocol and implementations are not all compatible, so moving away from it as a default over time toward supporting protocols real standards feels sensible. Some people will also probably want to ingest into places like Prometheus where stats are more expressive than statsd and can report descriptions of what the metrics are.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.