Skip to main content
Version: 2.8.0

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.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__
label_key: ''
Parameterpolicy.rate_limiter.selectors
DescriptionFlow selectors to match requests against
TypeArray of Object (aperture.spec.v1.Selector)
Default Value
Expand
- control_point: __REQUIRED_FIELD__
service: __REQUIRED_FIELD__

dashboard

Parameterdashboard.extra_filters
DescriptionAdditional filters to pass to each query to Grafana datasource.
TypeObject (map[string]string)
Default Value
Expand
{}
Parameterdashboard.refresh_interval
DescriptionRefresh interval for dashboard panels.
Typestring
Default Value15s
Parameterdashboard.time_from
DescriptionFrom time of dashboard.
Typestring
Default Valuenow-15m
Parameterdashboard.time_to
DescriptionTo time of dashboard.
Typestring
Default Valuenow
Parameterdashboard.title
DescriptionName of the main dashboard.
Typestring
Default ValueAperture Rate Limiter
dashboard.datasource
Parameterdashboard.datasource.filter_regex
DescriptionDatasource filter regex.
Typestring
Default Value
Parameterdashboard.datasource.name
DescriptionDatasource name.
Typestring
Default Value$datasource