Skip to main content
Version: 2.32.2

Base Rate Limiting Policy

Introduction

This blueprint provides a token bucket based rate-limiting policy and a dashboard. This policy uses the RateLimiter component.

Configuration

Blueprint name: rate-limiting/base

Parameters

policy

Parameterpolicy.components
DescriptionList of additional circuit components.
TypeArray of Object (aperture.spec.v1.Component)
Default Value
Expand
[]
Parameterpolicy.policy_name
DescriptionName of the policy.
Typestring
Default Value__REQUIRED_FIELD__
Parameterpolicy.resources
DescriptionAdditional resources.
TypeObject (aperture.spec.v1.Resources)
Default Value
Expand
flow_control:
classifiers: []
policy.rate_limiter
Parameterpolicy.rate_limiter.alerter
DescriptionAlerter.
TypeObject (aperture.spec.v1.AlerterParameters)
Default Value
Expand
alert_name: More than 90% of requests are being rate limited
Parameterpolicy.rate_limiter.bucket_capacity
DescriptionBucket capacity.
TypeNumber (double)
Default Value__REQUIRED_FIELD__
Parameterpolicy.rate_limiter.fill_amount
DescriptionFill amount.
TypeNumber (double)
Default Value__REQUIRED_FIELD__
Parameterpolicy.rate_limiter.parameters
DescriptionParameters.
TypeObject (aperture.spec.v1.RateLimiterParameters)
Default Value
Expand
interval: __REQUIRED_FIELD__
Parameterpolicy.rate_limiter.request_parameters
DescriptionRequest Parameters.
TypeObject (aperture.spec.v1.RateLimiterRequestParameters)
Default Value
Expand
{}
Parameterpolicy.rate_limiter.selectors
DescriptionFlow selectors to match requests against
TypeArray of Object (aperture.spec.v1.Selector)
Default Value
Expand
- control_point: __REQUIRED_FIELD__