observe

type Attempt struct {
	Status      string  `json:"status" enum:"waiting,running,succeeded,failed,superseded"`
	StartedAt   *string `json:"started_at"`
	FinishedAt  *string `json:"finished_at"`
	Number      int     `json:"number" doc:"1-based attempt number within the job; 0 while waiting"`
	DurationMS  *int64  `json:"duration_ms" doc:"Null until the attempt finished"`
	Error       string  `json:"error" doc:"Sanitized failure reason; empty on success"`
	Remediation string  `json:"remediation"`
	JobID       string  `json:"job_id"`
	Generation  int64   `json:"generation"`
}

type Observation struct {
	Kind    string   `json:"kind"`
	Key     string   `json:"key"`
	Status  string   `` /* 222-byte string literal not displayed */
	Attempt *Attempt `json:"attempt" doc:"Null before the first refresh"`
	Saved   *Saved   `json:"saved" doc:"Null until a refresh succeeded"`
	Enabled bool     `json:"enabled"`
}

type Ref struct {
	Kind       string `json:"kind"`
	Key        string `json:"key"`
	JobID      string `json:"job_id"`
	Generation int64  `json:"generation"`
	Deduped    bool   `json:"deduplicated" doc:"True when a refresh for this key was already queued or running"`
}

type Result struct {
	Scope string
	Data  any
}

type Saved struct {
	At            string          `json:"at"`
	AgeSeconds    int64           `json:"age_seconds"`
	Revision      string          `json:"revision"`
	RevisionMatch *bool           `json:"revision_match" doc:"Null when the key's current revision cannot be read"`
	DurationMS    *int64          `json:"duration_ms"`
	Scope         string          `json:"scope"`
	Data          json.RawMessage `json:"data"`
}

type Service struct {
	// contains filtered or unexported fields
}

type Spec struct {
	Kind string
	// Timeout bounds one attempt (default 20s). MaxAttempts bounds retries
	// through the job queue (default 3). Freshness is how long a success is
	// served as fresh and how often the scheduler refreshes keys (default
	// 15m; <= 0 means refresh only on demand). MaxInFlight caps queued or
	// running refreshes of this kind admitted by the scheduler (default 2).
	Timeout     time.Duration
	MaxAttempts int
	Freshness   time.Duration
	MaxInFlight int
	// Keys enumerates the keys the scheduler refreshes (nil: on demand only).
	Keys func(ctx context.Context) ([]string, error)
	// Revision returns the key's current configuration revision, or "" when
	// the key no longer exists. A result is only saved while the revision it
	// was queued for is still current.
	Revision func(ctx context.Context, key string) (string, error)
	// Enabled reports whether the capability may run (nil: always). A
	// disabled capability is neither scheduled nor refreshed on demand;
	// its saved rows are kept.
	Enabled func(ctx context.Context) bool
	// Run performs the check for key at revision. Its error message is
	// stored (truncated) and shown to operators: never include credentials.
	Run func(ctx context.Context, key, revision string) (Result, error)
	// Remediation is the operator hint stored with a failed attempt.
	Remediation string
	// Manual marks a kind whose results come only from Record (an explicit
	// operator action with input the job queue cannot carry, such as a
	// pasted key). Refresh returns ErrManual, the scheduler never admits
	// it, and Run is never called.
	Manual bool
}