Safe Haskell	None
Language	GHC2024

Arbiter.Core.RateLimit.Stats

Description

Internal to the arbiter packages. Not covered by the PVP.

View and patch types for the rate-limit management and observability API.

Synopsis

data RateLimitPolicyView = RateLimitPolicyView {
- prefix :: Text
- defaultMaxTokens :: Double
- defaultRefillAmount :: Double
- defaultInterval :: Double
- overrideMaxTokens :: Maybe Double
- overrideRefillAmount :: Maybe Double
- overrideInterval :: Maybe Double
- bucketCount :: Int64
- throttledCount :: Int64
- throttledQueues :: [Text]
- minTokens :: Maybe Double
- avgTokens :: Maybe Double
}
data RateLimitBucketView = RateLimitBucketView {
- rateLimitKey :: Text
- rateLimitPrefix :: Text
- tokens :: Double
- maxTokens :: Double
- fillFraction :: Maybe Double
- lastRefill :: UTCTime
}
data RateLimitPolicyUpdate = RateLimitPolicyUpdate {
- overrideMaxTokens :: Maybe (Maybe Double)
- overrideRefillAmount :: Maybe (Maybe Double)
- overrideInterval :: Maybe (Maybe Double)
}

Documentation

data RateLimitPolicyViewSource #

A policy with its default and override params plus live bucket and throttle stats. Each effective param is its override* field when set, else its default* field.

Constructors

RateLimitPolicyView

Fields

prefix :: Text
The policy's key prefix.
defaultMaxTokens :: Double
The declared bucket capacity, in tokens.
defaultRefillAmount :: Double
The declared tokens added per interval.
defaultInterval :: Double
The declared refill interval, in seconds.
overrideMaxTokens :: Maybe Double
The operator's bucket capacity, in tokens. Nothing when unset.
overrideRefillAmount :: Maybe Double
The operator's tokens added per interval. Nothing when unset.
overrideInterval :: Maybe Double
The operator's refill interval, in seconds. Nothing when unset.
bucketCount :: Int64
Buckets under the prefix.
throttledCount :: Int64
Jobs the policy holds throttled, over every registry queue.
throttledQueues :: [Text]
The queues that hold throttled jobs, the most first.
minTokens :: Maybe Double
The lowest token count of one bucket, refill included. Nothing when the prefix has no bucket.
avgTokens :: Maybe Double
The mean token count over the buckets, refill included. Nothing when the prefix has no bucket.

Instances

Instances details

FromJSON RateLimitPolicyView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

parseJSON :: Value -> Parser RateLimitPolicyView#

parseJSONList :: Value -> Parser [RateLimitPolicyView]#

omittedField :: Maybe RateLimitPolicyView#

ToJSON RateLimitPolicyView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

toJSON :: RateLimitPolicyView -> Value#

toEncoding :: RateLimitPolicyView -> Encoding#

toJSONList :: [RateLimitPolicyView] -> Value#

toEncodingList :: [RateLimitPolicyView] -> Encoding#

omitField :: RateLimitPolicyView -> Bool#

Eq RateLimitPolicyView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

(==) :: RateLimitPolicyView -> RateLimitPolicyView -> Bool#

(/=) :: RateLimitPolicyView -> RateLimitPolicyView -> Bool#

Generic RateLimitPolicyView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Associated Types

type Rep RateLimitPolicyView

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

from :: RateLimitPolicyView -> Rep RateLimitPolicyView x#

to :: Rep RateLimitPolicyView x -> RateLimitPolicyView#

Show RateLimitPolicyView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

showsPrec :: Int -> RateLimitPolicyView -> ShowS#

show :: RateLimitPolicyView -> String#

showList :: [RateLimitPolicyView] -> ShowS#

type Rep RateLimitPolicyView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

data RateLimitBucketViewSource #

A single key's bucket: current tokens, effective max, and fill fraction.

Constructors

RateLimitBucketView
Fields rateLimitKey :: Text The full `prefix:suffix` key. rateLimitPrefix :: Text The policy's key prefix. tokens :: Double Tokens available now, refill included. maxTokens :: Double The effective bucket capacity, in tokens. fillFraction :: Maybe Double Tokens divided by capacity. `Nothing` when the capacity is 0. lastRefill :: UTCTime When the bucket last stored a refill.

Instances

Instances details

FromJSON RateLimitBucketView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

parseJSON :: Value -> Parser RateLimitBucketView#

parseJSONList :: Value -> Parser [RateLimitBucketView]#

omittedField :: Maybe RateLimitBucketView#

ToJSON RateLimitBucketView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

toJSON :: RateLimitBucketView -> Value#

toEncoding :: RateLimitBucketView -> Encoding#

toJSONList :: [RateLimitBucketView] -> Value#

toEncodingList :: [RateLimitBucketView] -> Encoding#

omitField :: RateLimitBucketView -> Bool#

Eq RateLimitBucketView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

(==) :: RateLimitBucketView -> RateLimitBucketView -> Bool#

(/=) :: RateLimitBucketView -> RateLimitBucketView -> Bool#

Generic RateLimitBucketView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Associated Types

type Rep RateLimitBucketView

Instance details

Defined in Arbiter.Core.RateLimit.Stats

type Rep RateLimitBucketView = D1 ('MetaData "RateLimitBucketView" "Arbiter.Core.RateLimit.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitBucketView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rateLimitKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rateLimitPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "maxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "lastRefill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

Methods

from :: RateLimitBucketView -> Rep RateLimitBucketView x#

to :: Rep RateLimitBucketView x -> RateLimitBucketView#

Show RateLimitBucketView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

showsPrec :: Int -> RateLimitBucketView -> ShowS#

show :: RateLimitBucketView -> String#

showList :: [RateLimitBucketView] -> ShowS#

type Rep RateLimitBucketView Source #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

type Rep RateLimitBucketView = D1 ('MetaData "RateLimitBucketView" "Arbiter.Core.RateLimit.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitBucketView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rateLimitKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rateLimitPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "maxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "lastRefill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

data RateLimitPolicyUpdateSource #

A patch over a policy's override params. Per field: Nothing leaves it unchanged, Just Nothing clears the override (reverts to the default), and Just (Just v) sets it.

Constructors

RateLimitPolicyUpdate
Fields overrideMaxTokens :: Maybe (Maybe Double) The bucket capacity override, in tokens. overrideRefillAmount :: Maybe (Maybe Double) The tokens-per-interval override. overrideInterval :: Maybe (Maybe Double) The refill interval override, in seconds.