Safe Haskell	None
Language	GHC2024

Arbiter.Core.Concurrency.Stats

Description

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

View and patch types for the concurrency management and observability API.

Synopsis

data ConcurrencyPolicyView = ConcurrencyPolicyView {
- prefix :: Text
- defaultLimit :: Int32
- overrideLimit :: Maybe Int32
- keyCount :: Int64
- totalInFlight :: Int64
- maxInFlight :: Maybe Int32
}
data ConcurrencyKeyView = ConcurrencyKeyView {
- concurrencyKey :: Text
- concurrencyPrefix :: Text
- inFlight :: Int32
- effectiveLimit :: Int32
- fillFraction :: Maybe Double
}
data ConcurrencyPolicyUpdate = ConcurrencyPolicyUpdate {
- overrideLimit :: Maybe (Maybe Int32)
}

Documentation

data ConcurrencyPolicyViewSource #

A concurrency policy with its default and override limits plus live key and in-flight stats. The effective cap is overrideLimit when set, else defaultLimit.

Constructors

ConcurrencyPolicyView

Fields

prefix :: Text
The policy's key prefix.
defaultLimit :: Int32
The declared per-key limit, in jobs.
overrideLimit :: Maybe Int32
The operator's per-key limit, in jobs. Nothing when unset.
keyCount :: Int64
Keys tracked under the prefix.
totalInFlight :: Int64
In-flight jobs summed over every key.
maxInFlight :: Maybe Int32
The highest in-flight count of one key. Nothing when the prefix has no key.

Instances

Instances details

FromJSON ConcurrencyPolicyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

parseJSON :: Value -> Parser ConcurrencyPolicyView#

parseJSONList :: Value -> Parser [ConcurrencyPolicyView]#

omittedField :: Maybe ConcurrencyPolicyView#

ToJSON ConcurrencyPolicyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

toJSON :: ConcurrencyPolicyView -> Value#

toEncoding :: ConcurrencyPolicyView -> Encoding#

toJSONList :: [ConcurrencyPolicyView] -> Value#

toEncodingList :: [ConcurrencyPolicyView] -> Encoding#

omitField :: ConcurrencyPolicyView -> Bool#

Eq ConcurrencyPolicyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

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

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

Generic ConcurrencyPolicyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Associated Types

type Rep ConcurrencyPolicyView

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyPolicyView = D1 ('MetaData "ConcurrencyPolicyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "defaultLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32)))) :*: (S1 ('MetaSel ('Just "keyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: (S1 ('MetaSel ('Just "totalInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "maxInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32))))))

Methods

from :: ConcurrencyPolicyView -> Rep ConcurrencyPolicyView x#

to :: Rep ConcurrencyPolicyView x -> ConcurrencyPolicyView#

Show ConcurrencyPolicyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

showsPrec :: Int -> ConcurrencyPolicyView -> ShowS#

show :: ConcurrencyPolicyView -> String#

showList :: [ConcurrencyPolicyView] -> ShowS#

type Rep ConcurrencyPolicyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyPolicyView = D1 ('MetaData "ConcurrencyPolicyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "defaultLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32)))) :*: (S1 ('MetaSel ('Just "keyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: (S1 ('MetaSel ('Just "totalInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "maxInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32))))))

data ConcurrencyKeyViewSource #

A single key's in-flight count, its effective cap, and fill fraction.

Constructors

ConcurrencyKeyView
Fields concurrencyKey :: Text The full `prefix:suffix` key. concurrencyPrefix :: Text The policy's key prefix. inFlight :: Int32 Jobs in flight under the key. effectiveLimit :: Int32 The override limit when set, else the default, in jobs. fillFraction :: Maybe Double In-flight jobs divided by the effective limit. `Nothing` when the limit is 0.

Instances

Instances details

FromJSON ConcurrencyKeyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

parseJSON :: Value -> Parser ConcurrencyKeyView#

parseJSONList :: Value -> Parser [ConcurrencyKeyView]#

omittedField :: Maybe ConcurrencyKeyView#

ToJSON ConcurrencyKeyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

toJSON :: ConcurrencyKeyView -> Value#

toEncoding :: ConcurrencyKeyView -> Encoding#

toJSONList :: [ConcurrencyKeyView] -> Value#

toEncodingList :: [ConcurrencyKeyView] -> Encoding#

omitField :: ConcurrencyKeyView -> Bool#

Eq ConcurrencyKeyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

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

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

Generic ConcurrencyKeyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Associated Types

type Rep ConcurrencyKeyView

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyKeyView = D1 ('MetaData "ConcurrencyKeyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyKeyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "concurrencyKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "concurrencyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: (S1 ('MetaSel ('Just "effectiveLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

Methods

from :: ConcurrencyKeyView -> Rep ConcurrencyKeyView x#

to :: Rep ConcurrencyKeyView x -> ConcurrencyKeyView#

Show ConcurrencyKeyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

showsPrec :: Int -> ConcurrencyKeyView -> ShowS#

show :: ConcurrencyKeyView -> String#

showList :: [ConcurrencyKeyView] -> ShowS#

type Rep ConcurrencyKeyView Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyKeyView = D1 ('MetaData "ConcurrencyKeyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyKeyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "concurrencyKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "concurrencyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: (S1 ('MetaSel ('Just "effectiveLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

data ConcurrencyPolicyUpdateSource #

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

Constructors

ConcurrencyPolicyUpdate
Fields overrideLimit :: Maybe (Maybe Int32) The per-key limit override, in jobs.

Instances

Instances details

FromJSON ConcurrencyPolicyUpdate Source #

A missing key leaves the field unchanged. An explicit null clears the override.

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

parseJSON :: Value -> Parser ConcurrencyPolicyUpdate#

parseJSONList :: Value -> Parser [ConcurrencyPolicyUpdate]#

omittedField :: Maybe ConcurrencyPolicyUpdate#

ToJSON ConcurrencyPolicyUpdate Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

toJSON :: ConcurrencyPolicyUpdate -> Value#

toEncoding :: ConcurrencyPolicyUpdate -> Encoding#

toJSONList :: [ConcurrencyPolicyUpdate] -> Value#

toEncodingList :: [ConcurrencyPolicyUpdate] -> Encoding#

omitField :: ConcurrencyPolicyUpdate -> Bool#

Eq ConcurrencyPolicyUpdate Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

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

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

Generic ConcurrencyPolicyUpdate Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Associated Types

type Rep ConcurrencyPolicyUpdate
Instance details Defined in Arbiter.Core.Concurrency.Stats type Rep ConcurrencyPolicyUpdate = D1 ('MetaData "ConcurrencyPolicyUpdate" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Int32)))))

Methods

from :: ConcurrencyPolicyUpdate -> Rep ConcurrencyPolicyUpdate x#

to :: Rep ConcurrencyPolicyUpdate x -> ConcurrencyPolicyUpdate#

Show ConcurrencyPolicyUpdate Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

showsPrec :: Int -> ConcurrencyPolicyUpdate -> ShowS#

show :: ConcurrencyPolicyUpdate -> String#

showList :: [ConcurrencyPolicyUpdate] -> ShowS#

type Rep ConcurrencyPolicyUpdate Source #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyPolicyUpdate = D1 ('MetaData "ConcurrencyPolicyUpdate" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Int32)))))