Safe Haskell	None
Language	GHC2024

Arbiter.Otel.Gauges.Cache

Description

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)
- counterBaselines :: IORef (HashMap SeriesKey Baseline)
- registeredAt :: Double
}
data Baseline
type SeriesKey = (Text, [(Text, Text)])
newGaugeCache :: Double -> IO GaugeCache
publishSnapshot :: GaugeCache -> Cached -> STM ()
setReachable :: GaugeCache -> Bool -> STM ()
retireCache :: GaugeCache -> STM ()
riseSince :: SeriesKey -> Double -> Double -> HashMap SeriesKey Baseline -> (HashMap SeriesKey Baseline, Double)

Documentation

Source #data Snapshot

Values from one database scan.

Constructors

Snapshot
Fields queues :: [QueueOverview] db :: Maybe PgDbHealth tables :: [PgTableHealth] concurrency :: [ConcurrencyPolicyView] rateLimits :: [RateLimitPolicyView]

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])))))

Source #data Cached

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

Constructors

Cached
Fields takenAt :: Double reading :: Snapshot

Source #data Export

What the instruments export. Idle keeps the last reading's scan time for the staleness series. Before the first scan it has none.

Constructors

Live Cached
Idle (Maybe Double)

Source #live :: Export -> Maybe Cached

The scan behind an export, if it has one.

Source #lastScan :: Export -> Maybe Double

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

Source #retire :: Export -> Export

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

Source #data GaugeCache

Mutable gauge state and its registration time.

Constructors

GaugeCache
Fields export :: TVar Export databaseReachable :: TVar (Maybe Bool) counterBaselines :: IORef (HashMap SeriesKey Baseline) registeredAt :: Double

Source #data Baseline

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

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

One counter series: its instrument and attributes.

Source #newGaugeCache :: Double -> IO GaugeCache

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

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

Publish a snapshot to the observable instruments.

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

Update the result of the last database operation.

Source #retireCache :: GaugeCache -> STM ()

Stop exporting the cached snapshot.

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

What a total scanned at scannedAt adds to its series. The first reading and an already counted reading add nothing. A reset counter adds the whole total. Any other reading adds the difference.