languagev1

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 31, 2022 License: AGPL-3.0 Imports: 23 Imported by: 0

Documentation

Overview

Package languagev1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_aperture_policy_language_v1_classifier_proto protoreflect.FileDescriptor
View Source 
var File_aperture_policy_language_v1_fluxmeter_proto protoreflect.FileDescriptor
View Source 
var File_aperture_policy_language_v1_policy_proto protoreflect.FileDescriptor
View Source 
var PolicyService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aperture.policy.language.v1.PolicyService",
	HandlerType: (*PolicyServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AllPolicies",
			Handler:    _PolicyService_AllPolicies_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "aperture/policy/language/v1/policy.proto",
}

PolicyService_ServiceDesc is the grpc.ServiceDesc for PolicyService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPolicyServiceHandler 

func RegisterPolicyServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterPolicyServiceHandler registers the http handlers for service PolicyService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterPolicyServiceHandlerClient 

func RegisterPolicyServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client PolicyServiceClient) error

RegisterPolicyServiceHandlerClient registers the http handlers for service PolicyService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "PolicyServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "PolicyServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "PolicyServiceClient" to call the correct interceptors.

func RegisterPolicyServiceHandlerFromEndpoint 

func RegisterPolicyServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterPolicyServiceHandlerFromEndpoint is same as RegisterPolicyServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterPolicyServiceHandlerServer 

func RegisterPolicyServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server PolicyServiceServer) error

RegisterPolicyServiceHandlerServer registers the http handlers for service PolicyService to "mux". UnaryRPC :call PolicyServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterPolicyServiceHandlerFromEndpoint instead.

func RegisterPolicyServiceServer 

func RegisterPolicyServiceServer(s grpc.ServiceRegistrar, srv PolicyServiceServer)

Types

type AddressExtractor 

type AddressExtractor struct {

	// Attribute path pointing to some string - eg. "source.address".
	From string `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty" validate:"required"` //@gotags: validate:"required"
	// contains filtered or unexported fields
}

Display an [Address]ext-authz-address as a single string, eg. `<ip>:<port>`

IP addresses in attribute context are defined as objects with separate ip and port fields. This is a helper to display an address as a single string.

Note: Use with care, as it might accidentally introduce a high-cardinality flow label values.

Example: ```yaml from: "source.address # or dstination.address" ```

func (*AddressExtractor) Descriptor deprecated 

func (*AddressExtractor) Descriptor() ([]byte, []int)

Deprecated: Use AddressExtractor.ProtoReflect.Descriptor instead.

func (*AddressExtractor) GetFrom 

func (x *AddressExtractor) GetFrom() string

func (*AddressExtractor) MarshalJSON 

func (msg *AddressExtractor) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*AddressExtractor) ProtoMessage 

func (*AddressExtractor) ProtoMessage()

func (*AddressExtractor) ProtoReflect 

func (x *AddressExtractor) ProtoReflect() protoreflect.Message

func (*AddressExtractor) Reset 

func (x *AddressExtractor) Reset()

func (*AddressExtractor) String 

func (x *AddressExtractor) String() string

func (*AddressExtractor) UnmarshalJSON 

func (msg *AddressExtractor) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type AllPolicies 

type AllPolicies struct {
	AllPolicies map[string]*Policy `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AllPolicies) Descriptor deprecated 

func (*AllPolicies) Descriptor() ([]byte, []int)

Deprecated: Use AllPolicies.ProtoReflect.Descriptor instead.

func (*AllPolicies) GetAllPolicies 

func (x *AllPolicies) GetAllPolicies() map[string]*Policy

func (*AllPolicies) MarshalJSON 

func (msg *AllPolicies) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*AllPolicies) ProtoMessage 

func (*AllPolicies) ProtoMessage()

func (*AllPolicies) ProtoReflect 

func (x *AllPolicies) ProtoReflect() protoreflect.Message

func (*AllPolicies) Reset 

func (x *AllPolicies) Reset()

func (*AllPolicies) String 

func (x *AllPolicies) String() string

func (*AllPolicies) UnmarshalJSON 

func (msg *AllPolicies) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type AllPoliciesResponse 

type AllPoliciesResponse struct {
	AllPolicies *AllPolicies `protobuf:"bytes,1,opt,name=all_policies,json=allPolicies,proto3" json:"all_policies,omitempty"`
	// contains filtered or unexported fields
}

func (*AllPoliciesResponse) Descriptor deprecated 

func (*AllPoliciesResponse) Descriptor() ([]byte, []int)

Deprecated: Use AllPoliciesResponse.ProtoReflect.Descriptor instead.

func (*AllPoliciesResponse) GetAllPolicies 

func (x *AllPoliciesResponse) GetAllPolicies() *AllPolicies

func (*AllPoliciesResponse) MarshalJSON 

func (msg *AllPoliciesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*AllPoliciesResponse) ProtoMessage 

func (*AllPoliciesResponse) ProtoMessage()

func (*AllPoliciesResponse) ProtoReflect 

func (x *AllPoliciesResponse) ProtoReflect() protoreflect.Message

func (*AllPoliciesResponse) Reset 

func (x *AllPoliciesResponse) Reset()

func (*AllPoliciesResponse) String 

func (x *AllPoliciesResponse) String() string

func (*AllPoliciesResponse) UnmarshalJSON 

func (msg *AllPoliciesResponse) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type ArithmeticCombinator 

type ArithmeticCombinator struct {

	// Input ports for the Arithmetic Combinator component.
	InPorts *ArithmeticCombinator_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the Arithmetic Combinator component.
	OutPorts *ArithmeticCombinator_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Operator of the arithmetic operation.
	//
	// The arithmetic operation can be addition, subtraction, multiplication, division, XOR, right bit shift or left bit shift.
	// In case of XOR and bitshifts, value of signals is cast to integers before performing the operation.
	Operator string `protobuf:"bytes,3,opt,name=operator,proto3" json:"operator,omitempty" validate:"oneof=add sub mul div xor lshift rshift"` // @gotags: validate:"oneof=add sub mul div xor lshift rshift"
	// contains filtered or unexported fields
}

Type of combinator that computes the arithmetic operation on the operand signals

func (*ArithmeticCombinator) Descriptor deprecated 

func (*ArithmeticCombinator) Descriptor() ([]byte, []int)

Deprecated: Use ArithmeticCombinator.ProtoReflect.Descriptor instead.

func (*ArithmeticCombinator) GetInPorts 

func (x *ArithmeticCombinator) GetInPorts() *ArithmeticCombinator_Ins

func (*ArithmeticCombinator) GetOperator 

func (x *ArithmeticCombinator) GetOperator() string

func (*ArithmeticCombinator) GetOutPorts 

func (x *ArithmeticCombinator) GetOutPorts() *ArithmeticCombinator_Outs

func (*ArithmeticCombinator) MarshalJSON 

func (msg *ArithmeticCombinator) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*ArithmeticCombinator) ProtoMessage 

func (*ArithmeticCombinator) ProtoMessage()

func (*ArithmeticCombinator) ProtoReflect 

func (x *ArithmeticCombinator) ProtoReflect() protoreflect.Message

func (*ArithmeticCombinator) Reset 

func (x *ArithmeticCombinator) Reset()

func (*ArithmeticCombinator) String 

func (x *ArithmeticCombinator) String() string

func (*ArithmeticCombinator) UnmarshalJSON 

func (msg *ArithmeticCombinator) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type ArithmeticCombinator_Ins 

type ArithmeticCombinator_Ins struct {

	// Left hand side of the arithmetic operation.
	Lhs *Port `protobuf:"bytes,1,opt,name=lhs,proto3" json:"lhs,omitempty"`
	// Right hand side of the arithmetic operation.
	Rhs *Port `protobuf:"bytes,2,opt,name=rhs,proto3" json:"rhs,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Arithmetic Combinator component.

func (*ArithmeticCombinator_Ins) Descriptor deprecated 

func (*ArithmeticCombinator_Ins) Descriptor() ([]byte, []int)

Deprecated: Use ArithmeticCombinator_Ins.ProtoReflect.Descriptor instead.

func (*ArithmeticCombinator_Ins) GetLhs 

func (x *ArithmeticCombinator_Ins) GetLhs() *Port

func (*ArithmeticCombinator_Ins) GetRhs 

func (x *ArithmeticCombinator_Ins) GetRhs() *Port

func (*ArithmeticCombinator_Ins) MarshalJSON 

func (msg *ArithmeticCombinator_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*ArithmeticCombinator_Ins) ProtoMessage 

func (*ArithmeticCombinator_Ins) ProtoMessage()

func (*ArithmeticCombinator_Ins) ProtoReflect 

func (x *ArithmeticCombinator_Ins) ProtoReflect() protoreflect.Message

func (*ArithmeticCombinator_Ins) Reset 

func (x *ArithmeticCombinator_Ins) Reset()

func (*ArithmeticCombinator_Ins) String 

func (x *ArithmeticCombinator_Ins) String() string

func (*ArithmeticCombinator_Ins) UnmarshalJSON 

func (msg *ArithmeticCombinator_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type ArithmeticCombinator_Outs 

type ArithmeticCombinator_Outs struct {

	// Result of arithmetic operation.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the Arithmetic Combinator component.

func (*ArithmeticCombinator_Outs) Descriptor deprecated 

func (*ArithmeticCombinator_Outs) Descriptor() ([]byte, []int)

Deprecated: Use ArithmeticCombinator_Outs.ProtoReflect.Descriptor instead.

func (*ArithmeticCombinator_Outs) GetOutput 

func (x *ArithmeticCombinator_Outs) GetOutput() *Port

func (*ArithmeticCombinator_Outs) MarshalJSON 

func (msg *ArithmeticCombinator_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*ArithmeticCombinator_Outs) ProtoMessage 

func (*ArithmeticCombinator_Outs) ProtoMessage()

func (*ArithmeticCombinator_Outs) ProtoReflect 

func (x *ArithmeticCombinator_Outs) ProtoReflect() protoreflect.Message

func (*ArithmeticCombinator_Outs) Reset 

func (x *ArithmeticCombinator_Outs) Reset()

func (*ArithmeticCombinator_Outs) String 

func (x *ArithmeticCombinator_Outs) String() string

func (*ArithmeticCombinator_Outs) UnmarshalJSON 

func (msg *ArithmeticCombinator_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Circuit 

type Circuit struct {

	// Evaluation interval (tick) is the time period between consecutive runs of the policy circuit.
	// This interval is typically aligned with how often the corrective action (actuation) needs to be taken.
	EvaluationInterval *durationpb.Duration `` // @gotags: default:"0.5s"
	/* 130-byte string literal not displayed */
	// Defines a signal processing graph as a list of components.
	Components []*Component `protobuf:"bytes,2,rep,name=components,proto3" json:"components,omitempty"`
	// contains filtered or unexported fields
}

Circuit is defined as a dataflow graph of inter-connected components

Signals flow between components via ports. As signals traverse the circuit, they get processed, stored within components or get acted upon (e.g. load shed, rate-limit, auto-scale etc.). Circuit evaluated periodically in order to respond to changes in signal readings.

:::info **Signal**

Signals are floating-point values.

A signal also have a special **Invalid** value. It's usually used to communicate that signal doesn't have a meaningful value at the moment, eg. PromQL(#-v1promql) emits such a value if it cannot execute a query. Components know when their input signals are invalid and can act accordingly. They can either propagate the invalidness, by making their output itself invalid (like eg. ArithmeticCombinator(#-v1arithmeticcombinator)) or use some different logic, like eg. Extrapolator(#-v1extrapolator). Refer to a component's docs on how exactly it handles invalid inputs. :::

func (*Circuit) Descriptor deprecated 

func (*Circuit) Descriptor() ([]byte, []int)

Deprecated: Use Circuit.ProtoReflect.Descriptor instead.

func (*Circuit) GetComponents 

func (x *Circuit) GetComponents() []*Component

func (*Circuit) GetEvaluationInterval 

func (x *Circuit) GetEvaluationInterval() *durationpb.Duration

func (*Circuit) MarshalJSON 

func (msg *Circuit) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Circuit) ProtoMessage 

func (*Circuit) ProtoMessage()

func (*Circuit) ProtoReflect 

func (x *Circuit) ProtoReflect() protoreflect.Message

func (*Circuit) Reset 

func (x *Circuit) Reset()

func (*Circuit) String 

func (x *Circuit) String() string

func (*Circuit) UnmarshalJSON 

func (msg *Circuit) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Classifier 

type Classifier struct {

	// Defines where to apply the flow classification rule.
	Selector *v1.Selector `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"`
	// A map of {key, value} pairs mapping from flow label names to rules that define how to extract and propagate them.
	Rules map[string]*Rule `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

Set of classification rules sharing a common selector

Example: ```yaml selector: 

service: service1.default.svc.cluster.local
control_point:
  traffic: ingress

rules: 

user:
  extractor:
    from: request.http.headers.user

```

func (*Classifier) Descriptor deprecated 

func (*Classifier) Descriptor() ([]byte, []int)

Deprecated: Use Classifier.ProtoReflect.Descriptor instead.

func (*Classifier) GetRules 

func (x *Classifier) GetRules() map[string]*Rule

func (*Classifier) GetSelector 

func (x *Classifier) GetSelector() *v1.Selector

func (*Classifier) MarshalJSON 

func (msg *Classifier) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Classifier) ProtoMessage 

func (*Classifier) ProtoMessage()

func (*Classifier) ProtoReflect 

func (x *Classifier) ProtoReflect() protoreflect.Message

func (*Classifier) Reset 

func (x *Classifier) Reset()

func (*Classifier) String 

func (x *Classifier) String() string

func (*Classifier) UnmarshalJSON 

func (msg *Classifier) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Component 

type Component struct {

	// Types that are assignable to Component:
	//	*Component_GradientController
	//	*Component_Ema
	//	*Component_ArithmeticCombinator
	//	*Component_Decider
	//	*Component_ConcurrencyLimiter
	//	*Component_RateLimiter
	//	*Component_Promql
	//	*Component_Constant
	//	*Component_Sqrt
	//	*Component_Extrapolator
	//	*Component_Max
	//	*Component_Min
	Component isComponent_Component `protobuf_oneof:"component"`
	// contains filtered or unexported fields
}

Computational block that form the circuit

Signals flow into the components via input ports and results are emitted on output ports. Components are wired to each other based on signal names forming an execution graph of the circuit.

:::note Loops are broken by the runtime at the earliest component index that is part of the loop. The looped signals are saved in the tick they are generated and served in the subsequent tick. :::

There are three categories of components:

  • "source" components – they take some sort of input from "the real world" and output a signal based on this input. Example: PromQL(#-v1promql). In the UI they're represented by green color.
  • internal components – "pure" components that don't interact with the "real world". Examples: GradientController(#-v1gradientcontroller), Max(#-v1max). :::note Internal components's output can depend on their internal state, in addition to the inputs. Eg. see the [Exponential Moving Average filter](#-v1ema). :::
  • "sink" components – they affect the real world. ConcurrencyLimiter(#-languagev1concurrencylimiter) and RateLimiter(#-languagev1ratelimiter). Also sometimes called [_actuators_](/concepts/flow-control/actuators/actuators.md). In the UI, represented by orange color. Sink components are usually also "sources" too, they usually emit a feedback signal, like `accepted_concurrency` in case of ConcurrencyLimiter.

:::tip Sometimes you may want to use a constant value as one of component's inputs. You can use the Constant(#-constant) component for this. :::

See also Policy(#-v1policy) for a higher-level explanation of circuits.

func (*Component) Descriptor deprecated 

func (*Component) Descriptor() ([]byte, []int)

Deprecated: Use Component.ProtoReflect.Descriptor instead.

func (*Component) GetArithmeticCombinator 

func (x *Component) GetArithmeticCombinator() *ArithmeticCombinator

func (*Component) GetComponent 

func (m *Component) GetComponent() isComponent_Component

func (*Component) GetConcurrencyLimiter 

func (x *Component) GetConcurrencyLimiter() *ConcurrencyLimiter

func (*Component) GetConstant 

func (x *Component) GetConstant() *Constant

func (*Component) GetDecider 

func (x *Component) GetDecider() *Decider

func (*Component) GetEma 

func (x *Component) GetEma() *EMA

func (*Component) GetExtrapolator 

func (x *Component) GetExtrapolator() *Extrapolator

func (*Component) GetGradientController 

func (x *Component) GetGradientController() *GradientController

func (*Component) GetMax 

func (x *Component) GetMax() *Max

func (*Component) GetMin 

func (x *Component) GetMin() *Min

func (*Component) GetPromql 

func (x *Component) GetPromql() *PromQL

func (*Component) GetRateLimiter 

func (x *Component) GetRateLimiter() *RateLimiter

func (*Component) GetSqrt 

func (x *Component) GetSqrt() *Sqrt

func (*Component) MarshalJSON 

func (msg *Component) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Component) ProtoMessage 

func (*Component) ProtoMessage()

func (*Component) ProtoReflect 

func (x *Component) ProtoReflect() protoreflect.Message

func (*Component) Reset 

func (x *Component) Reset()

func (*Component) String 

func (x *Component) String() string

func (*Component) UnmarshalJSON 

func (msg *Component) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Component_ArithmeticCombinator 

type Component_ArithmeticCombinator struct {
	// Applies the given operator on input operands (signals) and emits the result.
	ArithmeticCombinator *ArithmeticCombinator `protobuf:"bytes,3,opt,name=arithmetic_combinator,json=arithmeticCombinator,proto3,oneof"`
}

type Component_ConcurrencyLimiter 

type Component_ConcurrencyLimiter struct {
	// Concurrency Limiter provides service protection by applying prioritized load shedding of flows using a network scheduler (e.g. Weighted Fair Queuing).
	ConcurrencyLimiter *ConcurrencyLimiter `protobuf:"bytes,5,opt,name=concurrency_limiter,json=concurrencyLimiter,proto3,oneof"`
}

type Component_Constant 

type Component_Constant struct {
	// Emits a constant signal.
	Constant *Constant `protobuf:"bytes,8,opt,name=constant,proto3,oneof"`
}

type Component_Decider 

type Component_Decider struct {
	// Decider acts as a switch that emits one of the two signals based on the binary result of comparison operator on two operands.
	Decider *Decider `protobuf:"bytes,4,opt,name=decider,proto3,oneof"`
}

type Component_Ema 

type Component_Ema struct {
	// Exponential Moving Average filter.
	Ema *EMA `protobuf:"bytes,2,opt,name=ema,proto3,oneof"`
}

type Component_Extrapolator 

type Component_Extrapolator struct {
	// Takes an input signal and emits the extrapolated value; either mirroring the input value or repeating the last known value up to the maximum extrapolation interval.
	Extrapolator *Extrapolator `protobuf:"bytes,10,opt,name=extrapolator,proto3,oneof"`
}

type Component_GradientController 

type Component_GradientController struct {
	// Gradient controller basically calculates the ratio between the signal and the setpoint to determine the magnitude of the correction that need to be applied.
	// This controller can be used to build AIMD (Additive Increase, Multiplicative Decrease) or MIMD style response.
	GradientController *GradientController `protobuf:"bytes,1,opt,name=gradient_controller,json=gradientController,proto3,oneof"`
}

type Component_Max 

type Component_Max struct {
	// Emits the maximum of the input siganls.
	Max *Max `protobuf:"bytes,11,opt,name=max,proto3,oneof"`
}

type Component_Min 

type Component_Min struct {
	// Emits the minimum of the input signals.
	Min *Min `protobuf:"bytes,12,opt,name=min,proto3,oneof"`
}

type Component_Promql 

type Component_Promql struct {
	// Periodically runs a Prometheus query in the background and emits the result.
	Promql *PromQL `protobuf:"bytes,7,opt,name=promql,proto3,oneof"`
}

type Component_RateLimiter 

type Component_RateLimiter struct {
	// Rate Limiter provides service protection by applying rate limiter.
	RateLimiter *RateLimiter `protobuf:"bytes,6,opt,name=rate_limiter,json=rateLimiter,proto3,oneof"`
}

type Component_Sqrt 

type Component_Sqrt struct {
	// Takes an input signal and emits the square root of the input signal.
	Sqrt *Sqrt `protobuf:"bytes,9,opt,name=sqrt,proto3,oneof"`
}

type ConcurrencyLimiter 

type ConcurrencyLimiter struct {

	// Configuration of Weighted Fair Queuing-based workload scheduler.
	//
	// Contains configuration of per-agent scheduler, and also defines some
	// output signals.
	Scheduler *Scheduler `protobuf:"bytes,1,opt,name=scheduler,proto3" json:"scheduler,omitempty" validate:"required"` // @gotags: validate:"required"
	// Types that are assignable to ActuationStrategy:
	//	*ConcurrencyLimiter_LoadShedActuator
	ActuationStrategy isConcurrencyLimiter_ActuationStrategy `protobuf_oneof:"actuation_strategy"`
	// contains filtered or unexported fields
}

Concurrency Limiter is an actuator component that regulates flows in order to provide active service protection

:::info See also [Scheduler page in the Concepts section](/concepts/flow-control/actuators/scheduler.md) for a more high-level description. :::

It is based on the actuation strategy (e.g. load shed) and workload scheduling which is based on Weighted Fair Queuing principles. Concurrency is calculated in terms of total tokens which translate to (avg. latency \* inflight requests), i.e. Little's Law.

ConcurrencyLimiter configuration is split into two parts: An actuation strategy and a scheduler. Right now, only `load_shed_actuator` strategy is available.

func (*ConcurrencyLimiter) Descriptor deprecated 

func (*ConcurrencyLimiter) Descriptor() ([]byte, []int)

Deprecated: Use ConcurrencyLimiter.ProtoReflect.Descriptor instead.

func (*ConcurrencyLimiter) GetActuationStrategy 

func (m *ConcurrencyLimiter) GetActuationStrategy() isConcurrencyLimiter_ActuationStrategy

func (*ConcurrencyLimiter) GetLoadShedActuator 

func (x *ConcurrencyLimiter) GetLoadShedActuator() *LoadShedActuator

func (*ConcurrencyLimiter) GetScheduler 

func (x *ConcurrencyLimiter) GetScheduler() *Scheduler

func (*ConcurrencyLimiter) MarshalJSON 

func (msg *ConcurrencyLimiter) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*ConcurrencyLimiter) ProtoMessage 

func (*ConcurrencyLimiter) ProtoMessage()

func (*ConcurrencyLimiter) ProtoReflect 

func (x *ConcurrencyLimiter) ProtoReflect() protoreflect.Message

func (*ConcurrencyLimiter) Reset 

func (x *ConcurrencyLimiter) Reset()

func (*ConcurrencyLimiter) String 

func (x *ConcurrencyLimiter) String() string

func (*ConcurrencyLimiter) UnmarshalJSON 

func (msg *ConcurrencyLimiter) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type ConcurrencyLimiter_LoadShedActuator 

type ConcurrencyLimiter_LoadShedActuator struct {
	// Actuator based on load shedding a portion of requests.
	//
	// Actuation strategy defines the input signal that will drive the scheduler.
	LoadShedActuator *LoadShedActuator `protobuf:"bytes,2,opt,name=load_shed_actuator,json=loadShedActuator,proto3,oneof"`
}

type Constant 

type Constant struct {

	// Output ports for the Constant component.
	OutPorts *Constant_Outs `protobuf:"bytes,1,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// The constant value to be emitted.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Component that emits a constant value as an output signal

func (*Constant) Descriptor deprecated 

func (*Constant) Descriptor() ([]byte, []int)

Deprecated: Use Constant.ProtoReflect.Descriptor instead.

func (*Constant) GetOutPorts 

func (x *Constant) GetOutPorts() *Constant_Outs

func (*Constant) GetValue 

func (x *Constant) GetValue() float64

func (*Constant) MarshalJSON 

func (msg *Constant) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Constant) ProtoMessage 

func (*Constant) ProtoMessage()

func (*Constant) ProtoReflect 

func (x *Constant) ProtoReflect() protoreflect.Message

func (*Constant) Reset 

func (x *Constant) Reset()

func (*Constant) String 

func (x *Constant) String() string

func (*Constant) UnmarshalJSON 

func (msg *Constant) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Constant_Outs 

type Constant_Outs struct {

	// The constant value is emitted to the output port.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the Constant component.

func (*Constant_Outs) Descriptor deprecated 

func (*Constant_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Constant_Outs.ProtoReflect.Descriptor instead.

func (*Constant_Outs) GetOutput 

func (x *Constant_Outs) GetOutput() *Port

func (*Constant_Outs) MarshalJSON 

func (msg *Constant_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Constant_Outs) ProtoMessage 

func (*Constant_Outs) ProtoMessage()

func (*Constant_Outs) ProtoReflect 

func (x *Constant_Outs) ProtoReflect() protoreflect.Message

func (*Constant_Outs) Reset 

func (x *Constant_Outs) Reset()

func (*Constant_Outs) String 

func (x *Constant_Outs) String() string

func (*Constant_Outs) UnmarshalJSON 

func (msg *Constant_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Decider 

type Decider struct {

	// Input ports for the Decider component.
	InPorts *Decider_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the Decider component.
	OutPorts *Decider_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Comparison operator that computes operation on lhs and rhs input signals.
	Operator string `protobuf:"bytes,3,opt,name=operator,proto3" json:"operator,omitempty" validate:"oneof=gt lt gte lte eq neq"` // @gotags: validate:"oneof=gt lt gte lte eq neq"
	// Duration of time to wait before a transition to true state.
	// If the duration is zero, the transition will happen instantaneously.
	TrueFor *durationpb.Duration `protobuf:"bytes,4,opt,name=true_for,json=trueFor,proto3" json:"true_for,omitempty" default:"0s"` // @gotags: default:"0s"
	// Duration of time to wait before a transition to false state.
	// If the duration is zero, the transition will happen instantaneously.
	FalseFor *durationpb.Duration `protobuf:"bytes,5,opt,name=false_for,json=falseFor,proto3" json:"false_for,omitempty" default:"0s"` // @gotags: default:"0s"
	// contains filtered or unexported fields
}

Type of combinator that computes the comparison operation on lhs and rhs signals and switches between `on_true` and `on_false` signals based on the result of the comparison

The comparison operator can be greater-than, less-than, greater-than-or-equal, less-than-or-equal, equal, or not-equal.

This component also supports time-based response, i.e. the output transitions between on_true or on_false signal if the decider condition is true or false for at least "positive_for" or "negative_for" duration. If `true_for` and `false_for` durations are zero then the transitions are instantaneous.

func (*Decider) Descriptor deprecated 

func (*Decider) Descriptor() ([]byte, []int)

Deprecated: Use Decider.ProtoReflect.Descriptor instead.

func (*Decider) GetFalseFor 

func (x *Decider) GetFalseFor() *durationpb.Duration

func (*Decider) GetInPorts 

func (x *Decider) GetInPorts() *Decider_Ins

func (*Decider) GetOperator 

func (x *Decider) GetOperator() string

func (*Decider) GetOutPorts 

func (x *Decider) GetOutPorts() *Decider_Outs

func (*Decider) GetTrueFor 

func (x *Decider) GetTrueFor() *durationpb.Duration

func (*Decider) MarshalJSON 

func (msg *Decider) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Decider) ProtoMessage 

func (*Decider) ProtoMessage()

func (*Decider) ProtoReflect 

func (x *Decider) ProtoReflect() protoreflect.Message

func (*Decider) Reset 

func (x *Decider) Reset()

func (*Decider) String 

func (x *Decider) String() string

func (*Decider) UnmarshalJSON 

func (msg *Decider) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Decider_Ins 

type Decider_Ins struct {

	// Left hand side input signal for the comparison operation.
	Lhs *Port `protobuf:"bytes,1,opt,name=lhs,proto3" json:"lhs,omitempty"`
	// Right hand side input signal for the comparison operation.
	Rhs *Port `protobuf:"bytes,2,opt,name=rhs,proto3" json:"rhs,omitempty"`
	// Output signal when the result of the operation is true.
	OnTrue *Port `protobuf:"bytes,3,opt,name=on_true,json=onTrue,proto3" json:"on_true,omitempty"`
	// Output signal when the result of the operation is false.
	OnFalse *Port `protobuf:"bytes,4,opt,name=on_false,json=onFalse,proto3" json:"on_false,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Decider component.

func (*Decider_Ins) Descriptor deprecated 

func (*Decider_Ins) Descriptor() ([]byte, []int)

Deprecated: Use Decider_Ins.ProtoReflect.Descriptor instead.

func (*Decider_Ins) GetLhs 

func (x *Decider_Ins) GetLhs() *Port

func (*Decider_Ins) GetOnFalse 

func (x *Decider_Ins) GetOnFalse() *Port

func (*Decider_Ins) GetOnTrue 

func (x *Decider_Ins) GetOnTrue() *Port

func (*Decider_Ins) GetRhs 

func (x *Decider_Ins) GetRhs() *Port

func (*Decider_Ins) MarshalJSON 

func (msg *Decider_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Decider_Ins) ProtoMessage 

func (*Decider_Ins) ProtoMessage()

func (*Decider_Ins) ProtoReflect 

func (x *Decider_Ins) ProtoReflect() protoreflect.Message

func (*Decider_Ins) Reset 

func (x *Decider_Ins) Reset()

func (*Decider_Ins) String 

func (x *Decider_Ins) String() string

func (*Decider_Ins) UnmarshalJSON 

func (msg *Decider_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Decider_Outs 

type Decider_Outs struct {

	// Selected signal (on_true or on_false).
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the Decider component.

func (*Decider_Outs) Descriptor deprecated 

func (*Decider_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Decider_Outs.ProtoReflect.Descriptor instead.

func (*Decider_Outs) GetOutput 

func (x *Decider_Outs) GetOutput() *Port

func (*Decider_Outs) MarshalJSON 

func (msg *Decider_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Decider_Outs) ProtoMessage 

func (*Decider_Outs) ProtoMessage()

func (*Decider_Outs) ProtoReflect 

func (x *Decider_Outs) ProtoReflect() protoreflect.Message

func (*Decider_Outs) Reset 

func (x *Decider_Outs) Reset()

func (*Decider_Outs) String 

func (x *Decider_Outs) String() string

func (*Decider_Outs) UnmarshalJSON 

func (msg *Decider_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type EMA 

type EMA struct {

	// Input ports for the EMA component.
	InPorts *EMA_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the EMA component.
	OutPorts *EMA_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Duration of EMA sampling window.
	EmaWindow *durationpb.Duration `protobuf:"bytes,3,opt,name=ema_window,json=emaWindow,proto3" json:"ema_window,omitempty" default:"5s"` // @gotags: default:"5s"
	// Duration of EMA warming up window.
	//
	// The initial value of the EMA is the average of signal readings received during the warm up window.
	WarmUpWindow *durationpb.Duration `protobuf:"bytes,4,opt,name=warm_up_window,json=warmUpWindow,proto3" json:"warm_up_window,omitempty" default:"0s"` // @gotags: default:"0s"
	// Correction factor to apply on the output value if its in violation of the min envelope.
	CorrectionFactorOnMinEnvelopeViolation float64 `` // @gotags: validate:"gte=1.0" default:"1.0"
	/* 218-byte string literal not displayed */
	// Correction factor to apply on the output value if its in violation of the max envelope.
	CorrectionFactorOnMaxEnvelopeViolation float64 `` // @gotags: validate:"gte=0,lte=1.0" default:"1.0"
	/* 224-byte string literal not displayed */
	// contains filtered or unexported fields
}

Exponential Moving Average (EMA) is a type of moving average that applies exponenially more weight to recent signal readings

At any time EMA component operates in one of the following states:

  1. Warm up state: The first warm_up_window samples are used to compute the initial EMA. If an invalid reading is received during the warm_up_window, the last good average is emitted and the state gets reset back to beginning of Warm up state.
  2. Normal state: The EMA is computed using following formula.

The EMA for a series $Y$ is calculated recursively as:

$$ \text{EMA} _t = \begin{cases} 

Y_0, &\text{for } t = 0 \\
\alpha Y_t + (1 - \alpha) \text{EMA} _{t-1}, &\text{for }t > 0

\end{cases} $$

The coefficient $\alpha$ represents the degree of weighting decrease, a constant smoothing factor between 0 and 1. A higher $\alpha$ discounts older observations faster. The $\alpha$ is computed using ema\_window:

$$ \alpha = \frac{2}{N + 1} \quad\text{where } N = \frac{\text{ema\_window}}{\text{evalutation\_period}} $$

The EMA filter also employs a min-max-envolope logic during warm up stage, explained [here](#-v1emains).

func (*EMA) Descriptor deprecated 

func (*EMA) Descriptor() ([]byte, []int)

Deprecated: Use EMA.ProtoReflect.Descriptor instead.

func (*EMA) GetCorrectionFactorOnMaxEnvelopeViolation 

func (x *EMA) GetCorrectionFactorOnMaxEnvelopeViolation() float64

func (*EMA) GetCorrectionFactorOnMinEnvelopeViolation 

func (x *EMA) GetCorrectionFactorOnMinEnvelopeViolation() float64

func (*EMA) GetEmaWindow 

func (x *EMA) GetEmaWindow() *durationpb.Duration

func (*EMA) GetInPorts 

func (x *EMA) GetInPorts() *EMA_Ins

func (*EMA) GetOutPorts 

func (x *EMA) GetOutPorts() *EMA_Outs

func (*EMA) GetWarmUpWindow 

func (x *EMA) GetWarmUpWindow() *durationpb.Duration

func (*EMA) MarshalJSON 

func (msg *EMA) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*EMA) ProtoMessage 

func (*EMA) ProtoMessage()

func (*EMA) ProtoReflect 

func (x *EMA) ProtoReflect() protoreflect.Message

func (*EMA) Reset 

func (x *EMA) Reset()

func (*EMA) String 

func (x *EMA) String() string

func (*EMA) UnmarshalJSON 

func (msg *EMA) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type EMA_Ins 

type EMA_Ins struct {

	// Input signal to be used for the EMA computation.
	Input *Port `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// Upper bound of the moving average.
	//
	// Used during the warm-up stage: if the signal would exceed `max_envelope`
	// it's multiplied by `correction_factor_on_max_envelope_violation` **once per tick**.
	//
	// :::note
	// If the signal deviates from `max_envelope` faster than the correction
	// faster, it might end up exceeding the envelope.
	// :::
	//
	// :::note
	// The envelope logic is **not** used outside the warm-up stage!
	// :::
	MaxEnvelope *Port `protobuf:"bytes,2,opt,name=max_envelope,json=maxEnvelope,proto3" json:"max_envelope,omitempty"`
	// Lower bound of the moving average.
	//
	// Used during the warm-up stage analoguously to `max_envelope`.
	MinEnvelope *Port `protobuf:"bytes,3,opt,name=min_envelope,json=minEnvelope,proto3" json:"min_envelope,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the EMA component.

func (*EMA_Ins) Descriptor deprecated 

func (*EMA_Ins) Descriptor() ([]byte, []int)

Deprecated: Use EMA_Ins.ProtoReflect.Descriptor instead.

func (*EMA_Ins) GetInput 

func (x *EMA_Ins) GetInput() *Port

func (*EMA_Ins) GetMaxEnvelope 

func (x *EMA_Ins) GetMaxEnvelope() *Port

func (*EMA_Ins) GetMinEnvelope 

func (x *EMA_Ins) GetMinEnvelope() *Port

func (*EMA_Ins) MarshalJSON 

func (msg *EMA_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*EMA_Ins) ProtoMessage 

func (*EMA_Ins) ProtoMessage()

func (*EMA_Ins) ProtoReflect 

func (x *EMA_Ins) ProtoReflect() protoreflect.Message

func (*EMA_Ins) Reset 

func (x *EMA_Ins) Reset()

func (*EMA_Ins) String 

func (x *EMA_Ins) String() string

func (*EMA_Ins) UnmarshalJSON 

func (msg *EMA_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type EMA_Outs 

type EMA_Outs struct {

	// Exponential moving average of the series of reading as an output signal.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the EMA component.

func (*EMA_Outs) Descriptor deprecated 

func (*EMA_Outs) Descriptor() ([]byte, []int)

Deprecated: Use EMA_Outs.ProtoReflect.Descriptor instead.

func (*EMA_Outs) GetOutput 

func (x *EMA_Outs) GetOutput() *Port

func (*EMA_Outs) MarshalJSON 

func (msg *EMA_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*EMA_Outs) ProtoMessage 

func (*EMA_Outs) ProtoMessage()

func (*EMA_Outs) ProtoReflect 

func (x *EMA_Outs) ProtoReflect() protoreflect.Message

func (*EMA_Outs) Reset 

func (x *EMA_Outs) Reset()

func (*EMA_Outs) String 

func (x *EMA_Outs) String() string

func (*EMA_Outs) UnmarshalJSON 

func (msg *EMA_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Extractor 

type Extractor struct {

	// Types that are assignable to Variant:
	//	*Extractor_From
	//	*Extractor_Json
	//	*Extractor_Address
	//	*Extractor_Jwt
	//	*Extractor_PathTemplates
	Variant isExtractor_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

Defines a high-level way to specify how to extract a flow label given http request metadata, without a need to write rego code

There are multiple variants of extractor, specify exactly one: - JSON Extractor - Address Extractor - JWT Extractor

func (*Extractor) Descriptor deprecated 

func (*Extractor) Descriptor() ([]byte, []int)

Deprecated: Use Extractor.ProtoReflect.Descriptor instead.

func (*Extractor) GetAddress 

func (x *Extractor) GetAddress() *AddressExtractor

func (*Extractor) GetFrom 

func (x *Extractor) GetFrom() string

func (*Extractor) GetJson 

func (x *Extractor) GetJson() *JSONExtractor

func (*Extractor) GetJwt 

func (x *Extractor) GetJwt() *JWTExtractor

func (*Extractor) GetPathTemplates 

func (x *Extractor) GetPathTemplates() *PathTemplateMatcher

func (*Extractor) GetVariant 

func (m *Extractor) GetVariant() isExtractor_Variant

func (*Extractor) MarshalJSON 

func (msg *Extractor) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Extractor) ProtoMessage 

func (*Extractor) ProtoMessage()

func (*Extractor) ProtoReflect 

func (x *Extractor) ProtoReflect() protoreflect.Message

func (*Extractor) Reset 

func (x *Extractor) Reset()

func (*Extractor) String 

func (x *Extractor) String() string

func (*Extractor) UnmarshalJSON 

func (msg *Extractor) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Extractor_Address 

type Extractor_Address struct {
	// Display an address as a single string - `<ip>:<port>`.
	Address *AddressExtractor `protobuf:"bytes,3,opt,name=address,proto3,oneof"`
}

type Extractor_From 

type Extractor_From struct {
	// Use an attribute with no convertion
	//
	// Attribute path is a dot-separated path to attribute.
	//
	// Should be either:
	// * one of the fields of [Attribute Context][attribute-context], or
	// * a special "request.http.bearer" pseudo-attribute.
	// Eg. "request.http.method" or "request.http.header.user-agent"
	//
	// Note: The same attribute path syntax is shared by other extractor variants,
	// wherever attribute path is needed in their "from" syntax.
	//
	// Example:
	// “`yaml
	// from: request.http.headers.user-agent
	// “`
	// [attribute-context]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/attribute_context.proto"
	From string `protobuf:"bytes,1,opt,name=from,proto3,oneof"`
}

type Extractor_Json 

type Extractor_Json struct {
	// Deserialize a json, and extract one of the fields.
	Json *JSONExtractor `protobuf:"bytes,2,opt,name=json,proto3,oneof"`
}

type Extractor_Jwt 

type Extractor_Jwt struct {
	// Parse the attribute as JWT and read the payload.
	Jwt *JWTExtractor `protobuf:"bytes,4,opt,name=jwt,proto3,oneof"`
}

type Extractor_PathTemplates 

type Extractor_PathTemplates struct {
	// Match HTTP Path to given path templates.
	PathTemplates *PathTemplateMatcher `protobuf:"bytes,5,opt,name=path_templates,json=pathTemplates,proto3,oneof"`
}

type Extrapolator 

type Extrapolator struct {

	// Input ports for the Extrapolator component.
	InPorts *Extrapolator_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the Extrapolator component.
	OutPorts *Extrapolator_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Maximum time interval to repeat the last valid value of input signal.
	MaxExtrapolationInterval *durationpb.Duration `` // @gotags: default:"10s"
	/* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Extrapolates the input signal by repeating the last valid value during the period in which it is invalid

It does so until `maximum_extrapolation_interval` is reached, beyond which it emits invalid signal unless input signal becomes valid again.

func (*Extrapolator) Descriptor deprecated 

func (*Extrapolator) Descriptor() ([]byte, []int)

Deprecated: Use Extrapolator.ProtoReflect.Descriptor instead.

func (*Extrapolator) GetInPorts 

func (x *Extrapolator) GetInPorts() *Extrapolator_Ins

func (*Extrapolator) GetMaxExtrapolationInterval 

func (x *Extrapolator) GetMaxExtrapolationInterval() *durationpb.Duration

func (*Extrapolator) GetOutPorts 

func (x *Extrapolator) GetOutPorts() *Extrapolator_Outs

func (*Extrapolator) MarshalJSON 

func (msg *Extrapolator) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Extrapolator) ProtoMessage 

func (*Extrapolator) ProtoMessage()

func (*Extrapolator) ProtoReflect 

func (x *Extrapolator) ProtoReflect() protoreflect.Message

func (*Extrapolator) Reset 

func (x *Extrapolator) Reset()

func (*Extrapolator) String 

func (x *Extrapolator) String() string

func (*Extrapolator) UnmarshalJSON 

func (msg *Extrapolator) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Extrapolator_Ins 

type Extrapolator_Ins struct {

	// Input signal for the Extrapolator component.
	Input *Port `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Extrapolator component.

func (*Extrapolator_Ins) Descriptor deprecated 

func (*Extrapolator_Ins) Descriptor() ([]byte, []int)

Deprecated: Use Extrapolator_Ins.ProtoReflect.Descriptor instead.

func (*Extrapolator_Ins) GetInput 

func (x *Extrapolator_Ins) GetInput() *Port

func (*Extrapolator_Ins) MarshalJSON 

func (msg *Extrapolator_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Extrapolator_Ins) ProtoMessage 

func (*Extrapolator_Ins) ProtoMessage()

func (*Extrapolator_Ins) ProtoReflect 

func (x *Extrapolator_Ins) ProtoReflect() protoreflect.Message

func (*Extrapolator_Ins) Reset 

func (x *Extrapolator_Ins) Reset()

func (*Extrapolator_Ins) String 

func (x *Extrapolator_Ins) String() string

func (*Extrapolator_Ins) UnmarshalJSON 

func (msg *Extrapolator_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Extrapolator_Outs 

type Extrapolator_Outs struct {

	// Extrapolated signal.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the Extrapolator component.

func (*Extrapolator_Outs) Descriptor deprecated 

func (*Extrapolator_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Extrapolator_Outs.ProtoReflect.Descriptor instead.

func (*Extrapolator_Outs) GetOutput 

func (x *Extrapolator_Outs) GetOutput() *Port

func (*Extrapolator_Outs) MarshalJSON 

func (msg *Extrapolator_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Extrapolator_Outs) ProtoMessage 

func (*Extrapolator_Outs) ProtoMessage()

func (*Extrapolator_Outs) ProtoReflect 

func (x *Extrapolator_Outs) ProtoReflect() protoreflect.Message

func (*Extrapolator_Outs) Reset 

func (x *Extrapolator_Outs) Reset()

func (*Extrapolator_Outs) String 

func (x *Extrapolator_Outs) String() string

func (*Extrapolator_Outs) UnmarshalJSON 

func (msg *Extrapolator_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type FluxMeter 

type FluxMeter struct {

	// What latency should we measure in the histogram created by this FluxMeter.
	//
	// * For traffic control points, fluxmeter will measure the duration of the
	//   whole http transaction (including sending request and receiving
	//   response).
	// * For feature control points, fluxmeter will measure execution of the span
	//   associated with particular feature. What contributes to the span's
	//   duration is entirely up to the user code that uses Aperture library.
	Selector *v1.Selector `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"`
	// Latency histogram buckets (in ms) for this FluxMeter.
	HistogramBuckets []float64 `` // @gotags: default:"[5.0,10.0,25.0,50.0,100.0,250.0,500.0,1000.0,2500.0,5000.0,10000.0]"
	/* 196-byte string literal not displayed */
	// contains filtered or unexported fields
}

FluxMeter gathers metrics for the traffic that matches its selector.

Example of a selector that creates a histogram metric for all HTTP requests to particular service: ```yaml selector: 

service: myservice.mynamespace.svc.cluster.local
control_point:
  traffic: ingress

```

func (*FluxMeter) Descriptor deprecated 

func (*FluxMeter) Descriptor() ([]byte, []int)

Deprecated: Use FluxMeter.ProtoReflect.Descriptor instead.

func (*FluxMeter) GetHistogramBuckets 

func (x *FluxMeter) GetHistogramBuckets() []float64

func (*FluxMeter) GetSelector 

func (x *FluxMeter) GetSelector() *v1.Selector

func (*FluxMeter) MarshalJSON 

func (msg *FluxMeter) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*FluxMeter) ProtoMessage 

func (*FluxMeter) ProtoMessage()

func (*FluxMeter) ProtoReflect 

func (x *FluxMeter) ProtoReflect() protoreflect.Message

func (*FluxMeter) Reset 

func (x *FluxMeter) Reset()

func (*FluxMeter) String 

func (x *FluxMeter) String() string

func (*FluxMeter) UnmarshalJSON 

func (msg *FluxMeter) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type GradientController 

type GradientController struct {

	// Input ports of the Gradient Controller.
	InPorts *GradientController_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports of the Gradient Controller.
	OutPorts *GradientController_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Tolerance is a way to pre-multiply a setpoint by given value.
	//
	// Value of tolerance should be close or equal to 1, eg. 1.1.
	//
	// :::caution
	// [This is going to be deprecated](https://github.com/fluxninja/aperture/issues/182).
	// :::
	Tolerance float64 `protobuf:"fixed64,3,opt,name=tolerance,proto3" json:"tolerance,omitempty" validate:"gte=0.0"` // @gotags: validate:"gte=0.0"
	// Minimum gradient which clamps the computed gradient value to the range, [min_gradient, max_gradient].
	MinGradient float64 `` // @gotags: default:"-1.79769313486231570814527423731704356798070e+308"
	/* 156-byte string literal not displayed */
	// Maximum gradient which clamps the computed gradient value to the range, [min_gradient, max_gradient].
	MaxGradient float64 `` // @gotags: default:"1.79769313486231570814527423731704356798070e+308"
	/* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Gradient controller is a type of controller which tries to adjust the control variable proportionally to the relative difference between setpoint and actual value of the signal

The `gradient` describes a corrective factor that should be applied to the control variable to get the signal closer to the setpoint. It is computed as follows:

$$ \text{gradient} = \frac{\text{setpoint}}{\text{signal}} \cdot \text{tolerance} $$

`gradient` is then clamped to [min_gradient, max_gradient] range.

The output of gradient controller is computed as follows: $$ \text{output} = \text{gradient}_{\text{clamped}} \cdot \text{control\_variable} + \text{optimize}. $$

Note the additional `optimize` signal, that can be used to "nudge" the controller into desired idle state.

The output can be _optionally_ clamped to desired range using `max` and `min` input.

:::caution Some changes are expected in the near future: [#182](https://github.com/fluxninja/aperture/issues/182) :::

func (*GradientController) Descriptor deprecated 

func (*GradientController) Descriptor() ([]byte, []int)

Deprecated: Use GradientController.ProtoReflect.Descriptor instead.

func (*GradientController) GetInPorts 

func (x *GradientController) GetInPorts() *GradientController_Ins

func (*GradientController) GetMaxGradient 

func (x *GradientController) GetMaxGradient() float64

func (*GradientController) GetMinGradient 

func (x *GradientController) GetMinGradient() float64

func (*GradientController) GetOutPorts 

func (x *GradientController) GetOutPorts() *GradientController_Outs

func (*GradientController) GetTolerance 

func (x *GradientController) GetTolerance() float64

func (*GradientController) MarshalJSON 

func (msg *GradientController) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*GradientController) ProtoMessage 

func (*GradientController) ProtoMessage()

func (*GradientController) ProtoReflect 

func (x *GradientController) ProtoReflect() protoreflect.Message

func (*GradientController) Reset 

func (x *GradientController) Reset()

func (*GradientController) String 

func (x *GradientController) String() string

func (*GradientController) UnmarshalJSON 

func (msg *GradientController) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type GradientController_Ins 

type GradientController_Ins struct {

	// Signal to be used for the gradient computation.
	Signal *Port `protobuf:"bytes,1,opt,name=signal,proto3" json:"signal,omitempty"`
	// Setpoint to be used for the gradient computation.
	Setpoint *Port `protobuf:"bytes,2,opt,name=setpoint,proto3" json:"setpoint,omitempty"`
	// Optimize signal is added to the output of the gradient calculation.
	Optimize *Port `protobuf:"bytes,3,opt,name=optimize,proto3" json:"optimize,omitempty"`
	// Maximum value to limit the output signal.
	Max *Port `protobuf:"bytes,4,opt,name=max,proto3" json:"max,omitempty"`
	// Minimum value to limit the output signal.
	Min *Port `protobuf:"bytes,5,opt,name=min,proto3" json:"min,omitempty"`
	// Actual current value of the control variable.
	//
	// This signal is multiplied by the gradient to produce the output.
	ControlVariable *Port `protobuf:"bytes,6,opt,name=control_variable,json=controlVariable,proto3" json:"control_variable,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Gradient Controller component.

func (*GradientController_Ins) Descriptor deprecated 

func (*GradientController_Ins) Descriptor() ([]byte, []int)

Deprecated: Use GradientController_Ins.ProtoReflect.Descriptor instead.

func (*GradientController_Ins) GetControlVariable 

func (x *GradientController_Ins) GetControlVariable() *Port

func (*GradientController_Ins) GetMax 

func (x *GradientController_Ins) GetMax() *Port

func (*GradientController_Ins) GetMin 

func (x *GradientController_Ins) GetMin() *Port

func (*GradientController_Ins) GetOptimize 

func (x *GradientController_Ins) GetOptimize() *Port

func (*GradientController_Ins) GetSetpoint 

func (x *GradientController_Ins) GetSetpoint() *Port

func (*GradientController_Ins) GetSignal 

func (x *GradientController_Ins) GetSignal() *Port

func (*GradientController_Ins) MarshalJSON 

func (msg *GradientController_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*GradientController_Ins) ProtoMessage 

func (*GradientController_Ins) ProtoMessage()

func (*GradientController_Ins) ProtoReflect 

func (x *GradientController_Ins) ProtoReflect() protoreflect.Message

func (*GradientController_Ins) Reset 

func (x *GradientController_Ins) Reset()

func (*GradientController_Ins) String 

func (x *GradientController_Ins) String() string

func (*GradientController_Ins) UnmarshalJSON 

func (msg *GradientController_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type GradientController_Outs 

type GradientController_Outs struct {

	// Computed desired value of the control variable.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the Gradient Controller component.

func (*GradientController_Outs) Descriptor deprecated 

func (*GradientController_Outs) Descriptor() ([]byte, []int)

Deprecated: Use GradientController_Outs.ProtoReflect.Descriptor instead.

func (*GradientController_Outs) GetOutput 

func (x *GradientController_Outs) GetOutput() *Port

func (*GradientController_Outs) MarshalJSON 

func (msg *GradientController_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*GradientController_Outs) ProtoMessage 

func (*GradientController_Outs) ProtoMessage()

func (*GradientController_Outs) ProtoReflect 

func (x *GradientController_Outs) ProtoReflect() protoreflect.Message

func (*GradientController_Outs) Reset 

func (x *GradientController_Outs) Reset()

func (*GradientController_Outs) String 

func (x *GradientController_Outs) String() string

func (*GradientController_Outs) UnmarshalJSON 

func (msg *GradientController_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type JSONExtractor 

type JSONExtractor struct {

	// Attribute path pointing to some strings - eg. "request.http.body".
	From string `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty" validate:"required"` //@gotags: validate:"required"
	// Json pointer represents a parsed json pointer which allows to select a specified field from the json payload.
	//
	// Note: Uses [json pointer](https://datatracker.ietf.org/doc/html/rfc6901) syntax,
	// eg. `/foo/bar`. If the pointer points into an object, it'd be stringified.
	Pointer string `protobuf:"bytes,2,opt,name=pointer,proto3" json:"pointer,omitempty"`
	// contains filtered or unexported fields
}

Deserialize a json, and extract one of the fields

Example: ```yaml from: request.http.body pointer: /user/name ```

func (*JSONExtractor) Descriptor deprecated 

func (*JSONExtractor) Descriptor() ([]byte, []int)

Deprecated: Use JSONExtractor.ProtoReflect.Descriptor instead.

func (*JSONExtractor) GetFrom 

func (x *JSONExtractor) GetFrom() string

func (*JSONExtractor) GetPointer 

func (x *JSONExtractor) GetPointer() string

func (*JSONExtractor) MarshalJSON 

func (msg *JSONExtractor) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*JSONExtractor) ProtoMessage 

func (*JSONExtractor) ProtoMessage()

func (*JSONExtractor) ProtoReflect 

func (x *JSONExtractor) ProtoReflect() protoreflect.Message

func (*JSONExtractor) Reset 

func (x *JSONExtractor) Reset()

func (*JSONExtractor) String 

func (x *JSONExtractor) String() string

func (*JSONExtractor) UnmarshalJSON 

func (msg *JSONExtractor) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type JWTExtractor 

type JWTExtractor struct {

	// Jwt token can be pulled from any input attribute, but most likely you'd want to use "request.http.bearer".
	From string `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty" validate:"required"` //@gotags: validate:"required"
	// Json pointer allowing to select a specified field from the json payload.
	//
	// Note: Uses [json pointer](https://datatracker.ietf.org/doc/html/rfc6901) syntax,
	// eg. `/foo/bar`. If the pointer points into an object, it'd be stringified.
	JsonPointer string `protobuf:"bytes,2,opt,name=json_pointer,json=jsonPointer,proto3" json:"json_pointer,omitempty"`
	// contains filtered or unexported fields
}

Parse the attribute as JWT and read the payload

Specify a field to be extracted from payload using "json_pointer".

Note: The signature is not verified against the secret (we're assuming there's some other parts of the system that handles such verification).

Example: ```yaml from: request.http.bearer json_pointer: /user/email ```

func (*JWTExtractor) Descriptor deprecated 

func (*JWTExtractor) Descriptor() ([]byte, []int)

Deprecated: Use JWTExtractor.ProtoReflect.Descriptor instead.

func (*JWTExtractor) GetFrom 

func (x *JWTExtractor) GetFrom() string

func (*JWTExtractor) GetJsonPointer 

func (x *JWTExtractor) GetJsonPointer() string

func (*JWTExtractor) MarshalJSON 

func (msg *JWTExtractor) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*JWTExtractor) ProtoMessage 

func (*JWTExtractor) ProtoMessage()

func (*JWTExtractor) ProtoReflect 

func (x *JWTExtractor) ProtoReflect() protoreflect.Message

func (*JWTExtractor) Reset 

func (x *JWTExtractor) Reset()

func (*JWTExtractor) String 

func (x *JWTExtractor) String() string

func (*JWTExtractor) UnmarshalJSON 

func (msg *JWTExtractor) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type LoadShedActuator 

type LoadShedActuator struct {

	// Input ports for the Load Shed Actuator component.
	InPorts *LoadShedActuator_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// contains filtered or unexported fields
}

Takes the load shed factor input signal and publishes it to the schedulers in the data-plane

func (*LoadShedActuator) Descriptor deprecated 

func (*LoadShedActuator) Descriptor() ([]byte, []int)

Deprecated: Use LoadShedActuator.ProtoReflect.Descriptor instead.

func (*LoadShedActuator) GetInPorts 

func (x *LoadShedActuator) GetInPorts() *LoadShedActuator_Ins

func (*LoadShedActuator) MarshalJSON 

func (msg *LoadShedActuator) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*LoadShedActuator) ProtoMessage 

func (*LoadShedActuator) ProtoMessage()

func (*LoadShedActuator) ProtoReflect 

func (x *LoadShedActuator) ProtoReflect() protoreflect.Message

func (*LoadShedActuator) Reset 

func (x *LoadShedActuator) Reset()

func (*LoadShedActuator) String 

func (x *LoadShedActuator) String() string

func (*LoadShedActuator) UnmarshalJSON 

func (msg *LoadShedActuator) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type LoadShedActuator_Ins 

type LoadShedActuator_Ins struct {

	// Load shedding factor is a fraction of [incoming
	// concurrency](#-v1schedulerouts) that needs to be dropped.
	LoadShedFactor *Port `protobuf:"bytes,1,opt,name=load_shed_factor,json=loadShedFactor,proto3" json:"load_shed_factor,omitempty"`
	// contains filtered or unexported fields
}

Input for the Load Shed Actuator component.

func (*LoadShedActuator_Ins) Descriptor deprecated 

func (*LoadShedActuator_Ins) Descriptor() ([]byte, []int)

Deprecated: Use LoadShedActuator_Ins.ProtoReflect.Descriptor instead.

func (*LoadShedActuator_Ins) GetLoadShedFactor 

func (x *LoadShedActuator_Ins) GetLoadShedFactor() *Port

func (*LoadShedActuator_Ins) MarshalJSON 

func (msg *LoadShedActuator_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*LoadShedActuator_Ins) ProtoMessage 

func (*LoadShedActuator_Ins) ProtoMessage()

func (*LoadShedActuator_Ins) ProtoReflect 

func (x *LoadShedActuator_Ins) ProtoReflect() protoreflect.Message

func (*LoadShedActuator_Ins) Reset 

func (x *LoadShedActuator_Ins) Reset()

func (*LoadShedActuator_Ins) String 

func (x *LoadShedActuator_Ins) String() string

func (*LoadShedActuator_Ins) UnmarshalJSON 

func (msg *LoadShedActuator_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Max 

type Max struct {

	// Input ports for the Max component.
	InPorts *Max_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the Max component.
	OutPorts *Max_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// contains filtered or unexported fields
}

Takes a list of input signals and emits the signal with the maximum value

Max: output = max([]inputs).

func (*Max) Descriptor deprecated 

func (*Max) Descriptor() ([]byte, []int)

Deprecated: Use Max.ProtoReflect.Descriptor instead.

func (*Max) GetInPorts 

func (x *Max) GetInPorts() *Max_Ins

func (*Max) GetOutPorts 

func (x *Max) GetOutPorts() *Max_Outs

func (*Max) MarshalJSON 

func (msg *Max) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Max) ProtoMessage 

func (*Max) ProtoMessage()

func (*Max) ProtoReflect 

func (x *Max) ProtoReflect() protoreflect.Message

func (*Max) Reset 

func (x *Max) Reset()

func (*Max) String 

func (x *Max) String() string

func (*Max) UnmarshalJSON 

func (msg *Max) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Max_Ins 

type Max_Ins struct {

	// Array of input signals.
	Inputs []*Port `protobuf:"bytes,1,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Max component.

func (*Max_Ins) Descriptor deprecated 

func (*Max_Ins) Descriptor() ([]byte, []int)

Deprecated: Use Max_Ins.ProtoReflect.Descriptor instead.

func (*Max_Ins) GetInputs 

func (x *Max_Ins) GetInputs() []*Port

func (*Max_Ins) MarshalJSON 

func (msg *Max_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Max_Ins) ProtoMessage 

func (*Max_Ins) ProtoMessage()

func (*Max_Ins) ProtoReflect 

func (x *Max_Ins) ProtoReflect() protoreflect.Message

func (*Max_Ins) Reset 

func (x *Max_Ins) Reset()

func (*Max_Ins) String 

func (x *Max_Ins) String() string

func (*Max_Ins) UnmarshalJSON 

func (msg *Max_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Max_Outs 

type Max_Outs struct {

	// Signal with maximum value as an output signal.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Output for the Max component.

func (*Max_Outs) Descriptor deprecated 

func (*Max_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Max_Outs.ProtoReflect.Descriptor instead.

func (*Max_Outs) GetOutput 

func (x *Max_Outs) GetOutput() *Port

func (*Max_Outs) MarshalJSON 

func (msg *Max_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Max_Outs) ProtoMessage 

func (*Max_Outs) ProtoMessage()

func (*Max_Outs) ProtoReflect 

func (x *Max_Outs) ProtoReflect() protoreflect.Message

func (*Max_Outs) Reset 

func (x *Max_Outs) Reset()

func (*Max_Outs) String 

func (x *Max_Outs) String() string

func (*Max_Outs) UnmarshalJSON 

func (msg *Max_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Min 

type Min struct {

	// Input ports for the Min component.
	InPorts *Min_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the Min component.
	OutPorts *Min_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// contains filtered or unexported fields
}

Takes an array of input signals and emits the signal with the minimum value Min: output = min([]inputs).

func (*Min) Descriptor deprecated 

func (*Min) Descriptor() ([]byte, []int)

Deprecated: Use Min.ProtoReflect.Descriptor instead.

func (*Min) GetInPorts 

func (x *Min) GetInPorts() *Min_Ins

func (*Min) GetOutPorts 

func (x *Min) GetOutPorts() *Min_Outs

func (*Min) MarshalJSON 

func (msg *Min) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Min) ProtoMessage 

func (*Min) ProtoMessage()

func (*Min) ProtoReflect 

func (x *Min) ProtoReflect() protoreflect.Message

func (*Min) Reset 

func (x *Min) Reset()

func (*Min) String 

func (x *Min) String() string

func (*Min) UnmarshalJSON 

func (msg *Min) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Min_Ins 

type Min_Ins struct {

	// Array of input signals.
	Inputs []*Port `protobuf:"bytes,1,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Min component.

func (*Min_Ins) Descriptor deprecated 

func (*Min_Ins) Descriptor() ([]byte, []int)

Deprecated: Use Min_Ins.ProtoReflect.Descriptor instead.

func (*Min_Ins) GetInputs 

func (x *Min_Ins) GetInputs() []*Port

func (*Min_Ins) MarshalJSON 

func (msg *Min_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Min_Ins) ProtoMessage 

func (*Min_Ins) ProtoMessage()

func (*Min_Ins) ProtoReflect 

func (x *Min_Ins) ProtoReflect() protoreflect.Message

func (*Min_Ins) Reset 

func (x *Min_Ins) Reset()

func (*Min_Ins) String 

func (x *Min_Ins) String() string

func (*Min_Ins) UnmarshalJSON 

func (msg *Min_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Min_Outs 

type Min_Outs struct {

	// Signal with minimum value as an output signal.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Output ports for the Min component.

func (*Min_Outs) Descriptor deprecated 

func (*Min_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Min_Outs.ProtoReflect.Descriptor instead.

func (*Min_Outs) GetOutput 

func (x *Min_Outs) GetOutput() *Port

func (*Min_Outs) MarshalJSON 

func (msg *Min_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Min_Outs) ProtoMessage 

func (*Min_Outs) ProtoMessage()

func (*Min_Outs) ProtoReflect 

func (x *Min_Outs) ProtoReflect() protoreflect.Message

func (*Min_Outs) Reset 

func (x *Min_Outs) Reset()

func (*Min_Outs) String 

func (x *Min_Outs) String() string

func (*Min_Outs) UnmarshalJSON 

func (msg *Min_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type PathTemplateMatcher 

type PathTemplateMatcher struct {

	// Template value keys are OpenAPI-inspired path templates.
	//
	// * Static path segment `/foo` matches a path segment exactly
	// * `/{param}` matches arbitrary path segment.
	//   (The param name is ignored and can be omitted (`{}`))
	// * The parameter must cover whole segment.
	// * Additionally, path template can end with `/*` wildcard to match
	//   arbitrary number of trailing segments (0 or more).
	// * Multiple consecutive `/` are ignored, as well as trailing `/`.
	// * Parametrized path segments must come after static segments.
	// * `*`, if present, must come last.
	// * Most specific template "wins" (`/foo` over `/{}` and `/{}` over `/*`).
	//
	// See also <https://swagger.io/specification/#path-templating-matching>
	//
	// Example:
	// “`yaml
	// /register: register
	// "/user/{userId}": user
	// /static/*: other
	// “`
	TemplateValues map[string]string `` /* 191-byte string literal not displayed */
	// contains filtered or unexported fields
}

Matches HTTP Path to given path templates

HTTP path will be matched against given path templates. If a match occurs, the value associated with the path template will be treated as a result. In case of multiple path templates matching, the most specific one will be chosen.

func (*PathTemplateMatcher) Descriptor deprecated 

func (*PathTemplateMatcher) Descriptor() ([]byte, []int)

Deprecated: Use PathTemplateMatcher.ProtoReflect.Descriptor instead.

func (*PathTemplateMatcher) GetTemplateValues 

func (x *PathTemplateMatcher) GetTemplateValues() map[string]string

func (*PathTemplateMatcher) MarshalJSON 

func (msg *PathTemplateMatcher) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*PathTemplateMatcher) ProtoMessage 

func (*PathTemplateMatcher) ProtoMessage()

func (*PathTemplateMatcher) ProtoReflect 

func (x *PathTemplateMatcher) ProtoReflect() protoreflect.Message

func (*PathTemplateMatcher) Reset 

func (x *PathTemplateMatcher) Reset()

func (*PathTemplateMatcher) String 

func (x *PathTemplateMatcher) String() string

func (*PathTemplateMatcher) UnmarshalJSON 

func (msg *PathTemplateMatcher) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Policy 

type Policy struct {

	// Defines the control-loop logic of the policy.
	Circuit *Circuit `protobuf:"bytes,1,opt,name=circuit,proto3" json:"circuit,omitempty"`
	// Resources (FluxMeters, Classifiers etc.) to setup.
	Resources *Resources `protobuf:"bytes,2,opt,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

Policy expresses reliability automation workflow that automatically protects services

Policy specification contains a circuit that defines the controller logic and resources that need to be setup.

func (*Policy) Descriptor deprecated 

func (*Policy) Descriptor() ([]byte, []int)

Deprecated: Use Policy.ProtoReflect.Descriptor instead.

func (*Policy) GetCircuit 

func (x *Policy) GetCircuit() *Circuit

func (*Policy) GetResources 

func (x *Policy) GetResources() *Resources

func (*Policy) MarshalJSON 

func (msg *Policy) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Policy) ProtoMessage 

func (*Policy) ProtoMessage()

func (*Policy) ProtoReflect 

func (x *Policy) ProtoReflect() protoreflect.Message

func (*Policy) Reset 

func (x *Policy) Reset()

func (*Policy) String 

func (x *Policy) String() string

func (*Policy) UnmarshalJSON 

func (msg *Policy) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type PolicyServiceClient 

type PolicyServiceClient interface {
	AllPolicies(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*AllPoliciesResponse, error)
}

PolicyServiceClient is the client API for PolicyService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewPolicyServiceClient 

func NewPolicyServiceClient(cc grpc.ClientConnInterface) PolicyServiceClient

type PolicyServiceServer 

type PolicyServiceServer interface {
	AllPolicies(context.Context, *emptypb.Empty) (*AllPoliciesResponse, error)
}

PolicyServiceServer is the server API for PolicyService service. All implementations should embed UnimplementedPolicyServiceServer for forward compatibility

type Port 

type Port struct {

	// Name of the incoming or outgoing Signal on the Port.
	SignalName string `protobuf:"bytes,1,opt,name=signal_name,json=signalName,proto3" json:"signal_name,omitempty"`
	// contains filtered or unexported fields
}

Components are interconnected with each other via Ports

func (*Port) Descriptor deprecated 

func (*Port) Descriptor() ([]byte, []int)

Deprecated: Use Port.ProtoReflect.Descriptor instead.

func (*Port) GetSignalName 

func (x *Port) GetSignalName() string

func (*Port) MarshalJSON 

func (msg *Port) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Port) ProtoMessage 

func (*Port) ProtoMessage()

func (*Port) ProtoReflect 

func (x *Port) ProtoReflect() protoreflect.Message

func (*Port) Reset 

func (x *Port) Reset()

func (*Port) String 

func (x *Port) String() string

func (*Port) UnmarshalJSON 

func (msg *Port) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type PromQL 

type PromQL struct {

	// Output ports for the PromQL component.
	OutPorts *PromQL_Outs `protobuf:"bytes,1,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Describes the Prometheus query to be run.
	//
	// :::caution
	// TODO we should describe how to construct the query, eg. how to employ the
	// fluxmeters here or link to appropriate place in docs.
	// :::
	QueryString string `protobuf:"bytes,2,opt,name=query_string,json=queryString,proto3" json:"query_string,omitempty"`
	// Describes the interval between successive evaluations of the Prometheus query.
	EvaluationInterval *durationpb.Duration `` // @gotags: default:"10s"
	/* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

Component that runs a Prometheus query periodically and returns the result as an output signal

func (*PromQL) Descriptor deprecated 

func (*PromQL) Descriptor() ([]byte, []int)

Deprecated: Use PromQL.ProtoReflect.Descriptor instead.

func (*PromQL) GetEvaluationInterval 

func (x *PromQL) GetEvaluationInterval() *durationpb.Duration

func (*PromQL) GetOutPorts 

func (x *PromQL) GetOutPorts() *PromQL_Outs

func (*PromQL) GetQueryString 

func (x *PromQL) GetQueryString() string

func (*PromQL) MarshalJSON 

func (msg *PromQL) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*PromQL) ProtoMessage 

func (*PromQL) ProtoMessage()

func (*PromQL) ProtoReflect 

func (x *PromQL) ProtoReflect() protoreflect.Message

func (*PromQL) Reset 

func (x *PromQL) Reset()

func (*PromQL) String 

func (x *PromQL) String() string

func (*PromQL) UnmarshalJSON 

func (msg *PromQL) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type PromQL_Outs 

type PromQL_Outs struct {

	// The result of the Prometheus query as an output signal.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Output for the PromQL component.

func (*PromQL_Outs) Descriptor deprecated 

func (*PromQL_Outs) Descriptor() ([]byte, []int)

Deprecated: Use PromQL_Outs.ProtoReflect.Descriptor instead.

func (*PromQL_Outs) GetOutput 

func (x *PromQL_Outs) GetOutput() *Port

func (*PromQL_Outs) MarshalJSON 

func (msg *PromQL_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*PromQL_Outs) ProtoMessage 

func (*PromQL_Outs) ProtoMessage()

func (*PromQL_Outs) ProtoReflect 

func (x *PromQL_Outs) ProtoReflect() protoreflect.Message

func (*PromQL_Outs) Reset 

func (x *PromQL_Outs) Reset()

func (*PromQL_Outs) String 

func (x *PromQL_Outs) String() string

func (*PromQL_Outs) UnmarshalJSON 

func (msg *PromQL_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type RateLimiter 

type RateLimiter struct {
	InPorts            *RateLimiter_Ins     `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty" validate:"required"` // @gotags: validate:"required"
	Selector           *v1.Selector         `protobuf:"bytes,2,opt,name=selector,proto3" json:"selector,omitempty" validate:"required"`              // @gotags: validate:"required"
	LimitResetInterval *durationpb.Duration ``                                                                                                       // @gotags: default:"60s"
	/* 131-byte string literal not displayed */
	LabelKey  string                  `protobuf:"bytes,4,opt,name=label_key,json=labelKey,proto3" json:"label_key,omitempty" validate:"required"` // @gotags: validate:"required"
	Overrides []*RateLimiter_Override `protobuf:"bytes,5,rep,name=overrides,proto3" json:"overrides,omitempty"`
	LazySync  *RateLimiter_LazySync   `protobuf:"bytes,6,opt,name=lazy_sync,json=lazySync,proto3" json:"lazy_sync,omitempty"`
	// contains filtered or unexported fields
}

func (*RateLimiter) Descriptor deprecated 

func (*RateLimiter) Descriptor() ([]byte, []int)

Deprecated: Use RateLimiter.ProtoReflect.Descriptor instead.

func (*RateLimiter) GetInPorts 

func (x *RateLimiter) GetInPorts() *RateLimiter_Ins

func (*RateLimiter) GetLabelKey 

func (x *RateLimiter) GetLabelKey() string

func (*RateLimiter) GetLazySync 

func (x *RateLimiter) GetLazySync() *RateLimiter_LazySync

func (*RateLimiter) GetLimitResetInterval 

func (x *RateLimiter) GetLimitResetInterval() *durationpb.Duration

func (*RateLimiter) GetOverrides 

func (x *RateLimiter) GetOverrides() []*RateLimiter_Override

func (*RateLimiter) GetSelector 

func (x *RateLimiter) GetSelector() *v1.Selector

func (*RateLimiter) MarshalJSON 

func (msg *RateLimiter) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*RateLimiter) ProtoMessage 

func (*RateLimiter) ProtoMessage()

func (*RateLimiter) ProtoReflect 

func (x *RateLimiter) ProtoReflect() protoreflect.Message

func (*RateLimiter) Reset 

func (x *RateLimiter) Reset()

func (*RateLimiter) String 

func (x *RateLimiter) String() string

func (*RateLimiter) UnmarshalJSON 

func (msg *RateLimiter) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type RateLimiter_Ins 

type RateLimiter_Ins struct {

	// negative limit means no limit is applied.
	Limit *Port `protobuf:"bytes,1,opt,name=limit,proto3" json:"limit,omitempty" validate:"required" default:"-1.0"` // @gotags: validate:"required" default:"-1.0"
	// contains filtered or unexported fields
}

func (*RateLimiter_Ins) Descriptor deprecated 

func (*RateLimiter_Ins) Descriptor() ([]byte, []int)

Deprecated: Use RateLimiter_Ins.ProtoReflect.Descriptor instead.

func (*RateLimiter_Ins) GetLimit 

func (x *RateLimiter_Ins) GetLimit() *Port

func (*RateLimiter_Ins) MarshalJSON 

func (msg *RateLimiter_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*RateLimiter_Ins) ProtoMessage 

func (*RateLimiter_Ins) ProtoMessage()

func (*RateLimiter_Ins) ProtoReflect 

func (x *RateLimiter_Ins) ProtoReflect() protoreflect.Message

func (*RateLimiter_Ins) Reset 

func (x *RateLimiter_Ins) Reset()

func (*RateLimiter_Ins) String 

func (x *RateLimiter_Ins) String() string

func (*RateLimiter_Ins) UnmarshalJSON 

func (msg *RateLimiter_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type RateLimiter_LazySync 

type RateLimiter_LazySync struct {
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty" default:"true"` // @gotags: default:"true"
	// Number of times to lazy sync within the limit_reset_interval.
	NumSync uint32 `protobuf:"varint,2,opt,name=num_sync,json=numSync,proto3" json:"num_sync,omitempty" default:"5" validate:"gt=0"` // @gotags: default:"5" validate:"gt=0"
	// contains filtered or unexported fields
}

func (*RateLimiter_LazySync) Descriptor deprecated 

func (*RateLimiter_LazySync) Descriptor() ([]byte, []int)

Deprecated: Use RateLimiter_LazySync.ProtoReflect.Descriptor instead.

func (*RateLimiter_LazySync) GetEnabled 

func (x *RateLimiter_LazySync) GetEnabled() bool

func (*RateLimiter_LazySync) GetNumSync 

func (x *RateLimiter_LazySync) GetNumSync() uint32

func (*RateLimiter_LazySync) MarshalJSON 

func (msg *RateLimiter_LazySync) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*RateLimiter_LazySync) ProtoMessage 

func (*RateLimiter_LazySync) ProtoMessage()

func (*RateLimiter_LazySync) ProtoReflect 

func (x *RateLimiter_LazySync) ProtoReflect() protoreflect.Message

func (*RateLimiter_LazySync) Reset 

func (x *RateLimiter_LazySync) Reset()

func (*RateLimiter_LazySync) String 

func (x *RateLimiter_LazySync) String() string

func (*RateLimiter_LazySync) UnmarshalJSON 

func (msg *RateLimiter_LazySync) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type RateLimiter_Override 

type RateLimiter_Override struct {
	LabelValue       string  `protobuf:"bytes,1,opt,name=label_value,json=labelValue,proto3" json:"label_value,omitempty" validate:"required"` // @gotags: validate:"required"
	LimitScaleFactor float64 ``                                                                                                                // @gotags: default:"1.0"
	/* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RateLimiter_Override) Descriptor deprecated 

func (*RateLimiter_Override) Descriptor() ([]byte, []int)

Deprecated: Use RateLimiter_Override.ProtoReflect.Descriptor instead.

func (*RateLimiter_Override) GetLabelValue 

func (x *RateLimiter_Override) GetLabelValue() string

func (*RateLimiter_Override) GetLimitScaleFactor 

func (x *RateLimiter_Override) GetLimitScaleFactor() float64

func (*RateLimiter_Override) MarshalJSON 

func (msg *RateLimiter_Override) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*RateLimiter_Override) ProtoMessage 

func (*RateLimiter_Override) ProtoMessage()

func (*RateLimiter_Override) ProtoReflect 

func (x *RateLimiter_Override) ProtoReflect() protoreflect.Message

func (*RateLimiter_Override) Reset 

func (x *RateLimiter_Override) Reset()

func (*RateLimiter_Override) String 

func (x *RateLimiter_Override) String() string

func (*RateLimiter_Override) UnmarshalJSON 

func (msg *RateLimiter_Override) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Resources 

type Resources struct {

	// FluxMeters are installed in the data-plane and form the observability leg of the feedback loop.
	//
	// FluxMeters'-created metrics can be consumed as input to the circuit via the PromQL component.
	FluxMeters map[string]*FluxMeter `` /* 179-byte string literal not displayed */
	// Classifiers are installed in the data-plane and are used to label the requests based on payload content.
	//
	// The flow labels created by Classifiers can be matched by FluxMeters to create metrics for control purposes.
	Classifiers []*Classifier `protobuf:"bytes,2,rep,name=classifiers,proto3" json:"classifiers,omitempty"`
	// contains filtered or unexported fields
}

Resources that need to be setup for the policy to function

Resources are typically FluxMeters, Classifiers, etc. that can be used to create on-demand metrics or label the flows.

func (*Resources) Descriptor deprecated 

func (*Resources) Descriptor() ([]byte, []int)

Deprecated: Use Resources.ProtoReflect.Descriptor instead.

func (*Resources) GetClassifiers 

func (x *Resources) GetClassifiers() []*Classifier

func (*Resources) GetFluxMeters 

func (x *Resources) GetFluxMeters() map[string]*FluxMeter

func (*Resources) MarshalJSON 

func (msg *Resources) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Resources) ProtoMessage 

func (*Resources) ProtoMessage()

func (*Resources) ProtoReflect 

func (x *Resources) ProtoReflect() protoreflect.Message

func (*Resources) Reset 

func (x *Resources) Reset()

func (*Resources) String 

func (x *Resources) String() string

func (*Resources) UnmarshalJSON 

func (msg *Resources) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Rule 

type Rule struct {

	// Types that are assignable to Source:
	//	*Rule_Extractor
	//	*Rule_Rego_
	Source isRule_Source `protobuf_oneof:"source"`
	// Decides if the created label should be applied to the whole flow (propagated in baggage) (default=true).
	Propagate *wrapperspb.BoolValue `protobuf:"bytes,3,opt,name=propagate,proto3" json:"propagate,omitempty"`
	// Decides if the created flow label should be hidden from the telemetry.
	Hidden bool `protobuf:"varint,4,opt,name=hidden,proto3" json:"hidden,omitempty"`
	// contains filtered or unexported fields
}

Rule describes a single Flow Classification Rule

Flow classification rule extracts a value from request metadata. More specifically, from `input`, which has the same spec as [Envoy's External Authorization Attribute Context][attribute-context]. See <https://play.openpolicyagent.org/p/gU7vcLkc70> for an example input. There are two ways to define a flow classification rule: * Using a declarative extractor – suitable from simple cases, such as directly reading a value from header or a field from json body. * Rego expression.

Performance note: It's recommended to use declarative extractors where possible, as they may be slightly performant than Rego expressions. [attribute-context](https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/attribute_context.proto)

Example: ```yaml Example of Declarative JSON extractor: 

yaml:
  extractor:
    json:
      from: request.http.body
      pointer: /user/name
  propagate: true
  hidden: false

Example of Rego module: 

yaml:
  rego:
    query: data.user_from_cookie.user
    source:
      package: user_from_cookie
      cookies: "split(input.attributes.request.http.headers.cookie, ';')"
      cookie: "cookies[_]"
      cookie.startswith: "('session=')"
      session: "substring(cookie, count('session='), -1)"
      parts: "split(session, '.')"
      object: "json.unmarshal(base64url.decode(parts[0]))"
      user: object.user
  propagate: false
  hidden: true

```

func (*Rule) Descriptor deprecated 

func (*Rule) Descriptor() ([]byte, []int)

Deprecated: Use Rule.ProtoReflect.Descriptor instead.

func (*Rule) GetExtractor 

func (x *Rule) GetExtractor() *Extractor

func (*Rule) GetHidden 

func (x *Rule) GetHidden() bool

func (*Rule) GetPropagate 

func (x *Rule) GetPropagate() *wrapperspb.BoolValue

func (*Rule) GetRego 

func (x *Rule) GetRego() *Rule_Rego

func (*Rule) GetSource 

func (m *Rule) GetSource() isRule_Source

func (*Rule) MarshalJSON 

func (msg *Rule) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Rule) ProtoMessage 

func (*Rule) ProtoMessage()

func (*Rule) ProtoReflect 

func (x *Rule) ProtoReflect() protoreflect.Message

func (*Rule) Reset 

func (x *Rule) Reset()

func (*Rule) String 

func (x *Rule) String() string

func (*Rule) UnmarshalJSON 

func (msg *Rule) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Rule_Extractor 

type Rule_Extractor struct {
	// High-level flow label declarative extractor.
	// Rego extractor extracts a value from the rego module.
	Extractor *Extractor `protobuf:"bytes,1,opt,name=extractor,proto3,oneof"`
}

type Rule_Rego 

type Rule_Rego struct {

	// Source code of the rego module.
	//
	// Note: Must include a "package" declaration.
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// Query string to extract a value (eg. `data.<mymodulename>.<variablename>`).
	//
	// Note: The module name must match the package name from the "source".
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

Raw rego rules are compiled 1:1 to rego queries

High-level extractor-based rules are compiled into a single rego query.

func (*Rule_Rego) Descriptor deprecated 

func (*Rule_Rego) Descriptor() ([]byte, []int)

Deprecated: Use Rule_Rego.ProtoReflect.Descriptor instead.

func (*Rule_Rego) GetQuery 

func (x *Rule_Rego) GetQuery() string

func (*Rule_Rego) GetSource 

func (x *Rule_Rego) GetSource() string

func (*Rule_Rego) MarshalJSON 

func (msg *Rule_Rego) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Rule_Rego) ProtoMessage 

func (*Rule_Rego) ProtoMessage()

func (*Rule_Rego) ProtoReflect 

func (x *Rule_Rego) ProtoReflect() protoreflect.Message

func (*Rule_Rego) Reset 

func (x *Rule_Rego) Reset()

func (*Rule_Rego) String 

func (x *Rule_Rego) String() string

func (*Rule_Rego) UnmarshalJSON 

func (msg *Rule_Rego) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Rule_Rego_ 

type Rule_Rego_ struct {
	// Rego module to extract a value from the rego module.
	Rego *Rule_Rego `protobuf:"bytes,2,opt,name=rego,proto3,oneof"`
}

type Scheduler 

type Scheduler struct {

	// Output ports for the Scheduler component.
	OutPorts *Scheduler_Outs `protobuf:"bytes,1,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Selector decides for which service or flows the scheduler will be applied.
	Selector *v1.Selector `protobuf:"bytes,2,opt,name=selector,proto3" json:"selector,omitempty"`
	// List of workloads to be used in scheduler.
	//
	// Categorizing [flows](/concepts/flow-control#what-is-a-flow) into workloads
	// allows for load-shedding to be "smarter" than just "randomly deny 50% of
	// requests". There are two aspects of workloads:
	//
	// Each workload in this list specifies also a matcher that's used to
	// determine which flow will be categorized into which workload.
	// In case of multiple matching workloads, the first matching one will be used.
	// If none of workloads match, `default_workload` will be used.
	//
	// :::info
	// See also [workload definition in the concepts
	// section](/concepts/flow-control/actuators/scheduler#workload).
	// :::
	Workloads []*Scheduler_WorkloadAndLabelMatcher `protobuf:"bytes,5,rep,name=workloads,proto3" json:"workloads,omitempty"`
	// Workload to be used if none of workloads specified in `workloads` match.
	DefaultWorkload *Scheduler_Workload `protobuf:"bytes,4,opt,name=default_workload,json=defaultWorkload,proto3" json:"default_workload,omitempty"`
	// Automatically estimate weight of flows in each workload, based on
	// historical latency. Each workload's `tokens` will be set to average
	// latency of flows in that workload during last few seconds (exact duration
	// of this average can change).
	AutoTokens bool `protobuf:"varint,3,opt,name=auto_tokens,json=autoTokens,proto3" json:"auto_tokens,omitempty" default:"true"` // @gotags: default:"true"
	// contains filtered or unexported fields
}

Weighted Fair Queuing-based workload scheduler

:::note Each Agent instantiates an independent copy of the scheduler, but output signal are aggregated across all agents. :::

See ConcurrencyLimiter(#-languagev1concurrencylimiter) for more context.

func (*Scheduler) Descriptor deprecated 

func (*Scheduler) Descriptor() ([]byte, []int)

Deprecated: Use Scheduler.ProtoReflect.Descriptor instead.

func (*Scheduler) GetAutoTokens 

func (x *Scheduler) GetAutoTokens() bool

func (*Scheduler) GetDefaultWorkload 

func (x *Scheduler) GetDefaultWorkload() *Scheduler_Workload

func (*Scheduler) GetOutPorts 

func (x *Scheduler) GetOutPorts() *Scheduler_Outs

func (*Scheduler) GetSelector 

func (x *Scheduler) GetSelector() *v1.Selector

func (*Scheduler) GetWorkloads 

func (x *Scheduler) GetWorkloads() []*Scheduler_WorkloadAndLabelMatcher

func (*Scheduler) MarshalJSON 

func (msg *Scheduler) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Scheduler) ProtoMessage 

func (*Scheduler) ProtoMessage()

func (*Scheduler) ProtoReflect 

func (x *Scheduler) ProtoReflect() protoreflect.Message

func (*Scheduler) Reset 

func (x *Scheduler) Reset()

func (*Scheduler) String 

func (x *Scheduler) String() string

func (*Scheduler) UnmarshalJSON 

func (msg *Scheduler) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Scheduler_Outs 

type Scheduler_Outs struct {

	// Accepted concurrency is the number of accepted tokens per second.
	//
	// :::info
	// **Accepted tokens** are tokens associated with
	// [flows](/concepts/flow-control#what-is-a-flow) that were accepted by
	// this scheduler. Number of tokens for a flow is determined by a
	// [workload](#-schedulerworkload) that the flow was assigned to (either
	// via `auto_tokens` or explicitly by `Workload.tokens`).
	// :::
	//
	// Value of this signal is the sum across all the relevant schedulers.
	AcceptedConcurrency *Port `protobuf:"bytes,1,opt,name=accepted_concurrency,json=acceptedConcurrency,proto3" json:"accepted_concurrency,omitempty"`
	// Incoming concurrency is the number of incoming tokens/sec.
	// This is the same as `accepted_concurrency`, but across all the flows
	// entering scheduler, including rejected ones.
	IncomingConcurrency *Port `protobuf:"bytes,2,opt,name=incoming_concurrency,json=incomingConcurrency,proto3" json:"incoming_concurrency,omitempty"`
	// contains filtered or unexported fields
}

Output for the Scheduler component.

func (*Scheduler_Outs) Descriptor deprecated 

func (*Scheduler_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Scheduler_Outs.ProtoReflect.Descriptor instead.

func (*Scheduler_Outs) GetAcceptedConcurrency 

func (x *Scheduler_Outs) GetAcceptedConcurrency() *Port

func (*Scheduler_Outs) GetIncomingConcurrency 

func (x *Scheduler_Outs) GetIncomingConcurrency() *Port

func (*Scheduler_Outs) MarshalJSON 

func (msg *Scheduler_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Scheduler_Outs) ProtoMessage 

func (*Scheduler_Outs) ProtoMessage()

func (*Scheduler_Outs) ProtoReflect 

func (x *Scheduler_Outs) ProtoReflect() protoreflect.Message

func (*Scheduler_Outs) Reset 

func (x *Scheduler_Outs) Reset()

func (*Scheduler_Outs) String 

func (x *Scheduler_Outs) String() string

func (*Scheduler_Outs) UnmarshalJSON 

func (msg *Scheduler_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Scheduler_Workload 

type Scheduler_Workload struct {

	// Describes priority level of the requests within the workload.
	// Priority level ranges from 0 to 255.
	// Higher numbers means higher priority level.
	Priority uint32 `protobuf:"varint,1,opt,name=priority,proto3" json:"priority,omitempty" validate:"gte=0,lte=255"` // @gotags: validate:"gte=0,lte=255"
	// Tokens determines the cost of admitting a single request the workload, which is typically defined as milliseconds of response latency.
	// This override is applicable only if `auto_tokens` is set to false.
	Tokens uint64 `protobuf:"varint,2,opt,name=tokens,proto3" json:"tokens,omitempty" default:"1"` // @gotags: default:"1"
	// Timeout override decides how long a request in the workload can wait for tokens
	//
	// This value impacts the fairness because the larger the timeout the higher the chance a request has to get scheduled.
	//
	// :::caution
	// This timeout needs to be strictly less than the timeout set on the
	// client for the whole GRPC call:
	// * in case of envoy, timeout set on `grpc_service` used in `ext_authz` filter,
	// * in case of libraries, timeout configured... TODO.
	//
	// We're using fail-open logic in integrations, so if the GRPC timeout
	// fires first, the flow will end up being unconditionally allowed while
	// it're still waiting on the scheduler.
	//
	// To avoid such cases, the end-to-end GRPC timeout should also contain
	// some headroom for constant overhead like serialization, etc. Default
	// value for GRPC timeouts is 10ms, giving 5ms of headeroom, so when
	// tweaking this timeout, make sure to adjust the GRPC timeout accordingly.
	// :::
	Timeout *durationpb.Duration `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty" default:"0.005s"` // @gotags: default:"0.005s"
	// Fairness key is a label key that can be used to provide fairness within a workload
	//
	// Any label that could be used in label matcher can be used here. Eg. if
	// you have a classifier that sets `user` flow label, you might want to set
	// `fairness_key = "user"`.
	FairnessKey string `protobuf:"bytes,4,opt,name=fairness_key,json=fairnessKey,proto3" json:"fairness_key,omitempty"`
	// contains filtered or unexported fields
}

Workload defines a class of requests that preferably have similar properties such as response latency or desired priority.

func (*Scheduler_Workload) Descriptor deprecated 

func (*Scheduler_Workload) Descriptor() ([]byte, []int)

Deprecated: Use Scheduler_Workload.ProtoReflect.Descriptor instead.

func (*Scheduler_Workload) GetFairnessKey 

func (x *Scheduler_Workload) GetFairnessKey() string

func (*Scheduler_Workload) GetPriority 

func (x *Scheduler_Workload) GetPriority() uint32

func (*Scheduler_Workload) GetTimeout 

func (x *Scheduler_Workload) GetTimeout() *durationpb.Duration

func (*Scheduler_Workload) GetTokens 

func (x *Scheduler_Workload) GetTokens() uint64

func (*Scheduler_Workload) MarshalJSON 

func (msg *Scheduler_Workload) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Scheduler_Workload) ProtoMessage 

func (*Scheduler_Workload) ProtoMessage()

func (*Scheduler_Workload) ProtoReflect 

func (x *Scheduler_Workload) ProtoReflect() protoreflect.Message

func (*Scheduler_Workload) Reset 

func (x *Scheduler_Workload) Reset()

func (*Scheduler_Workload) String 

func (x *Scheduler_Workload) String() string

func (*Scheduler_Workload) UnmarshalJSON 

func (msg *Scheduler_Workload) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Scheduler_WorkloadAndLabelMatcher 

type Scheduler_WorkloadAndLabelMatcher struct {

	// Workload associated with requests matching the label matcher.
	Workload *Scheduler_Workload `protobuf:"bytes,1,opt,name=workload,proto3" json:"workload,omitempty"`
	// Label Matcher to select a Workload.
	LabelMatcher *v11.LabelMatcher `protobuf:"bytes,2,opt,name=label_matcher,json=labelMatcher,proto3" json:"label_matcher,omitempty"`
	// contains filtered or unexported fields
}

func (*Scheduler_WorkloadAndLabelMatcher) Descriptor deprecated 

func (*Scheduler_WorkloadAndLabelMatcher) Descriptor() ([]byte, []int)

Deprecated: Use Scheduler_WorkloadAndLabelMatcher.ProtoReflect.Descriptor instead.

func (*Scheduler_WorkloadAndLabelMatcher) GetLabelMatcher 

func (x *Scheduler_WorkloadAndLabelMatcher) GetLabelMatcher() *v11.LabelMatcher

func (*Scheduler_WorkloadAndLabelMatcher) GetWorkload 

func (x *Scheduler_WorkloadAndLabelMatcher) GetWorkload() *Scheduler_Workload

func (*Scheduler_WorkloadAndLabelMatcher) MarshalJSON 

func (msg *Scheduler_WorkloadAndLabelMatcher) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Scheduler_WorkloadAndLabelMatcher) ProtoMessage 

func (*Scheduler_WorkloadAndLabelMatcher) ProtoMessage()

func (*Scheduler_WorkloadAndLabelMatcher) ProtoReflect 

func (x *Scheduler_WorkloadAndLabelMatcher) ProtoReflect() protoreflect.Message

func (*Scheduler_WorkloadAndLabelMatcher) Reset 

func (x *Scheduler_WorkloadAndLabelMatcher) Reset()

func (*Scheduler_WorkloadAndLabelMatcher) String 

func (x *Scheduler_WorkloadAndLabelMatcher) String() string

func (*Scheduler_WorkloadAndLabelMatcher) UnmarshalJSON 

func (msg *Scheduler_WorkloadAndLabelMatcher) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Sqrt 

type Sqrt struct {

	// Input ports for the Sqrt component.
	InPorts *Sqrt_Ins `protobuf:"bytes,1,opt,name=in_ports,json=inPorts,proto3" json:"in_ports,omitempty"`
	// Output ports for the Sqrt component.
	OutPorts *Sqrt_Outs `protobuf:"bytes,2,opt,name=out_ports,json=outPorts,proto3" json:"out_ports,omitempty"`
	// Scaling factor to be multiplied with the square root of the input signal.
	Scale float64 `protobuf:"fixed64,3,opt,name=scale,proto3" json:"scale,omitempty"` // @gotags default:"1.0"
	// contains filtered or unexported fields
}

Takes an input signal and emits the square root of it multiplied by scale as an output

$$ \text{output} = \text{scale} \sqrt{\text{input}} $$

func (*Sqrt) Descriptor deprecated 

func (*Sqrt) Descriptor() ([]byte, []int)

Deprecated: Use Sqrt.ProtoReflect.Descriptor instead.

func (*Sqrt) GetInPorts 

func (x *Sqrt) GetInPorts() *Sqrt_Ins

func (*Sqrt) GetOutPorts 

func (x *Sqrt) GetOutPorts() *Sqrt_Outs

func (*Sqrt) GetScale 

func (x *Sqrt) GetScale() float64

func (*Sqrt) MarshalJSON 

func (msg *Sqrt) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Sqrt) ProtoMessage 

func (*Sqrt) ProtoMessage()

func (*Sqrt) ProtoReflect 

func (x *Sqrt) ProtoReflect() protoreflect.Message

func (*Sqrt) Reset 

func (x *Sqrt) Reset()

func (*Sqrt) String 

func (x *Sqrt) String() string

func (*Sqrt) UnmarshalJSON 

func (msg *Sqrt) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Sqrt_Ins 

type Sqrt_Ins struct {

	// Input signal.
	Input *Port `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

Inputs for the Sqrt component.

func (*Sqrt_Ins) Descriptor deprecated 

func (*Sqrt_Ins) Descriptor() ([]byte, []int)

Deprecated: Use Sqrt_Ins.ProtoReflect.Descriptor instead.

func (*Sqrt_Ins) GetInput 

func (x *Sqrt_Ins) GetInput() *Port

func (*Sqrt_Ins) MarshalJSON 

func (msg *Sqrt_Ins) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Sqrt_Ins) ProtoMessage 

func (*Sqrt_Ins) ProtoMessage()

func (*Sqrt_Ins) ProtoReflect 

func (x *Sqrt_Ins) ProtoReflect() protoreflect.Message

func (*Sqrt_Ins) Reset 

func (x *Sqrt_Ins) Reset()

func (*Sqrt_Ins) String 

func (x *Sqrt_Ins) String() string

func (*Sqrt_Ins) UnmarshalJSON 

func (msg *Sqrt_Ins) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type Sqrt_Outs 

type Sqrt_Outs struct {

	// Output signal.
	Output *Port `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

Outputs for the Sqrt component.

func (*Sqrt_Outs) Descriptor deprecated 

func (*Sqrt_Outs) Descriptor() ([]byte, []int)

Deprecated: Use Sqrt_Outs.ProtoReflect.Descriptor instead.

func (*Sqrt_Outs) GetOutput 

func (x *Sqrt_Outs) GetOutput() *Port

func (*Sqrt_Outs) MarshalJSON 

func (msg *Sqrt_Outs) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler

func (*Sqrt_Outs) ProtoMessage 

func (*Sqrt_Outs) ProtoMessage()

func (*Sqrt_Outs) ProtoReflect 

func (x *Sqrt_Outs) ProtoReflect() protoreflect.Message

func (*Sqrt_Outs) Reset 

func (x *Sqrt_Outs) Reset()

func (*Sqrt_Outs) String 

func (x *Sqrt_Outs) String() string

func (*Sqrt_Outs) UnmarshalJSON 

func (msg *Sqrt_Outs) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler

type UnimplementedPolicyServiceServer 

type UnimplementedPolicyServiceServer struct {
}

UnimplementedPolicyServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedPolicyServiceServer) AllPolicies 

func (UnimplementedPolicyServiceServer) AllPolicies(context.Context, *emptypb.Empty) (*AllPoliciesResponse, error)

type UnsafePolicyServiceServer 

type UnsafePolicyServiceServer interface {
	// contains filtered or unexported methods
}

UnsafePolicyServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PolicyServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.