Struct relay_quotas::Quota

pub struct Quota {
    pub id: Option<String>,
    pub categories: DataCategories,
    pub scope: QuotaScope,
    pub scope_id: Option<String>,
    pub limit: Option<u64>,
    pub window: Option<u64>,
    pub namespace: Option<MetricNamespace>,
    pub reason_code: Option<ReasonCode>,
}

Configuration for a data ingestion quota (rate limiting).

Sentry applies multiple quotas to incoming data before accepting it, some of which can be configured by the customer. Each piece of data (such as event, attachment) will be counted against all quotas that it matches with based on the category.

Fields

id: Option<String>

The unique identifier for counting this quota. Required, except for quotas with a limit of 0, since they are statically enforced.

categories: DataCategories

A set of data categories that this quota applies to. If missing or empty, this quota applies to all data.

scope: QuotaScope

A scope for this quota. This quota is enforced separately within each instance of this scope (e.g. for each project key separately). Defaults to QuotaScope::Organization.

scope_id: Option<String>

Identifier of the scope to apply to. If set, then this quota will only apply to the specified scope instance (e.g. a project key). Requires scope to be set explicitly.

limit: Option<u64>

Maximum number of matching events allowed. Can be 0 to reject all events, None for an unlimited counted quota, or a positive number for enforcement. Requires window if the limit is not 0.

For attachments, this limit expresses the number of allowed bytes.

window: Option<u64>

The time window in seconds to enforce this quota in. Required in all cases except limit=0, since those quotas are not measured.

namespace: Option<MetricNamespace>

The namespace the quota applies to.

If None, it will match any namespace.

reason_code: Option<ReasonCode>

A machine readable reason returned when this quota is exceeded. Required in all cases except limit=None, since unlimited quotas can never be exceeded.

Implementations

impl Quota

pub fn is_valid(&self) -> bool

Returns whether this quota is valid for tracking.

There are a few conditions at which quotas are invalid:

• The quota only applies to Unknown data categories.
• The quota is counted (not limit 0) but specifies categories with different units.
• The quota references an unsupported namespace.

pub fn matches(&self, scoping: ItemScoping<'_>) -> bool

Checks whether the quota’s constraints match the current item.

Trait Implementations

impl Clone for Quota

fn clone(&self) -> Quota

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quota

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Quota

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Quota

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Quota

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Quota