Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

supervisor

package

Go to main page

Versions in this module

v0

v0.3.7

Aug 8, 2026

v0.3.6

Aug 2, 2026

v0.3.5

Jul 27, 2026

v0.3.0

Jul 23, 2026

Changes in this version

+ var ErrAlreadyTerminal = errors.New("supervisor: attempt already terminal")

+ var ErrAttemptNotFound = errors.New("supervisor: attempt not found")

+ var ErrContextBoundExceeded = errors.New("supervisor: context bound exceeded")

+ var ErrDigestMismatch = errors.New("supervisor: result digest mismatch")

+ var ErrInvalidArgument = errors.New("supervisor: invalid argument")

+ var ErrInvalidHMAC = errors.New("supervisor: invalid HMAC")

+ var ErrLeaseMismatch = errors.New("supervisor: lease mismatch")

+ var ErrNotVerifiedResult = errors.New("supervisor: success requires verified result event")

+ type AuditLogger interface

+ Append func(record audit.AuditRecord) error

+ type CheckpointEvent struct

+ AttemptID routedrun.AttemptID

+ Checkpoint *routedrun.SemanticCheckpoint

+ HMAC string

+ LeaseID routedrun.LeaseID

+ type ClaimOptions struct

+ AttemptLeaseMs int64

+ ModelCallTimeoutMs int64

+ StallTimeoutMs int64

+ type ControlJournalFactory interface

+ OpenControlJournal func(runID routedrun.RunID, attemptID routedrun.AttemptID) (ControlJournalHandle, error)

+ type ControlJournalHandle interface

+ Append func(event routedrun.InvokeJobEvent) error

+ Close func() error

+ Read func(fromSeq int64) ([]routedrun.InvokeJobEvent, error)

+ type DurableStore interface

+ CreateAttempt func(ctx context.Context, attempt *routedrun.AttemptRecord) error

+ GetActiveTimeLedger func(ctx context.Context, workflowID routedrun.WorkflowID) (*routedrun.ActiveTimeLedger, error)

+ GetActiveTimeLedgerGeneration func(ctx context.Context, workflowID routedrun.WorkflowID) (int64, error)

+ GetAttempt func(ctx context.Context, attemptID routedrun.AttemptID) (*routedrun.AttemptRecord, error)

+ GetAttemptGeneration func(ctx context.Context, attemptID routedrun.AttemptID) (int64, error)

+ GetLatestCheckpoint func(ctx context.Context, attemptID routedrun.AttemptID) (*routedrun.SemanticCheckpoint, error)

+ GetRun func(ctx context.Context, runID routedrun.RunID) (*routedrun.RunRecord, error)

+ GetRunGeneration func(ctx context.Context, runID routedrun.RunID) (int64, error)

+ GetWorkflow func(ctx context.Context, workflowID routedrun.WorkflowID) (*routedrun.WorkflowRecord, error)

+ ListAttempts func(ctx context.Context, runID routedrun.RunID) ([]*routedrun.AttemptRecord, error)

+ PutActiveTimeLedger func(ctx context.Context, workflowID routedrun.WorkflowID, ...) error

+ SaveCheckpoint func(ctx context.Context, cp *routedrun.SemanticCheckpoint) error

+ UpdateAttempt func(ctx context.Context, attempt *routedrun.AttemptRecord, ...) error

+ UpdateRun func(ctx context.Context, run *routedrun.RunRecord, expectedGeneration int64) error

+ UpdateWorkflow func(ctx context.Context, wf *routedrun.WorkflowRecord, expectedGeneration int64) error

+ type GovernedOperationKind int

+ const GovernedOpHTTP

+ const GovernedOpMCP

+ const GovernedOpModel

+ const GovernedOpUnspecified

+ type ProgressEvent struct

+ AttemptID routedrun.AttemptID

+ HMAC string

+ LeaseID routedrun.LeaseID

+ Phase string

+ Sequence int64

+ Timestamp time.Time

+ type ReferenceWorker struct

+ func NewReferenceWorker(cfg ReferenceWorkerConfig) *ReferenceWorker

+ func (w *ReferenceWorker) ArtifactRefForPhase(phase int) string

+ func (w *ReferenceWorker) CheckpointDigestForPhase(phase int) string

+ func (w *ReferenceWorker) CheckpointDigests() []string

+ func (w *ReferenceWorker) CompletedTurns() []int

+ func (w *ReferenceWorker) ContextBound() int

+ func (w *ReferenceWorker) CurrentCheckpointID() string

+ func (w *ReferenceWorker) FinalResultDigest() string

+ func (w *ReferenceWorker) FinalResultResult() string

+ func (w *ReferenceWorker) GetInvocationID() routedrun.InvocationID

+ func (w *ReferenceWorker) GetRunID() routedrun.RunID

+ func (w *ReferenceWorker) GetWorkflowID() routedrun.WorkflowID

+ func (w *ReferenceWorker) MaxAccumulatedTokens() int

+ func (w *ReferenceWorker) ProgressSequences() []int64

+ func (w *ReferenceWorker) PromptForTurn(turn int) string

+ func (w *ReferenceWorker) Run(ctx context.Context, opts RunOptions) error

+ func (w *ReferenceWorker) TurnCount() int

+ type ReferenceWorkerConfig struct

+ ArtifactRoot string

+ AttemptID routedrun.AttemptID

+ ContextBound int

+ ControlKey []byte

+ InvocationID routedrun.InvocationID

+ LeaseID routedrun.LeaseID

+ RunID routedrun.RunID

+ Supervisor *Supervisor

+ WorkflowID routedrun.WorkflowID

+ type ResultEvent struct

+ ArtifactReferences []string

+ AttemptID routedrun.AttemptID

+ HMAC string

+ InvocationID routedrun.InvocationID

+ LeaseID routedrun.LeaseID

+ ResultDigest string

+ RunID routedrun.RunID

+ StructuredResult string

+ TerminalStatus routedrun.InvokeJobResultStatus

+ WorkflowID routedrun.WorkflowID

+ type ResultStore interface

+ GetInvokeJobResult func(ctx context.Context, runID routedrun.RunID) (*routedrun.InvokeJobResult, error)

+ SaveInvokeJobResult func(ctx context.Context, result *routedrun.InvokeJobResult) error

+ type RunOptions struct

+ ResumeFrom string

+ TargetTurns int

+ type Supervisor struct

+ func NewSupervisor(store DurableStore, results ResultStore, journals ControlJournalFactory, ...) (*Supervisor, error)

+ func (s *Supervisor) Cancel(ctx context.Context, attemptID routedrun.AttemptID) error

+ func (s *Supervisor) CheckStall(ctx context.Context, attemptID routedrun.AttemptID, env routedrun.TimeEnvelope) (bool, error)

+ func (s *Supervisor) ClaimForRun(ctx context.Context, runID routedrun.RunID, _ routedrun.InvocationID) (routedrun.AttemptID, error)

+ func (s *Supervisor) Finalize(ctx context.Context, attemptID routedrun.AttemptID) error

+ func (s *Supervisor) HandleCheckpoint(ctx context.Context, attemptID routedrun.AttemptID, event CheckpointEvent) error

+ func (s *Supervisor) HandleHTTPEnd(ctx context.Context, attemptID routedrun.AttemptID, leaseID routedrun.LeaseID) error

+ func (s *Supervisor) HandleHTTPStart(ctx context.Context, attemptID routedrun.AttemptID, leaseID routedrun.LeaseID) error

+ func (s *Supervisor) HandleMCPEnd(ctx context.Context, attemptID routedrun.AttemptID, leaseID routedrun.LeaseID) error

+ func (s *Supervisor) HandleMCPStart(ctx context.Context, attemptID routedrun.AttemptID, leaseID routedrun.LeaseID) error

+ func (s *Supervisor) HandleModelEnd(ctx context.Context, attemptID routedrun.AttemptID, leaseID routedrun.LeaseID) error

+ func (s *Supervisor) HandleModelStart(ctx context.Context, attemptID routedrun.AttemptID, leaseID routedrun.LeaseID) error

+ func (s *Supervisor) HandleResult(ctx context.Context, attemptID routedrun.AttemptID, event ResultEvent) error

+ func (s *Supervisor) Reconcile(ctx context.Context, runID routedrun.RunID) error

+ func (s *Supervisor) TrackProgress(_ context.Context, attemptID routedrun.AttemptID, p ProgressEvent) error

+ func (s *Supervisor) UnauthenticatedActivity(_ context.Context, _ routedrun.AttemptID, _ string) error

+ type SupervisorOption func(*Supervisor)

+ func WithAuditLogger(log AuditLogger) SupervisorOption