feat(ratelimit): Expose metrics on quota usage

This provides two prometheus metrics to monitor the rate limiter:

boundary_controller_api_ratelimiter_quota_storage_capacity:

This is a gague that shows the total number of quotas that can be stored
at a given moment by the rate limiter.

boundary_controller_api_ratelimiter_quota_storage_usage:

This is a gague that shows the number of quotas currently being stored
by the limiter. If this becomes equal to the capacity, requests that
would result in a new quota being created will get limited and receive a
429 status code.
This commit is contained in:
Timothy Messier committed 2023-12-04 16:24:04 +00:00
1 parent 0bc423ebd8
commit 3c2bed92b0
3 files changed
+65 -2

No files matched your search

+6 -2
View File
@@ -160,6 +160,7 @@ type Controller struct {
func New(ctx context.Context, conf *Config) (*Controller, error) {
const op = "controller.New"
metric.InitializeApiCollectors(conf.PrometheusRegisterer)
ratelimit.InitializeMetrics(conf.PrometheusRegisterer)
c := &Controller{
conf: conf,
logger: conf.Logger.Named("controller"),
@@ -255,7 +256,10 @@ func New(ctx context.Context, conf *Config) (*Controller, error) {
return nil, fmt.Errorf("error parsing rate limit configuration: %w", err)
}
rateLimiter, err := rate.NewLimiter(rateLimits, conf.RawConfig.Controller.ApiRateLimiterMaxEntries)
rateLimiter, err := ratelimit.NewLimiter(
rateLimits,
conf.RawConfig.Controller.ApiRateLimiterMaxEntries,
)
if err != nil {
return nil, fmt.Errorf("error initializing rate limiter: %w", err)
}
@@ -656,7 +660,7 @@ func (c *Controller) ReloadRateLimiter(newLimitConfigs ratelimit.Configs, newMax
return fmt.Errorf("error parsing rate limit configuration: %w", err)
}
limiter, err := rate.NewLimiter(ratelimits, newMaxEntries)
limiter, err := ratelimit.NewLimiter(ratelimits, newMaxEntries)
if err != nil {
return err
}