Safe Haskell	None
Language	GHC2024

Arbiter.Otel.Gauges.Cache

Description

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

Shared state for gauge instruments and the refresh loop.

Synopsis

data Snapshot = Snapshot {
- queues :: [QueueOverview]
- db :: Maybe PgDbHealth
- tables :: [PgTableHealth]
- concurrency :: [ConcurrencyPolicyView]
- rateLimits :: [RateLimitPolicyView]
}
data Cached = Cached {
- takenAt :: Double
- reading :: Snapshot
}
data Export
- = Live Cached
- | Idle (Maybe Double)
live :: Export -> Maybe Cached
lastScan :: Export -> Maybe Double
retire :: Export -> Export
data GaugeCache = GaugeCache {
- export :: TVar Export
- databaseReachable :: TVar (Maybe Bool)
- registeredAt :: Double
}
newGaugeCache :: Double -> IO GaugeCache
publishSnapshot :: GaugeCache -> Cached -> STM ()
setReachable :: GaugeCache -> Bool -> STM ()
retireCache :: GaugeCache -> STM ()
type SeriesKey = (Text, [(Text, Text)])
data Baseline
riseSince :: SeriesKey -> Double -> Double -> HashMap SeriesKey Baseline -> (HashMap SeriesKey Baseline, Double)

Documentation

data SnapshotSource #

Values from one database scan.

Constructors

Snapshot
Fields queues :: [QueueOverview] One overview per registry queue. db :: Maybe PgDbHealth Database counters. `Nothing` when the database reports no row. tables :: [PgTableHealth] Health counters per arbiter table. concurrency :: [ConcurrencyPolicyView] One view per concurrency policy. rateLimits :: [RateLimitPolicyView] One view per rate-limit policy.

Instances

Instances details

FromJSON Snapshot Source #

Instance details

Defined in Arbiter.Otel.Gauges.Cache

Methods

parseJSON :: Value -> Parser Snapshot#

parseJSONList :: Value -> Parser [Snapshot]#

omittedField :: Maybe Snapshot#

ToJSON Snapshot Source #

Instance details

Defined in Arbiter.Otel.Gauges.Cache

Methods

toJSON :: Snapshot -> Value#

toEncoding :: Snapshot -> Encoding#

toJSONList :: [Snapshot] -> Value#

toEncodingList :: [Snapshot] -> Encoding#

omitField :: Snapshot -> Bool#

Generic Snapshot Source #

Instance details

Defined in Arbiter.Otel.Gauges.Cache

Associated Types

type Rep Snapshot

Instance details

Defined in Arbiter.Otel.Gauges.Cache

type Rep Snapshot = D1 ('MetaData "Snapshot" "Arbiter.Otel.Gauges.Cache" "arbiter-otel-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Snapshot" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [QueueOverview]) :*: S1 ('MetaSel ('Just "db") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PgDbHealth))) :*: (S1 ('MetaSel ('Just "tables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PgTableHealth]) :*: (S1 ('MetaSel ('Just "concurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ConcurrencyPolicyView]) :*: S1 ('MetaSel ('Just "rateLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RateLimitPolicyView])))))

Methods

from :: Snapshot -> Rep Snapshot x#

to :: Rep Snapshot x -> Snapshot#

type Rep Snapshot Source #

Instance details

Defined in Arbiter.Otel.Gauges.Cache

type Rep Snapshot = D1 ('MetaData "Snapshot" "Arbiter.Otel.Gauges.Cache" "arbiter-otel-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Snapshot" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [QueueOverview]) :*: S1 ('MetaSel ('Just "db") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PgDbHealth))) :*: (S1 ('MetaSel ('Just "tables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PgTableHealth]) :*: (S1 ('MetaSel ('Just "concurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ConcurrencyPolicyView]) :*: S1 ('MetaSel ('Just "rateLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RateLimitPolicyView])))))

data CachedSource #

A snapshot and the monotonic time at which its scan started.

Constructors

Cached
Fields takenAt :: Double Monotonic time at which the scan started. reading :: Snapshot

data ExportSource #

Instrument export state. Idle retains the last scan time, if available.

Constructors

Live Cached	Export the readings of this scan.
Idle (Maybe Double)	Export nothing. Keep the last scan time, if any.

live :: Export -> Maybe CachedSource #

The scan behind an export, if it has one.

lastScan :: Export -> Maybe DoubleSource #

When the export was last scanned, if it ever was.

retire :: Export -> ExportSource #

Stop exporting readings, keeping when the last one was scanned.

data GaugeCacheSource #

Mutable gauge state and its registration time.

Constructors

GaugeCache
Fields export :: TVar Export What the instruments export now. databaseReachable :: TVar (Maybe Bool) Whether the last gauge scan reached the database. `Nothing` before the first scan. registeredAt :: Double Monotonic time of the registration.

newGaugeCache :: Double -> IO GaugeCacheSource #

Create an empty gauge cache for a registration starting at now.

publishSnapshot :: GaugeCache -> Cached -> STM ()Source #

Publish a snapshot to the observable instruments.

setReachable :: GaugeCache -> Bool -> STM ()Source #

Record whether the last gauge scan reached the database.

retireCache :: GaugeCache -> STM ()Source #

Stop exporting the cached snapshot.

type SeriesKey = (Text, [(Text, Text)])Source #

One counter series: its instrument and attributes.

data BaselineSource #

The scan a counter series was last counted from, and the total it stood at.

riseSince :: SeriesKey -> Double -> Double -> HashMap SeriesKey Baseline -> (HashMap SeriesKey Baseline, Double)Source #

Arguments

:: SeriesKey
-> Double	Monotonic time the total was scanned at.
-> Double	The scanned total.
-> HashMap SeriesKey Baseline
-> (HashMap SeriesKey Baseline, Double)

What a scanned total adds to its series.