Skip to main content
Version: 2.6.0

Service Protection Based on PromQL Query

Configuration​

Blueprint name: policies/service-protection/promql

Parameters​

policy​

Parameterpolicy.components
DescriptionList of additional circuit components.
TypeArray of Object (aperture.spec.v1.Component)
Default Value
Expand
[]
Parameterpolicy.evaluation_interval
DescriptionThe interval between successive evaluations of the Circuit.
Typestring
Default Value10s
Parameterpolicy.policy_name
DescriptionName of the policy.
Typestring
Default Value__REQUIRED_FIELD__
Parameterpolicy.promql_query
DescriptionPromQL query.
Typestring
Default Value__REQUIRED_FIELD__
Parameterpolicy.resources
DescriptionAdditional resources.
TypeObject (aperture.spec.v1.Resources)
Default Value
Expand
flow_control:
  classifiers: []
Parameterpolicy.setpoint
DescriptionSetpoint.
TypeNumber (double)
Default Value__REQUIRED_FIELD__
policy.service_protection_core​
Parameterpolicy.service_protection_core.adaptive_load_scheduler
DescriptionParameters for Adaptive Load Scheduler.
TypeObject (aperture.spec.v1.AdaptiveLoadSchedulerParameters)
Default Value
Expand
alerter:
  alert_name: Load Throttling Event
gradient:
  max_gradient: 1
  min_gradient: 0.1
  slope: -1
load_multiplier_linear_increment: 0.025
load_scheduler:
  selectors:
    - control_point: __REQUIRED_FIELD__
      service: __REQUIRED_FIELD__
max_load_multiplier: 2
Parameterpolicy.service_protection_core.dry_run
DescriptionDefault configuration for setting dry run mode on Load Scheduler. In dry run mode, the Load Scheduler acts as a passthrough and does not throttle flows. This config can be updated at runtime without restarting the policy.
TypeBoolean
Default Valuefalse
Parameterpolicy.service_protection_core.overload_confirmations
DescriptionList of overload confirmation criteria. Load scheduler can throttle flows when all of the specified overload confirmation criteria are met.
TypeArray of Object (overload_confirmation)
Default Value
Expand
[]

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 Value5s
Parameterdashboard.time_from
DescriptionTime from of dashboard.
Typestring
Default Valuenow-15m
Parameterdashboard.time_to
DescriptionTime to of dashboard.
Typestring
Default Valuenow
Parameterdashboard.title
DescriptionName of the main dashboard.
Typestring
Default ValueAperture Service Protection
dashboard.datasource​
Parameterdashboard.datasource.filter_regex
DescriptionDatasource filter regex.
Typestring
Default Value
Parameterdashboard.datasource.name
DescriptionDatasource name.
Typestring
Default Value$datasource

Schemas​

overload_confirmation​

Parameteroperator
DescriptionThe operator for the overload confirmation criteria. oneof: `gt | lt | gte | lte | eq | neq`
Typestring
Default Value
Parameterquery_string
DescriptionThe Prometheus query to be run. Must return a scalar or a vector with a single element.
Typestring
Default Value
Parameterthreshold
DescriptionThe threshold for the overload confirmation criteria.
TypeNumber (double)
Default Value

Dynamic Configuration​

note

The following configuration parameters can be dynamically configured at runtime, without reloading the policy.

Parameters​

Parameterdry_run
DescriptionDynamic configuration for setting dry run mode at runtime without restarting this policy. In dry run mode the scheduler acts as pass through to all flow and does not queue flows. It is useful for observing the behavior of load scheduler without disrupting any real traffic.
TypeBoolean
Default Value__REQUIRED_FIELD__