Safe Haskell	None
Language	GHC2024

Arbiter.Core.RateLimit.Stats

Description

View and patch types for the rate-limit management/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
- minTokens :: Maybe Double
- avgTokens :: Maybe Double
}
data RateLimitBucketView = RateLimitBucketView {
- rateLimitKey :: Text
- policyPrefix :: 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

Source #data RateLimitPolicyView

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

Constructors

RateLimitPolicyView
Fields prefix :: Text defaultMaxTokens :: Double defaultRefillAmount :: Double defaultInterval :: Double overrideMaxTokens :: Maybe Double overrideRefillAmount :: Maybe Double overrideInterval :: Maybe Double bucketCount :: Int64 throttledCount :: Int64 minTokens :: Maybe Double avgTokens :: Maybe Double

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

Source #data RateLimitBucketView

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

Constructors

RateLimitBucketView
Fields rateLimitKey :: Text policyPrefix :: Text tokens :: Double maxTokens :: Double fillFraction :: Maybe Double lastRefill :: UTCTime

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 "policyPrefix") '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 "policyPrefix") '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)))))

Source #data RateLimitPolicyUpdate

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) overrideRefillAmount :: Maybe (Maybe Double) overrideInterval :: Maybe (Maybe Double)