Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1/approval
Package approval is the operator->hiss ack surface: the Approval an operator emits through `trim approve` to release a held Candidate.
|
Package approval is the operator->hiss ack surface: the Approval an operator emits through `trim approve` to release a held Candidate. |
|
v1/decision
Package decision is the boundary vocabulary of the Governance Plane: the Decision that hiss emits after judging one proposal.Set, plus Governed, the envelope that carries a Decision and the Set it judged onward to thump.
|
Package decision is the boundary vocabulary of the Governance Plane: the Decision that hiss emits after judging one proposal.Set, plus Governed, the envelope that carries a Decision and the Set it judged onward to thump. |
|
v1/outcome
Package outcome is the boundary vocabulary of the Act beat (thump): the Outcome it emits after rendering (dry-run) or executing (live) the Decision it was granted.
|
Package outcome is the boundary vocabulary of the Act beat (thump): the Outcome it emits after rendering (dry-run) or executing (live) the Decision it was granted. |
|
v1/proposal
Package proposal is the boundary vocabulary of the Reasoning Plane: the ProposalSet and the value objects that ride it, shared by the beat that produces them (clank) and the beat that reads them (hiss).
|
Package proposal is the boundary vocabulary of the Reasoning Plane: the ProposalSet and the value objects that ride it, shared by the beat that produces them (clank) and the beat that reads them (hiss). |
|
v1/signal
Package signal holds the rattle⟷clank contract surface: the Detection that rattle (the Signal Plane) emits and clank (the Reasoning Plane) consumes read-only, plus the shared value objects (Severity, BlastRadius) that ride the boundary in both directions.
|
Package signal holds the rattle⟷clank contract surface: the Detection that rattle (the Signal Plane) emits and clank (the Reasoning Plane) consumes read-only, plus the shared value objects (Severity, BlastRadius) that ride the boundary in both directions. |
|
cmd
|
|
|
clank
command
|
|
|
hiss
command
|
|
|
rattle
command
|
|
|
thump
command
|
|
|
trim
command
|
|
|
internal
|
|
|
actuate
Package actuate is thump's imperative shell: the one place that turns an authored contract ref into a real mutation against the cluster.
|
Package actuate is thump's imperative shell: the one place that turns an authored contract ref into a real mutation against the cluster. |
|
beat
Package beat is the runtime kit every thump beat's Main composes: the process lifecycle (flags, logging, signal-driven shutdown) plus the two transports a beat runs on — the NATS consumer/publisher and the offline directory poll.
|
Package beat is the runtime kit every thump beat's Main composes: the process lifecycle (flags, logging, signal-driven shutdown) plus the two transports a beat runs on — the NATS consumer/publisher and the offline directory poll. |
|
broker
Package broker is the NATS JetStream plumbing a beat's Transport runs over: one shared stream, the fixed subject-to-consumer wiring, and (subscriber.go) a subscriber that sorts every delivery failure into exactly one of two doors — dead-letter now (the message will never decode) or retry with backoff up to the consumer's redelivery budget (the handler failed but might succeed next time).
|
Package broker is the NATS JetStream plumbing a beat's Transport runs over: one shared stream, the fixed subject-to-consumer wiring, and (subscriber.go) a subscriber that sorts every delivery failure into exactly one of two doors — dead-letter now (the message will never decode) or retry with backoff up to the consumer's redelivery budget (the handler failed but might succeed next time). |
|
clank
Package clank is the Reasoning Plane: it turns one Signal into a ranked, deduplicated, evidence-backed proposal.Set.
|
Package clank is the Reasoning Plane: it turns one Signal into a ranked, deduplicated, evidence-backed proposal.Set. |
|
config
Package config is each beat's typed, validated environment — a leaf package (leaf_test.go) so it can never grow an import into a beat's internals.
|
Package config is each beat's typed, validated environment — a leaf package (leaf_test.go) so it can never grow an import into a beat's internals. |
|
configtest
Package configtest loads the shipped action config for tests through the same loaders the beats use in production — a hand-edit that would break a running clank cannot pass CI, because no test here decodes a config file a second way.
|
Package configtest loads the shipped action config for tests through the same loaders the beats use in production — a hand-edit that would break a running clank cannot pass CI, because no test here decodes a config file a second way. |
|
contract
Package contract is the boundary vocabulary of the authored action catalog: the ActionContract and its scaffolding, shared by the beat that proposes from it (clank) and the beat that executes from it (thump).
|
Package contract is the boundary vocabulary of the authored action catalog: the ActionContract and its scaffolding, shared by the beat that proposes from it (clank) and the beat that executes from it (thump). |
|
converge
Package converge answers thump's one post-action question — "did this work?" — by reading Prometheus directly, the same instant-query shape internal/whir/resolve.go already uses to read topology health.
|
Package converge answers thump's one post-action question — "did this work?" — by reading Prometheus directly, the same instant-query shape internal/whir/resolve.go already uses to read topology health. |
|
hiss
Package hiss is the Governance Plane: one authority pass over a delivered proposal.Set, checking a confidence floor, an authority ceiling, an irreversibility veto, and freeze windows before clank's recommended Candidate may proceed.
|
Package hiss is the Governance Plane: one authority pass over a delivered proposal.Set, checking a confidence floor, an authority ceiling, an irreversibility veto, and freeze windows before clank's recommended Candidate may proceed. |
|
httpx
Package httpx is the one place an outbound HTTP client is built.
|
Package httpx is the one place an outbound HTTP client is built. |
|
leaftest
Package leaftest is the shared body of every leaf package's import tripwire.
|
Package leaftest is the shared body of every leaf package's import tripwire. |
|
ledger
Package ledger is the append-only, in-memory event log shared by the beats that keep one: hiss records every Decision it reaches, thump every Outcome it produces.
|
Package ledger is the append-only, in-memory event log shared by the beats that keep one: hiss records every Decision it reaches, thump every Outcome it produces. |
|
natstest
Package natstest spins up an embedded NATS+JetStream server for tests.
|
Package natstest spins up an embedded NATS+JetStream server for tests. |
|
notify/slack
Package slack delivers a held action to a Slack incoming webhook — the concrete Notifier thump injects at wiring time, kept in its own package so the HTTP client lives outside the reasoning/rendering beat, never inside it.
|
Package slack delivers a held action to a Slack incoming webhook — the concrete Notifier thump injects at wiring time, kept in its own package so the HTTP client lives outside the reasoning/rendering beat, never inside it. |
|
publish
Package publish is the outbound half of a beat's Transport: the Publisher port and three implementations over it — DirPublisher (the offline directory-poll write), JetPublisher (JetStream), and WALPublisher (the durability leg — journals every object to a local WAL before handing it to another Publisher, so the fact survives a crash between "decided" and "delivered").
|
Package publish is the outbound half of a beat's Transport: the Publisher port and three implementations over it — DirPublisher (the offline directory-poll write), JetPublisher (JetStream), and WALPublisher (the durability leg — journals every object to a local WAL before handing it to another Publisher, so the fact survives a crash between "decided" and "delivered"). |
|
publish/publishtest
Package publishtest provides the in-memory Publisher double beats reach for in tests.
|
Package publishtest provides the in-memory Publisher double beats reach for in tests. |
|
rattle
Package rattle is the Signal Plane: three pure detectors — burn-rate acceleration, sustained burn, multi-signal correlation, and historical- envelope breach — OR'd together in Reconciler.Reconcile, one detection per pass per SLO.
|
Package rattle is the Signal Plane: three pure detectors — burn-rate acceleration, sustained burn, multi-signal correlation, and historical- envelope breach — OR'd together in Reconciler.Reconcile, one detection per pass per SLO. |
|
s3test
Package s3test spins up an in-process, in-memory S3-compatible server for tests (gofakes3 over httptest, no Docker, no network) and returns a ready client.
|
Package s3test spins up an in-process, in-memory S3-compatible server for tests (gofakes3 over httptest, no Docker, no network) and returns a ready client. |
|
thump
Package thump is the Act beat: it renders (and, later, executes) a governed decision.Decision.
|
Package thump is the Act beat: it renders (and, later, executes) a governed decision.Decision. |
|
tracing
Package tracing mints the deterministic trace identity every beat derives independently from a signal.Detection.Fingerprint — never passed hand to hand, so rattle's root span and clank/hiss/thump's child spans land on the same Tempo trace without any beat trusting another beat's wire value.
|
Package tracing mints the deterministic trace identity every beat derives independently from a signal.Detection.Fingerprint — never passed hand to hand, so rattle's root span and clank/hiss/thump's child spans land on the same Tempo trace without any beat trusting another beat's wire value. |
|
trim
Package trim is the operator's read-model of the THUMP stream: it folds the boundary objects rattle, clank, hiss, and thump emit into one Incident per fingerprint.
|
Package trim is the operator's read-model of the THUMP stream: it folds the boundary objects rattle, clank, hiss, and thump emit into one Incident per fingerprint. |
|
whir
Package whir resolves topology: a static dependency graph (Backstage's catalog-info.yaml, parsed by Load) plus, optionally, a live health state per dependency (Resolver, backed by a Prometheus-shaped query API).
|
Package whir resolves topology: a static dependency graph (Backstage's catalog-info.yaml, parsed by Load) plus, optionally, a live health state per dependency (Resolver, backed by a Prometheus-shaped query API). |
|
wire
Package wire is the one codec every boundary object marshals through to cross a broker or WAL — a single chokepoint so the wire format (JSON today) is a one-line change, not a search-and-replace across every Publisher and Subscriber.
|
Package wire is the one codec every boundary object marshals through to cross a broker or WAL — a single chokepoint so the wire format (JSON today) is a one-line change, not a search-and-replace across every Publisher and Subscriber. |
Click to show internal directories.
Click to hide internal directories.