Documentation
¶
Overview ¶
Package events defines Tako's canonical engine event schema. Engine operations emit a typed event stream that renderers consume: the CLI renders events as human output, and machine consumers read them as NDJSON. The schema follows the same additive versioning rules as the other takoapi documents.
Index ¶
Constants ¶
const ( // APIVersionV1Alpha1 is the first additive event schema version. APIVersionV1Alpha1 = "tako.redentor.dev/v1alpha1" // APIVersionCurrent points at the current event schema version for new events. APIVersionCurrent = APIVersionV1Alpha1 // KindEvent identifies a canonical engine event document. KindEvent = "Event" )
const ( PhasePlan = "plan" PhaseBuild = "build" PhaseDeploy = "deploy" PhaseState = "state" PhaseCleanup = "cleanup" PhaseDomains = "domains" PhaseNotify = "notify" PhaseLogs = "logs" )
Phases group events into the coarse stages a UI presents. They collapse the engine's internal pipeline steps into user-meaningful stages.
const ( TypePhaseStarted = "phase.started" TypePhaseCompleted = "phase.completed" TypeLogLine = "log.line" TypePlanComputed = "plan.computed" TypePlanConfirmationRequired = "plan.confirmation_required" TypePlanUpToDate = "plan.up_to_date" TypeDeployStarted = "deploy.started" TypeDeployServiceStarted = "deploy.service.started" TypeDeployServiceReconciled = "deploy.service.reconciled" TypeDeployServiceWarmed = "deploy.service.warmed" TypeDeployServiceFailed = "deploy.service.failed" TypeDeployServiceRemoved = "deploy.service.removed" TypeDeploySucceeded = "deploy.succeeded" TypeDeployFailed = "deploy.failed" TypeDeployCancelled = "deploy.cancelled" TypeProxyReconciled = "proxy.reconciled" TypeRevisionsPruned = "revisions.pruned" TypeStatePersisted = "state.persisted" TypeStateReplicated = "state.replicated" TypeCleanupCompleted = "cleanup.completed" TypeNotificationSent = "notification.sent" TypeDomainStatus = "domain.status" TypeWarning = "warning" // TypeResult is the terminal event carrying the operation result document // in machine-output mode. TypeResult = "result" )
Event types. Consumers must tolerate unknown types (additive schema).
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BufferSink ¶
type BufferSink struct {
// contains filtered or unexported fields
}
BufferSink retains emitted events in order, for tests and for consumers that assemble a result after the fact.
func (*BufferSink) Emit ¶
func (b *BufferSink) Emit(event Event)
func (*BufferSink) Events ¶
func (b *BufferSink) Events() []Event
Events returns a copy of the buffered events in emission order.
type Event ¶
type Event struct {
APIVersion string `json:"apiVersion"`
Kind string `json:"kind"`
Seq int64 `json:"seq"`
Time time.Time `json:"time"`
Type string `json:"type"`
Phase string `json:"phase,omitempty"`
Level Level `json:"level"`
Service string `json:"service,omitempty"`
Node string `json:"node,omitempty"`
Message string `json:"message,omitempty"`
Data map[string]any `json:"data,omitempty"`
}
Event is one entry in an engine operation's event stream. Message is the human-readable rendering; Data carries the typed payload for machine consumers. Consumers must ignore unknown fields and unknown Data keys.
type FanoutSink ¶
type FanoutSink struct {
// contains filtered or unexported fields
}
FanoutSink forwards each event to every child sink in order.
func NewFanoutSink ¶
func NewFanoutSink(sinks ...Sink) *FanoutSink
func (*FanoutSink) Emit ¶
func (f *FanoutSink) Emit(event Event)
type NDJSONSink ¶
type NDJSONSink struct {
// contains filtered or unexported fields
}
NDJSONSink writes one JSON document per event line. Write errors are dropped: event emission must never fail an operation.
func NewNDJSONSink ¶
func NewNDJSONSink(writer io.Writer) *NDJSONSink
func (*NDJSONSink) Emit ¶
func (n *NDJSONSink) Emit(event Event)
type Sink ¶
type Sink interface {
Emit(Event)
}
Sink consumes engine events. Implementations must be safe for concurrent use; engine operations may emit from multiple goroutines.
type Stream ¶
type Stream struct {
// contains filtered or unexported fields
}
Stream stamps events with sequence numbers, timestamps, and schema identity, applies a redaction function to all string content, and forwards them to a sink. All engine emissions go through a Stream so no event can bypass redaction.
func NewStream ¶
NewStream wraps sink. redact may be nil for streams that carry no secret material (tests); engine operations must always pass a redactor.
func (*Stream) Emit ¶
Emit stamps and forwards one event. Message and string Data values pass through the redactor.
func (*Stream) SetNowFunc ¶
SetNowFunc overrides the timestamp source, for deterministic tests.
Source Files