| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Control.Concurrent.Capataz.Internal.Types
Description
This module contains all the types used across all the other modules
- type CapatazId = UUID
- type WorkerId = UUID
- type SupervisorId = UUID
- type ProcessId = UUID
- type WorkerAction m = WorkerId -> m ()
- type ProcessName = Text
- type CapatazName = Text
- type SupervisorName = Text
- type WorkerName = Text
- type RestartCount = Int
- type ProcessMap m = HashMap ProcessId (Process m)
- type ParentSupervisor = Supervisor
- newtype ProcessThreadId = PTID ThreadId
- data CapatazEvent
- = InvalidSupervisorStatusReached { }
- | SupervisorStatusChanged { }
- | ProcessTerminated { }
- | ProcessStarted { }
- | ProcessRestarted { }
- | ProcessCompleted { }
- | ProcessFailed { }
- | ProcessCallbackExecuted { }
- | ProcessTerminationStarted { }
- | ProcessTerminationFinished { }
- | CapatazFailed { }
- | CapatazTerminated { }
- data WorkerTerminationPolicy
- defWorkerTerminationPolicy :: WorkerTerminationPolicy
- data ProcessRestartAction
- data ProcessTerminationOrder
- defProcessTerminationOrder :: ProcessTerminationOrder
- data SupervisorRestartStrategy
- defSupervisorRestartStategy :: SupervisorRestartStrategy
- data CapatazOptions m = CapatazOptions {
- supervisorName :: !SupervisorName
- supervisorIntensity :: !Int
- supervisorPeriodSeconds :: !NominalDiffTime
- supervisorRestartStrategy :: !SupervisorRestartStrategy
- supervisorProcessSpecList :: ![ProcessSpec m]
- supervisorProcessTerminationOrder :: !ProcessTerminationOrder
- supervisorOnIntensityReached :: !(m ())
- supervisorOnFailure :: !(SomeException -> m ())
- notifyEvent :: !(CapatazEvent -> m ())
- data WorkerRestartStrategy
- defWorkerRestartStrategy :: WorkerRestartStrategy
- data WorkerOptions m = WorkerOptions {
- workerAction :: WorkerAction m
- workerName :: !WorkerName
- workerOnFailure :: !(SomeException -> m ())
- workerOnCompletion :: !(m ())
- workerOnTermination :: !(m ())
- workerTerminationPolicy :: !WorkerTerminationPolicy
- workerRestartStrategy :: !WorkerRestartStrategy
- data Worker m = Worker {
- workerId :: !WorkerId
- workerAsync :: !(Async ())
- workerCreationTime :: !UTCTime
- workerName :: !WorkerName
- workerOptions :: !(WorkerOptions m)
- data ProcessEnv = ProcessEnv {}
- data SupervisorOptions m = SupervisorOptions {
- supervisorName :: Text
- supervisorIntensity :: !Int
- supervisorPeriodSeconds :: !NominalDiffTime
- supervisorRestartStrategy :: !SupervisorRestartStrategy
- supervisorProcessSpecList :: ![ProcessSpec m]
- supervisorProcessTerminationOrder :: !ProcessTerminationOrder
- supervisorOnIntensityReached :: !(m ())
- supervisorOnFailure :: !(SomeException -> m ())
- data Supervisor m = Supervisor {
- supervisorId :: !SupervisorId
- supervisorName :: !SupervisorName
- supervisorOptions :: !(SupervisorOptions m)
- supervisorCreationTime :: !UTCTime
- supervisorAsync :: !(Async ())
- supervisorNotify :: SupervisorMessage m -> m ()
- supervisorEnv :: !(SupervisorEnv m)
- data ControlAction m
- = ForkWorker {
- workerOptions :: !(WorkerOptions m)
- returnWorkerId :: !(WorkerId -> m ())
- | ForkSupervisor {
- supervisorOptions :: !(SupervisorOptions m)
- returnSupervisor :: !(Supervisor m -> m ())
- | TerminateProcess {
- processId :: !ProcessId
- processTerminationReason :: !Text
- notifyProcessTermination :: !(Bool -> m ())
- = ForkWorker {
- data CapatazSignal
- data CapatazError = SupervisorIntensityReached {}
- data CallbackType
- data ProcessType
- data ProcessError = ProcessCallbackFailed {}
- data MonitorEvent
- = ProcessTerminated' { }
- | ProcessFailed' { }
- | ProcessCompleted' { }
- | ProcessForcedRestart { }
- data SupervisorStatus
- = Initializing
- | Running
- | Halting
- | Halted
- data SupervisorMessage m
- data Process m
- = WorkerProcess !(Worker m)
- | SupervisorProcess !(Supervisor m)
- data ProcessSpec m
- = WorkerSpec (WorkerOptions m)
- | SupervisorSpec (SupervisorOptions m)
- data Capataz m = Capataz {
- capatazSupervisor :: !(Supervisor m)
- capatazTeardown :: !Teardown
- data ParentSupervisorEnv m = ParentSupervisorEnv {
- supervisorId :: !SupervisorId
- supervisorName :: !SupervisorName
- supervisorNotify :: !(SupervisorMessage m -> m ())
- notifyEvent :: !(CapatazEvent -> m ())
- data SupervisorEnv m = SupervisorEnv {
- supervisorId :: !SupervisorId
- supervisorName :: !SupervisorName
- supervisorNotify :: !(SupervisorMessage m -> m ())
- supervisorGetNotification :: !(STM (SupervisorMessage m))
- supervisorProcessMap :: !(IORef (ProcessMap m))
- supervisorStatusVar :: !(TVar SupervisorStatus)
- supervisorOptions :: !(SupervisorOptions m)
- supervisorIntensity :: !Int
- supervisorPeriodSeconds :: !NominalDiffTime
- supervisorRestartStrategy :: !SupervisorRestartStrategy
- supervisorProcessTerminationOrder :: !ProcessTerminationOrder
- supervisorOnIntensityReached :: !(m ())
- supervisorOnIntensityReached :: !(SomeException -> m ())
- notifyEvent :: !(CapatazEvent -> m ())
- defCapatazOptions :: Monad m => Text -> (CapatazOptions m -> CapatazOptions m) -> CapatazOptions m
- supervisorSpec :: Monad m => SupervisorName -> (SupervisorOptions m -> SupervisorOptions m) -> ProcessSpec m
- supervisorSpecWithDefaults :: Monad m => SupervisorName -> ProcessSpec m
- workerSpec :: Monad m => WorkerName -> m () -> (WorkerOptions m -> WorkerOptions m) -> ProcessSpec m
- workerSpec1 :: Monad m => WorkerName -> (WorkerId -> m ()) -> (WorkerOptions m -> WorkerOptions m) -> ProcessSpec m
- workerSpecWithDefaults :: Monad m => WorkerName -> m () -> ProcessSpec m
- buildSupervisorOptions :: Monad m => SupervisorName -> (SupervisorOptions m -> SupervisorOptions m) -> SupervisorOptions m
- buildSupervisorOptionsWithDefaults :: Monad m => SupervisorName -> SupervisorOptions m
- buildWorkerOptions :: Monad m => WorkerName -> m () -> (WorkerOptions m -> WorkerOptions m) -> WorkerOptions m
- buildWorkerOptions1 :: Monad m => WorkerName -> (WorkerId -> m ()) -> (WorkerOptions m -> WorkerOptions m) -> WorkerOptions m
- buildWorkerOptionsWithDefaults :: Monad m => WorkerName -> m () -> WorkerOptions m
- getMaskingState :: MonadIO m => m MaskingState
- unsafeTry :: (Exception e, MonadUnliftIO m) => m a -> m (Either e a)
- fromAnyException :: Exception e => SomeException -> Maybe e
Documentation
type SupervisorId = UUID Source #
type WorkerAction m = WorkerId -> m () Source #
type ProcessName = Text Source #
type CapatazName = Text Source #
type SupervisorName = Text Source #
type WorkerName = Text Source #
type RestartCount = Int Source #
type ParentSupervisor = Supervisor Source #
newtype ProcessThreadId Source #
Wrapper for ThreadId
Since: 0.2.0.0
Instances
| Eq ProcessThreadId Source # | |
| Show ProcessThreadId Source # | |
| Generic ProcessThreadId Source # | |
| Pretty ProcessThreadId Source # | Since: 0.2.0.0 |
| type Rep ProcessThreadId Source # | |
data CapatazEvent Source #
Event delivered to the $sel:notifyEvent:ParentSupervisorEnv callback sub-routine; these events can
be used to monitor the capataz system and track what is doing, providing high
levels of telemetry for all supervisors and workers of a capataz system,
ergo, should be used for logging, monitoring and testing purposes.
Since: 0.1.0.0
Constructors
Instances
| Show CapatazEvent Source # | |
| Generic CapatazEvent Source # | |
| Pretty CapatazEvent Source # | Since: 0.2.0.0 |
| Display CapatazEvent Source # | Since: 0.2.0.0 |
| type Rep CapatazEvent Source # | |
data WorkerTerminationPolicy Source #
Defines how a Worker process termination should be handled by its
supervisor.
Since: 0.0.0.0
Constructors
| Infinity | Supervisor waits until infinity for the worker termination callback to finish execution. |
| BrutalTermination | Supervisor terminates worker process without a chance to call its termination callback. |
| TimeoutMillis !Int | Supervisor allows a number of milliseconds for worker termination callback complete, if not completed by specified milliseconds the termination is cancelled via a BrutalTermination signal. |
defWorkerTerminationPolicy :: WorkerTerminationPolicy Source #
Default worker termination is a timeout of three (3) seconds.
Since: 0.2.0.0
data ProcessRestartAction Source #
Internal helper record that assesses if a Supervisor error intensity has been breached.
Constructors
| ResetRestartCount | Indicates a Supervisor to restart a failed process _and_ reset the restart count given this Supervisor's intensity period timeout has passed. |
| IncreaseRestartCount | Indicates a Supervisor to restart the failed process _and_ increase the restart count (normal operation) of the supervised process. |
| HaltSupervisor | Indicates a Supervisor stop executing given the error intensity has been breached. |
data ProcessTerminationOrder Source #
Specifies the order in which supervised process should be terminated by a Supervisor in case of a restart or shutdown.
Since: 0.0.0.0
Constructors
| NewestFirst | Supervisor terminates supervised process from most recent to oldest. |
| OldestFirst | Supervisor terminates supervised process from oldest to most recent. |
defProcessTerminationOrder :: ProcessTerminationOrder Source #
Default termination order is OldestFirst.
Since: 0.2.0.0
data SupervisorRestartStrategy Source #
Specifies how a Supervisor restarts a failing process.
Since: 0.0.0.0
defSupervisorRestartStategy :: SupervisorRestartStrategy Source #
Default restart strategy is OneForOne.
Since: 0.2.0.0
data CapatazOptions m Source #
Allows to:
- Specify options for the root
Supervisorof a capataz system. - Provide a
$sel:notifyEvent:ParentSupervisorEnvcallback to monitor or log a capataz system.
Since: 0.1.0.0
Constructors
| CapatazOptions | |
Fields
| |
Instances
data WorkerRestartStrategy Source #
Specifies how a Supervisor deals with the lifecycle of worker process in case of completion without errors and failure.
defWorkerRestartStrategy :: WorkerRestartStrategy Source #
A worker default restart strategy is Transient.
data WorkerOptions m Source #
Specifies all options that can be used to create a Worker Process. You may
create a record of this type via the smart constructor buildWorkerOptions.
Since: 0.1.0.0
Constructors
| WorkerOptions | |
Fields
| |
Instances
| Generic (WorkerOptions m) Source # | |
| type Rep (WorkerOptions m) Source # | |
Record that contains the Async record (thread reference) of a worker
Since: 0.1.0.0
Constructors
| Worker | |
Fields
| |
data ProcessEnv Source #
Constructors
| ProcessEnv | |
Fields
| |
data SupervisorOptions m Source #
Constructors
| SupervisorOptions | |
Fields
| |
Instances
data Supervisor m Source #
Constructors
| Supervisor | |
Fields
| |
Instances
data ControlAction m Source #
Internal record that represents an action being sent from threads using the Capataz public API.
Constructors
| ForkWorker | |
Fields
| |
| ForkSupervisor | |
Fields
| |
| TerminateProcess | |
Fields
| |
Instances
| Generic (ControlAction m) Source # | |
| type Rep (ControlAction m) Source # | |
data CapatazSignal Source #
Internal exception thrown to the Capataz loop to indicate termination of execution
Constructors
| CapatazFailure | |
| RestartProcessException | |
| TerminateProcessException | |
Fields | |
| BrutallyTerminateProcessException | |
Fields | |
Instances
data CapatazError Source #
Internal exception triggered when a Worker violates error intensity specification
Constructors
| SupervisorIntensityReached | |
Fields
| |
Instances
data CallbackType Source #
Internal record that indicates what type of callback function is being invoked; this is used for telemetry purposes
Constructors
| OnCompletion | |
| OnFailure | |
| OnTermination |
Instances
data ProcessError Source #
Internal exception triggered when a callback of a Worker fails
Constructors
| ProcessCallbackFailed | |
Fields | |
Instances
data MonitorEvent Source #
Internal event delivered from Worker threads to the Capataz thread to indicate completion, failure or termination
Constructors
| ProcessTerminated' | |
Fields | |
| ProcessFailed' | |
Fields | |
| ProcessCompleted' | |
Fields
| |
| ProcessForcedRestart | |
Fields
| |
Instances
data SupervisorStatus Source #
Internal record used as a state machine, indicating the state of a supervisor process
Constructors
| Initializing | This state is set when the process is created and it starts spawning its static process list. |
| Running | This state is set when the supervisor process starts listenting to both ControlAction and MonitorEvent messages. |
| Halting | This state is set when the supervisor process is terminating it's assigned worker |
| Halted | This state is set when the supervisor process is finished |
data SupervisorMessage m Source #
Internal message delivered to a supervisor process that can either be a call from public API or an event from its monitored worker process.
Constructors
| ControlAction !(ControlAction m) | Represents a request from done to the supervisor thread from another thread using the public API |
| MonitorEvent !MonitorEvent | Represents an event (failure, completion, etc) from a monitored worker process to the supervisor |
Instances
| Generic (SupervisorMessage m) Source # | |
| type Rep (SupervisorMessage m) Source # | |
Internal Type to manage both Worker and Supervisor processes
Since: 0.1.0.0
Constructors
| WorkerProcess !(Worker m) | |
| SupervisorProcess !(Supervisor m) |
data ProcessSpec m Source #
Record used to specify how to build a runtime Process in a static
supervision tree; to create values of this type, you must use:
workerSpecorworkerSpecWithDefaultsto build a worker processsupervisorSpecorsupervisorSpecWithDefaultsto build a supervisor process
Since: 0.1.0.0
Constructors
| WorkerSpec (WorkerOptions m) | |
| SupervisorSpec (SupervisorOptions m) |
Record that contains the environment of a capataz monitor, this is used as the main record to create workers and to stop the supervisor thread.
Since: 0.0.0.0
Constructors
| Capataz | |
Fields
| |
Instances
data ParentSupervisorEnv m Source #
Internal utility record used to hold part of the runtime information of a supervisor that acts as a parent of another supervisor.
Constructors
| ParentSupervisorEnv | |
Fields
| |
data SupervisorEnv m Source #
Convenience internal utility record that contains all values related to a supervisor process.
Constructors
| SupervisorEnv | |
Fields
| |
Arguments
| :: Monad m | |
| => Text | |
| -> (CapatazOptions m -> CapatazOptions m) | Function to modify root supervisor |
| -> CapatazOptions m |
Builds a CapatazOptions record with defaults on how to create a capataz
root supervisor, these defaults are:
- Intensity error tolerance is set to 1 error every 5 seconds
- A
SupervisorRestartStrategyofOneForOne - A
ProcessTerminationOrderofOldestFirst
This function is intended to be used in combination with forkCapataz.
Since: 0.1.0.0
Arguments
| :: Monad m | |
| => SupervisorName | Name used for telemetry purposes |
| -> (SupervisorOptions m -> SupervisorOptions m) |
|
| -> ProcessSpec m |
Builds a ProcessSpec record for a supervisor process with defaults from
supervisorSpecWithDefaults. This function allows overrides of these
defaults using lenses.
This function is used when building a supervisor branch in a static supervision trees.
Since: 0.1.0.0
supervisorSpecWithDefaults Source #
Arguments
| :: Monad m | |
| => SupervisorName | Name used for telemetry purposes |
| -> ProcessSpec m |
Builds a ProcessSpec record for a supervisor process with defaults from
buildSupervisorOptionsWithDefaults.
This function is used when building a supervisor branch in a static supervision trees.
Since: 0.1.0.0
Arguments
| :: Monad m | |
| => WorkerName | Name used for telemetry purposes |
| -> m () |
|
| -> (WorkerOptions m -> WorkerOptions m) | Function to modify default worker options |
| -> ProcessSpec m |
Builds a ProcessSpec record for a worker process with defaults from
workerSpecWithDefaults. This function allows overrides of these
defaults using lenses.
This function is used when building a worker in a static supervision tree.
Since: 0.1.0.0
Arguments
| :: Monad m | |
| => WorkerName | Name used for telemetry purposes |
| -> (WorkerId -> m ()) | sub-routine to be supervised |
| -> (WorkerOptions m -> WorkerOptions m) | Function to modify default worker options |
| -> ProcessSpec m |
Builds a ProcessSpec record for a worker process with defaults from
workerSpecWithDefaults. This function allows overrides of these
defaults using lenses.
This function is used when building a worker in a static supervision tree.
The given sub-routine will receive the WorkerId as a parameter
Since: 0.2.0.0
workerSpecWithDefaults Source #
Arguments
| :: Monad m | |
| => WorkerName | Name used for telemetry purposes |
| -> m () | IO sub-routine to be supervised |
| -> ProcessSpec m |
Builds a ProcessSpec record for a worker process with defaults from
buildSupervisorOptionsWithDefaults.
This function is used when building a worker in a static supervision tree.
Since: 0.1.0.0
buildSupervisorOptions Source #
Arguments
| :: Monad m | |
| => SupervisorName | Name used for telemetry purposes |
| -> (SupervisorOptions m -> SupervisorOptions m) | Function to modify default supervisor options |
| -> SupervisorOptions m |
Builds a SupervisorOptions record with defaults from
buildSupervisorOptionsWithDefaults. This function allows overrides of these
defaults using lenses.
This function is intended to be used in combination with forkSupervisor.
Since: 0.1.0.0
buildSupervisorOptionsWithDefaults Source #
Arguments
| :: Monad m | |
| => SupervisorName | Name used for telemetry purposes |
| -> SupervisorOptions m |
Builds a SupervisorOptions record with defaults to create a supervisor
process, these defaults are:
- Intensity error tolerance is set to 1 error every 5 seconds
- A
SupervisorRestartStrategyofOneForOne - A
ProcessTerminationOrderofOldestFirst
This function is intended to be used in combination with forkSupervisor.
Since: 0.1.0.0
Arguments
| :: Monad m | |
| => WorkerName | Name used for telemetry purposes |
| -> m () | Process sub-routine to be supervised |
| -> (WorkerOptions m -> WorkerOptions m) | Function to modify default worker options |
| -> WorkerOptions m |
Builds a WorkerOptions record, keeps the defaults from
buildWorkerOptionsWithDefaults but allows overrides using lenses.
This function is intended to be used in combination with forkWorker. See the
capataz-simple-example project in the examples directory for a demonstration.
Since: 0.1.0.0
Arguments
| :: Monad m | |
| => WorkerName | Name used for telemetry purposes |
| -> (WorkerId -> m ()) | Process sub-routine to be supervised |
| -> (WorkerOptions m -> WorkerOptions m) | Function to modify default worker options |
| -> WorkerOptions m |
Builds a WorkerOptions record, keeps the defaults from
buildWorkerOptionsWithDefaults but allows overrides using lenses.
This function is intended to be used in combination with forkWorker. See the
capataz-simple-example project in the examples directory for a demonstration.
The given sub-routine will receive the WorkerId as a parameter.
Since: 0.2.0.0
buildWorkerOptionsWithDefaults Source #
Arguments
| :: Monad m | |
| => WorkerName | Name used for telemetry purposes |
| -> m () |
|
| -> WorkerOptions m |
Builds a WorkerOptions record with defaults to create a worker process,
the defaults are:
- A
TransientWorkerRestartStrategy - A
WorkerTerminationPolicyof a 3 seconds timeout - A _completion_ callback that just returns unit
- A _termination_ callback that just returns unit
- A _failure_ callback that just returns unit
This function is intended to be used in combination with forkWorker, for creating a
worker in an static supervision tree, use workerSpecWithDefaults instead. See the
capataz-simple-example project in the examples directory for a demonstration.
Since: 0.1.0.0
getMaskingState :: MonadIO m => m MaskingState Source #
Used for debugging purposes
unsafeTry :: (Exception e, MonadUnliftIO m) => m a -> m (Either e a) Source #
Given we want to capture async exceptions to send them back to a supervisor and we are running on masked states, we need to have a try that catches all kinds of exceptions
fromAnyException :: Exception e => SomeException -> Maybe e Source #
Given unliftio wraps exceptions in 3 layers of Exceptions, and we are using vanilla exceptions, we need to make sure that we account for all different exception types