Safe Haskell	None
Language	GHC2024

Arbiter.Core.Worker

Description

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

Types and DDL for the arbiter_workers table.

Synopsis

data WorkerRow = WorkerRow {
- workerId :: UUID
- queueName :: Text
- hostName :: Maybe Text
- workerCount :: Maybe Int32
- startedAt :: UTCTime
- lastHeartbeat :: UTCTime
- shuttingDown :: Bool
- paused :: Bool
- staleThresholdSecs :: Double
- metadata :: Maybe Value
- health :: WorkerHealth
}
data WorkerHealth
- = Live
- | Stale
- | Draining
workerHealthToText :: WorkerHealth -> Text
workerHealthFromText :: Text -> Either Text WorkerHealth
arbiterWorkersTable :: SchemaName -> Text
arbiterWorkersTableName :: Text
createWorkersTableSQL :: SchemaName -> Text

Documentation

data WorkerRowSource #

A row in the worker registry. One row per running worker.

Constructors

WorkerRow

Fields

workerId :: UUID
The worker's id.
queueName :: Text
The queue the worker works.
hostName :: Maybe Text
The host the worker runs on.
workerCount :: Maybe Int32
The worker's thread count.
startedAt :: UTCTime
When the worker registered.
lastHeartbeat :: UTCTime
When the worker last sent a heartbeat.
shuttingDown :: Bool
Whether the worker is draining.
paused :: Bool
The worker's own pause flag. The queue's flag is separate.
staleThresholdSecs :: Double
Heartbeat age in seconds after which the worker counts as stale.
metadata :: Maybe Value
Free-form metadata the worker registered.
health :: WorkerHealth
Health derived from the heartbeat and the shutdown flag.

Instances

Instances details

FromJSON WorkerRow Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

parseJSON :: Value -> Parser WorkerRow#

parseJSONList :: Value -> Parser [WorkerRow]#

omittedField :: Maybe WorkerRow#

ToJSON WorkerRow Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

toJSON :: WorkerRow -> Value#

toEncoding :: WorkerRow -> Encoding#

toJSONList :: [WorkerRow] -> Value#

toEncodingList :: [WorkerRow] -> Encoding#

omitField :: WorkerRow -> Bool#

Eq WorkerRow Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

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

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

Generic WorkerRow Source #

Instance details

Defined in Arbiter.Core.Worker

Associated Types

type Rep WorkerRow

Instance details

Defined in Arbiter.Core.Worker

Methods

from :: WorkerRow -> Rep WorkerRow x#

to :: Rep WorkerRow x -> WorkerRow#

Show WorkerRow Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

showsPrec :: Int -> WorkerRow -> ShowS#

show :: WorkerRow -> String#

showList :: [WorkerRow] -> ShowS#

type Rep WorkerRow Source #

Instance details

Defined in Arbiter.Core.Worker

data WorkerHealthSource #

Heartbeat-derived health of a worker. Independent of its paused flag.

Constructors

Live	The heartbeat is fresh and the worker is not shutting down.
Stale	The last heartbeat is older than the worker's stale threshold.
Draining	The heartbeat is fresh and the worker is shutting down.

Instances

Instances details

FromJSON WorkerHealth Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

parseJSON :: Value -> Parser WorkerHealth#

parseJSONList :: Value -> Parser [WorkerHealth]#

omittedField :: Maybe WorkerHealth#

ToJSON WorkerHealth Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

toJSON :: WorkerHealth -> Value#

toEncoding :: WorkerHealth -> Encoding#

toJSONList :: [WorkerHealth] -> Value#

toEncodingList :: [WorkerHealth] -> Encoding#

omitField :: WorkerHealth -> Bool#

Eq WorkerHealth Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

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

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

Bounded WorkerHealth Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

minBound :: WorkerHealth#

maxBound :: WorkerHealth#

Enum WorkerHealth Source #

Instance details

Defined in Arbiter.Core.Worker

Methods

succ :: WorkerHealth -> WorkerHealth#

pred :: WorkerHealth -> WorkerHealth#

toEnum :: Int -> WorkerHealth#

fromEnum :: WorkerHealth -> Int#

enumFrom :: WorkerHealth -> [WorkerHealth]#

enumFromThen :: WorkerHealth -> WorkerHealth -> [WorkerHealth]#

enumFromTo :: WorkerHealth -> WorkerHealth -> [WorkerHealth]#

enumFromThenTo :: WorkerHealth -> WorkerHealth -> WorkerHealth -> [WorkerHealth]#

Generic WorkerHealth Source #

Instance details

Defined in Arbiter.Core.Worker

Associated Types

type Rep WorkerHealth
Instance details Defined in Arbiter.Core.Worker type Rep WorkerHealth = D1 ('MetaData "WorkerHealth" "Arbiter.Core.Worker" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Live" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Stale" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Draining" 'PrefixI 'False) (U1 :: Type -> Type)))