Safe Haskell	None
Language	GHC2021

Ecluse.Runtime.Env

Contents

Composition root
Runtime projections
Worker heartbeat (re-exported from Ecluse.Core.Worker)

Description

The composition root: the single record every effectful component is reached through, and the one place backend choice is resolved. Each handle it holds is an opaque record of functions whose closures already capture their backend's private state, so no cloud SDK appears here and nothing downstream inspects which backend it got. That is what keeps an adapter from importing back into this module. It also carries the http-client Manager the data plane shares. The single-process proxy and the split deployment both wire up here and nowhere else. Consumers read it through a projection: serveRuntimeOf per request, workerRuntimeOf for the worker.

Synopsis

data Env = Env {
- envServeAdmission :: ServeAdmission
- envMemoryMeter :: MemoryMeter
- envQueue :: MirrorQueue
- envManager :: Manager
- envPrivateManager :: Manager
- envMetadataCache :: MetadataCache
- envLogEnv :: LogEnv
- envTelemetry :: Telemetry
- envMetrics :: Metrics
- envDdContext :: DdContext
- envWorkerHeartbeat :: WorkerHeartbeat
}
newEnvWithAdmission :: ServeAdmission -> MemoryMeter -> MirrorQueue -> Manager -> Manager -> MetadataCache -> LogEnv -> Telemetry -> WorkerHeartbeat -> IO Env
withEnvWithAdmission :: MonadIO m => ServeAdmission -> MemoryMeter -> MirrorQueue -> Manager -> Manager -> MetadataCache -> LogEnv -> Telemetry -> WorkerHeartbeat -> (Env -> m a) -> m a
serveRuntimeOf :: Env -> ServeRuntime
workerRuntimeOf :: WorkerPolicies -> Env -> WorkerRuntime
data WorkerHeartbeat
newWorkerHeartbeat :: IO WorkerHeartbeat
recordPoll :: WorkerHeartbeat -> UTCTime -> IO ()
lastPoll :: WorkerHeartbeat -> IO (Maybe UTCTime)

Composition root

data Env Source #

The composition-root record from which the whole effectful shell is reached.

Constructors

Env

Fields

envServeAdmission :: ServeAdmission
The process-wide brief-wait bound for metadata-bearing serve work (Ecluse.Core.Server.Admission). Every mount shares this one aggregate cap and waiting room.
envMemoryMeter :: MemoryMeter
The process-wide memory budget every serving mount pays into.
envQueue :: MirrorQueue
The mirror-queue handle: the durable hand-off from the request path to the mirror worker.
envManager :: Manager
The shared validating-TLS Manager for the untrusted data plane. Egress is https-only, so certificate validation authenticates the host a dist.tarball names.
envPrivateManager :: Manager
The Manager for the trusted private upstream, held to the same https-only requirement. The split stays because credential handling differs.
envMetadataCache :: MetadataCache
Selected-version and assembled retention with transient full-read coalescing.
envLogEnv :: LogEnv
The katip logging environment (see Ecluse.Runtime.Log): the structured-log stream every layer attaches context to. Its stdout scribe and format are chosen at startup.
envTelemetry :: Telemetry
The OpenTelemetry handle (Ecluse.Runtime.Telemetry) that emits spans and metrics. It is an inert no-op unless ECLUSE_OBSERVABILITY__TELEMETRY is set.
envMetrics :: Metrics
The ecluse.* metric instruments (Ecluse.Runtime.Telemetry.Instruments), built once from envTelemetry. They are inert when telemetry is off, so a layer records unconditionally.
envDdContext :: DdContext
The resolved dd log identity (service/env/version, see Ecluse.Runtime.Telemetry.Correlation). Each log line adds the active span's trace/span ids.
envWorkerHeartbeat :: WorkerHeartbeat
The time of the mirror worker's last successful poll (Ecluse.Core.Worker). The liveness probe reads it, so a stalled worker shows up in health, separately from HTTP readiness.

newEnvWithAdmission :: ServeAdmission -> MemoryMeter -> MirrorQueue -> Manager -> Manager -> MetadataCache -> LogEnv -> Telemetry -> WorkerHeartbeat -> IO Env Source #

Assemble an Env from its built handles and the two data-plane Managers, one per origin. The caller supplies each handle and owns its lifetime, so assembly opens no socket itself.

withEnvWithAdmission :: MonadIO m => ServeAdmission -> MemoryMeter -> MirrorQueue -> Manager -> Manager -> MetadataCache -> LogEnv -> Telemetry -> WorkerHeartbeat -> (Env -> m a) -> m a Source #

Assemble an Env and run an action in its scope, the scope the server and worker run in. The root borrows every resource it holds, so it has nothing to release and needs no bracket.

Runtime projections

serveRuntimeOf :: Env -> ServeRuntime Source #

Project the ServeRuntime the serve path closes over, built per request at dispatch. The core pipeline reads its backends through it without depending on this application Env.

workerRuntimeOf :: WorkerPolicies -> Env -> WorkerRuntime Source #

Project the WorkerRuntime the mirror worker closes over. WorkerPolicies is an argument because it derives from the served mounts, and the worker re-runs it through the serve gate.

Worker heartbeat (re-exported from Ecluse.Core.Worker)

data WorkerHeartbeat #

newWorkerHeartbeat :: IO WorkerHeartbeat #

recordPoll :: WorkerHeartbeat -> UTCTime -> IO () #

lastPoll :: WorkerHeartbeat -> IO (Maybe UTCTime) #