Safe Haskell	None
Language	GHC2021

Ecluse.Core.Server.Admission.Types

Contents

Charges
The meter's figures
The brake

Description

The memory gate's shared vocabulary: what adapters charge, what the meter reports, and the bounds the boot hands the brake. Ecluse.Core.Server.Admission.Meter and Ecluse.Core.Server.Admission.Brake act on these, and the adapters, the sampler, the memory plan and the gauges read or build them.

Synopsis

data ChargeFactors = ChargeFactors {
- cfFullReadPermille :: Int
- cfOutputPermille :: Int
}
newtype FlightKey = FlightKey Text
data MeterSnapshot = MeterSnapshot {
- snBudgetBytes :: Int
- snChargedBytes :: Int
- snWaiting :: Int
- snPaused :: Int
- snBrakeLevel :: BrakeLevel
}
data BrakeLevel
- = Calm
- | Holding
- | Braking
brakeLevelCode :: BrakeLevel -> Int
data BrakeBounds = BrakeBounds {
- bbBootBytes :: Int
- bbFloorBytes :: Int
- bbLiveCeilingBytes :: Maybe Int
- bbFixedLiveBytes :: Int
- bbExplainedBytes :: Int
- bbOverflowLiveBytes :: Maybe Int
- bbGrowFloorBytes :: Int
}

Charges

data ChargeFactors Source #

Live heap bytes charged per byte of a read or an output basis, in thousandths, for one ecosystem.

Constructors

ChargeFactors

Fields

cfFullReadPermille :: Int
Per decompressed byte of a full read: 1.25 times the largest read peak per source byte on a residency capture of at least one meter step, rounded up to a tenth.
cfOutputPermille :: Int
Per byte of a listing's output basis: 1.25 times the largest output working set per basis byte of a single document or a realistic merge, on a capture of at least one meter step, rounded up.

Instances

Instances details

Show ChargeFactors Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods showsPrec :: Int -> ChargeFactors -> ShowS # show :: ChargeFactors -> String # showList :: [ChargeFactors] -> ShowS #
Eq ChargeFactors Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods (==) :: ChargeFactors -> ChargeFactors -> Bool # (/=) :: ChargeFactors -> ChargeFactors -> Bool #

newtype FlightKey Source #

One unit of work several requests may wait on: a shared fetch or a shared render, by its cache key.

Constructors

FlightKey Text

Instances

Instances details

Show FlightKey Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods showsPrec :: Int -> FlightKey -> ShowS # show :: FlightKey -> String # showList :: [FlightKey] -> ShowS #
Eq FlightKey Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods (==) :: FlightKey -> FlightKey -> Bool # (/=) :: FlightKey -> FlightKey -> Bool #
Ord FlightKey Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods compare :: FlightKey -> FlightKey -> Ordering # (<) :: FlightKey -> FlightKey -> Bool # (<=) :: FlightKey -> FlightKey -> Bool # (>) :: FlightKey -> FlightKey -> Bool # (>=) :: FlightKey -> FlightKey -> Bool # max :: FlightKey -> FlightKey -> FlightKey # min :: FlightKey -> FlightKey -> FlightKey #

The meter's figures

data MeterSnapshot Source #

What the meter holds and who waits on it, for the gauges and the sampler.

Constructors

MeterSnapshot
Fields snBudgetBytes :: Int snChargedBytes :: Int What the requests in flight hold against the budget. snWaiting :: Int New requests waiting at the gate for their entry step. snPaused :: Int Started requests paused until memory frees. snBrakeLevel :: BrakeLevel The level of the brake step that last moved the budget.

Instances

Instances details

Show MeterSnapshot Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods showsPrec :: Int -> MeterSnapshot -> ShowS # show :: MeterSnapshot -> String # showList :: [MeterSnapshot] -> ShowS #
Eq MeterSnapshot Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods (==) :: MeterSnapshot -> MeterSnapshot -> Bool # (/=) :: MeterSnapshot -> MeterSnapshot -> Bool #

The brake

data BrakeLevel Source #

Where the brake stands after a sample.

Constructors

Calm	The collector is calm: the budget may grow.
Holding	Neither calm nor pressed: the budget holds.
Braking	Pressure seen in this sample: the budget halved, or holds while a halving settles.

Instances

Instances details

Show BrakeLevel Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods showsPrec :: Int -> BrakeLevel -> ShowS # show :: BrakeLevel -> String # showList :: [BrakeLevel] -> ShowS #
Eq BrakeLevel Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods (==) :: BrakeLevel -> BrakeLevel -> Bool # (/=) :: BrakeLevel -> BrakeLevel -> Bool #

brakeLevelCode :: BrakeLevel -> Int Source #

The gauge value of a level: 0 calm, 1 holding, 2 braking.

data BrakeBounds Source #

What the boot fixed for this process.

Constructors

BrakeBounds

Fields

bbBootBytes :: Int
The budget the boot computed, and the ceiling when no heap ceiling binds.
bbFloorBytes :: Int
The budget never falls below this.
bbLiveCeilingBytes :: Maybe Int
The live data charges and the measured remainder may reach together, when a heap ceiling binds.
bbFixedLiveBytes :: Int
The least live data ever counted outside the charges: the idle process.
bbExplainedBytes :: Int
The boot's estimate of live data outside the charges, used until a major collection measures it.
bbOverflowLiveBytes :: Maybe Int
The live data at which the copying collector overflows the heap ceiling, when one binds.
bbGrowFloorBytes :: Int
The smallest growth step.

Instances

Instances details

Show BrakeBounds Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods showsPrec :: Int -> BrakeBounds -> ShowS # show :: BrakeBounds -> String # showList :: [BrakeBounds] -> ShowS #
Eq BrakeBounds Source #
Instance details Defined in Ecluse.Core.Server.Admission.Types Methods (==) :: BrakeBounds -> BrakeBounds -> Bool # (/=) :: BrakeBounds -> BrakeBounds -> Bool #