Safe Haskell	None
Language	GHC2021

Ecluse.Core.Telemetry.Record

Contents

The serve-path recording port
The worker recording port
The mirror sweep recording port
The advisory sync recording port
The advisory compile recording port
Timing

Description

Backend-neutral recording ports for the serve path, mirror worker, Dredger and advisory tasks. Each port accepts the bounded labels defined in Ecluse.Core.Telemetry.Metrics. The application supplies telemetry implementations. Polled gauges remain outside these ports.

Synopsis

data MetricsPort = MetricsPort {
- mpServeDecision :: Decision -> IO ()
- mpServeAdmissionInFlight :: Int -> IO ()
- mpServeAdmissionQueued :: IO ()
- mpMemoryAdmissionQueued :: IO ()
- mpMemoryAdmissionShed :: IO ()
- mpMemoryAdmissionPause :: IO ()
- mpMemoryAdmissionOverdraw :: IO ()
- mpPublishBodyInFlightBytes :: Int -> IO ()
- mpPublishBodyShed :: IO ()
- mpMergeDivergence :: IO ()
- mpRuleDenial :: Maybe Text -> ReasonClass -> IO ()
- mpRuleEvalDuration :: Tier -> Double -> IO ()
- mpRuleEffectfulFailure :: Cause -> IO ()
- mpUpstreamFetch :: Upstream -> StatusClass -> Double -> IO ()
- mpUpstreamFetchError :: Upstream -> Cause -> IO ()
- mpCacheRequest :: CacheResult -> IO ()
- mpVersionCacheRequest :: CacheResult -> IO ()
- mpAssembledCacheRequest :: CacheResult -> IO ()
- mpCacheRefused :: CacheStore -> IO ()
- mpCacheEntries :: Int -> IO ()
- mpCacheResidentBytes :: Int -> IO ()
- mpVersionCacheResidentBytes :: Int -> IO ()
- mpAssembledCacheResidentBytes :: Int -> IO ()
- mpPublicRelayAnomaly :: RelayAnomaly -> IO ()
- mpRequestPerimeterFault :: RequestFaultCause -> IO ()
- mpMirrorEnqueued :: IO ()
- mpMirrorEnqueueFailure :: IO ()
}
data WorkerMetricsPort = WorkerMetricsPort {
- wmpMirrorJobProcessed :: MirrorResult -> IO ()
- wmpMirrorPublishDuration :: Double -> IO ()
}
newtype DredgerMetricsPort = DredgerMetricsPort {
- dmpSweptVersion :: SweepTarget -> SweepResult -> IO ()
}
data AdvisorySyncMetricsPort = AdvisorySyncMetricsPort {
- asmpSyncAttempt :: Ecosystem -> AdvisorySyncResult -> IO ()
- asmpSyncDuration :: Ecosystem -> AdvisorySyncResult -> Double -> IO ()
}
data AdvisoryCompileMetricsPort = AdvisoryCompileMetricsPort {
- acmpCompileAccepted :: Int -> IO ()
- acmpCompileDropped :: AdvisoryDropCause -> Int -> IO ()
- acmpCompileRun :: AdvisoryCompileResult -> IO ()
}
timedSeconds :: MonadIO m => m a -> m (a, Double)

The serve-path recording port

data MetricsPort Source #

The metric-recording port over a telemetry backend, one field per ecluse.* signal. The closed label types in Ecluse.Core.Telemetry.Metrics bound each signal's cardinality.

Constructors

MetricsPort

Fields

mpServeDecision :: Decision -> IO ()
Record one serve decision (ecluse.serve.decision): admit, deny, or unavailable.
mpServeAdmissionInFlight :: Int -> IO ()
Record a change (+1 or -1) to in-flight metadata parses (ecluse.serve.admission.in_flight).
mpServeAdmissionQueued :: IO ()
Record one admission that waited for a slot (ecluse.serve.admission.queued).
mpMemoryAdmissionQueued :: IO ()
Record one request that waited for its memory entry step (ecluse.serve.admission.memory.queued).
mpMemoryAdmissionShed :: IO ()
Record one request shed at the memory door (ecluse.serve.admission.memory.shed).
mpMemoryAdmissionPause :: IO ()
Record one started request pausing for memory (ecluse.serve.admission.memory.pauses).
mpMemoryAdmissionOverdraw :: IO ()
Record one step taken past the memory budget (ecluse.serve.admission.memory.overdraws).
mpPublishBodyInFlightBytes :: Int -> IO ()
Record a change in the bytes held for buffered publish bodies, the reserved weight signed (ecluse.publish.body.in_flight_bytes).
mpPublishBodyShed :: IO ()
Record one publish shed at the body-byte budget (ecluse.publish.body.shed).
mpMergeDivergence :: IO ()
Record one cross-upstream integrity divergence in the packument merge, once per contradicting version (ecluse.registry.merge.divergence).
mpRuleDenial :: Maybe Text -> ReasonClass -> IO ()
Record one rule denial (ecluse.rule.denials) by reason class and, for a policy denial, the deciding rule. A non-policy refusal carries no rule.
mpRuleEvalDuration :: Tier -> Double -> IO ()
Record a rule-evaluation latency sample (ecluse.rule.eval.duration) by tier.
mpRuleEffectfulFailure :: Cause -> IO ()
Record one effectful-rule failure (ecluse.rule.effectful.failures) by cause.
mpUpstreamFetch :: Upstream -> StatusClass -> Double -> IO ()
Record an upstream metadata-fetch latency sample (ecluse.upstream.fetch.duration).
mpUpstreamFetchError :: Upstream -> Cause -> IO ()
Record one upstream metadata-fetch error (ecluse.upstream.fetch.errors).
mpCacheRequest :: CacheResult -> IO ()
Full-store requests (ecluse.metadata_cache.requests).
mpVersionCacheRequest :: CacheResult -> IO ()
Selected-version requests (ecluse.metadata_cache.version.requests).
mpAssembledCacheRequest :: CacheResult -> IO ()
Assembled-response requests (ecluse.metadata_cache.assembled.requests).
mpCacheRefused :: CacheStore -> IO ()
Capacity refusals and external backend failures (ecluse.metadata_cache.refused).
mpCacheEntries :: Int -> IO ()
Record the metadata cache's current occupancy (ecluse.metadata_cache.entries).
mpCacheResidentBytes :: Int -> IO ()
The full-packument cache's resident bytes (ecluse.metadata_cache.resident_bytes).
mpVersionCacheResidentBytes :: Int -> IO ()
The single-version cache's bytes (ecluse.metadata_cache.version.resident_bytes).
mpAssembledCacheResidentBytes :: Int -> IO ()
The assembled store's bytes (ecluse.metadata_cache.assembled.resident_bytes).
mpPublicRelayAnomaly :: RelayAnomaly -> IO ()
Record one public artifact relay that did not carry the admitted artifact (ecluse.serve.relay.anomalies). Steady state is zero.
mpRequestPerimeterFault :: RequestFaultCause -> IO ()
Record one pre-commit handler escape the perimeter answered (ecluse.serve.perimeter.faults).
mpMirrorEnqueued :: IO ()
Record one mirror job accepted for enqueue (ecluse.mirror.enqueued): the serve path's hand-off to the buffer, not the backend write.
mpMirrorEnqueueFailure :: IO ()
Record one mirror enqueue failure (ecluse.mirror.enqueue.failures): a refused hand-off or a failed backend delivery.

The worker recording port

data WorkerMetricsPort Source #

The mirror worker's metric-recording port: the worker analogue of MetricsPort. The two consumers share no field. Ecluse.Runtime.Telemetry.Instruments supplies the OTel implementation.

Constructors

WorkerMetricsPort
Fields wmpMirrorJobProcessed :: MirrorResult -> IO () Record one processed mirror job by its terminal result (`ecluse.mirror.jobs.processed`). wmpMirrorPublishDuration :: Double -> IO () Record one mirror publish-latency sample (`ecluse.mirror.publish.duration`).

The mirror sweep recording port

newtype DredgerMetricsPort Source #

The mirror sweep's metric-recording port, recorded by Ecluse.Core.Registry.Sweep. The package and version a disposition concerns ride the sweep's own audit line, never a label.

Constructors

DredgerMetricsPort
Fields dmpSweptVersion :: SweepTarget -> SweepResult -> IO () Record one disposition of one examined version (`ecluse.dredger.versions`). A version counts once as examined and once under what the sweep did with it.

The advisory sync recording port

data AdvisorySyncMetricsPort Source #

The advisory sync task's metric-recording port, recorded by the sync loop in Ecluse.Runtime.Cve.Sync. Ecosystem and result are the only labels, so the series stays bounded.

Constructors

AdvisorySyncMetricsPort
Fields asmpSyncAttempt :: Ecosystem -> AdvisorySyncResult -> IO () Record one advisory sync attempt (`ecluse.advisory.sync.attempts`) by ecosystem and result. asmpSyncDuration :: Ecosystem -> AdvisorySyncResult -> Double -> IO () Record one sync attempt's latency in seconds (`ecluse.advisory.sync.duration`).

The advisory compile recording port

data AdvisoryCompileMetricsPort Source #

The Pilot compile's metric-recording port. One port is bound to one ecosystem, so no field carries the ecosystem the compile holds as free text.

Constructors

AdvisoryCompileMetricsPort

Fields

acmpCompileAccepted :: Int -> IO ()
The entries one compile pass accepted (ecluse.advisory.compile.accepted).
acmpCompileDropped :: AdvisoryDropCause -> Int -> IO ()
The entries one pass dropped for a cause (ecluse.advisory.compile.dropped). A pass with no drops records zero, so the series exists before the first drop.
acmpCompileRun :: AdvisoryCompileResult -> IO ()
Record how one compile pass concluded (ecluse.advisory.compile.runs).

Timing

timedSeconds :: MonadIO m => m a -> m (a, Double) Source #

Run an action and return its result with the elapsed seconds. It measures on the monotonic clock, so a system-clock step never yields a negative or absurd duration.