Struct Rule 

pub struct Rule {

    pub id: Id,
    pub resource: String,
    pub ref_resource: String,
    pub calculate_strategy: CalculateStrategy,
    pub control_strategy: ControlStrategy,
    pub relation_strategy: RelationStrategy,
    pub threshold: f64,
    pub warm_up_period_sec: u32,
    pub warm_up_cold_factor: u32,
    pub max_queueing_time_ms: u32,
    pub stat_interval_ms: u32,
    pub low_mem_usage_threshold: u64,
    pub high_mem_usage_threshold: u64,
    pub mem_low_water_mark: u64,
    pub mem_high_water_mark: u64,
}

Rule describes the strategy of flow control, the flow control strategy is based on QPS statistic metric

Fields

id: Id

id represents the unique ID of the rule (optional).

resource: String

resource represents the resource name.

ref_resource: String

calculate_strategy: CalculateStrategy

control_strategy: ControlStrategy

relation_strategy: RelationStrategy

threshold: f64

threshold means the threshold during stat_interval_ms If stat_interval_ms is 1000(1 second), threshold means QPS

warm_up_period_sec: u32

warm_up_cold_factor: u32

max_queueing_time_ms: u32

max_queueing_time_ms only takes effect when control_strategy is Throttling. When max_queueing_time_ms is 0, it means Throttling only controls interval of requests, and requests exceeding the threshold will be rejected directly.

stat_interval_ms: u32

stat_interval_ms indicates the statistic interval and it’s the optional setting for flow Rule. If user doesn’t set stat_interval_ms, that means using default metric statistic of resource. If the stat_interval_ms user specifies can not reuse the global statistic of resource, sentinel will generate independent statistic structure for this self.

low_mem_usage_threshold: u64

adaptive flow control algorithm related parameters limitation: low_mem_usage_threshold > high_mem_usage_threshold && mem_high_water_mark > mem_low_water_mark

• if the current memory usage is less than or equals to mem_low_water_mark, threshold == low_mem_usage_threshold
• if the current memory usage is more than or equals to mem_high_water_mark, threshold == high_mem_usage_threshold
• if the current memory usage is in (mem_low_water_mark, mem_high_water_mark), threshold is in (high_mem_usage_threshold, low_mem_usage_threshold)

high_mem_usage_threshold: u64

mem_low_water_mark: u64

mem_high_water_mark: u64

Implementations

impl Rule

pub fn is_stat_reusable(&self, other: &Self) -> bool

pub fn need_statistic(&self) -> bool

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Rule

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rule

where Rule: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Rule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Rule

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Rule

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Rule

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SentinelRule for Rule

fn resource_name(&self) -> String

fn is_valid(&self) -> Result<()>

impl Serialize for Rule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Rule