availability

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 10, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Overview

Package availability owns runtime state for exact provider offerings.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrInvalidOffering reports an incomplete offering identity.
	ErrInvalidOffering = errors.New("provider offering identity is incomplete")
	// ErrInvalidConfig reports an invalid availability policy.
	ErrInvalidConfig = errors.New("availability configuration is invalid")
)

Functions

This section is empty.

Types

type Clock 

type Clock interface {
	Now() time.Time
}

Clock supplies deterministic availability time.

type Config 

type Config struct {
	FailureThreshold int
	OpenDuration     time.Duration
}

Config defines the offering circuit policy.

func DefaultConfig 

func DefaultConfig() Config

DefaultConfig returns the production availability policy.

type Offering 

type Offering struct {
	ProviderID      string
	ProviderModelID string
}

Offering identifies one provider model endpoint.

func OfferingFromRoute 

func OfferingFromRoute(route routing.Route) Offering

OfferingFromRoute converts a planned route to runtime identity.

type Publisher 

type Publisher interface {
	PublishAvailability(Snapshot) error
}

Publisher receives immutable availability state for derived projections.

type Record 

type Record struct {
	Offering           Offering
	State              State
	ConsecutiveFailure int
	OpenUntil          time.Time
}

Record is one immutable offering state record.

type Snapshot 

type Snapshot struct {
	Revision uint64
	Records  []Record
}

Snapshot is one immutable availability generation.

type State 

type State string

State identifies one offering's runtime availability state. 

const (
	// StateHealthy admits normal attempts for an offering.
	StateHealthy State = "healthy"
	// StateOpen rejects attempts until the open interval expires.
	StateOpen State = "open"
	// StateHalfOpen admits one recovery probe.
	StateHalfOpen State = "half_open"
	// StateUnavailable rejects attempts until an explicit reset.
	StateUnavailable State = "unavailable"
)

type Tracker 

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

Tracker owns all offering state transitions and half-open probe admission.

func New 

func New(config Config, clock Clock, publisher Publisher) (*Tracker, error)

New creates one offering-level availability owner.

func (*Tracker) Acquire 

func (t *Tracker) Acquire(route routing.Route) bool

Acquire admits one attempt. A half-open offering admits one probe at a time.

func (*Tracker) LastPublishError 

func (t *Tracker) LastPublishError() error

LastPublishError returns the latest derived-projection publication error.

func (*Tracker) RecordFailure 

func (t *Tracker) RecordFailure(route routing.Route, providerFailure *failure.Failure, _ time.Duration)

RecordFailure applies one normalized failure to the offering state machine.

func (*Tracker) RecordSuccess 

func (t *Tracker) RecordSuccess(route routing.Route, _ time.Duration)

RecordSuccess closes the offering circuit and clears failure evidence.

func (*Tracker) Refresh 

func (t *Tracker) Refresh(_ context.Context)

Refresh makes expired open offerings eligible for one half-open probe.

func (*Tracker) Reset 

func (t *Tracker) Reset(offering Offering) error

Reset makes one offering healthy. Catalog activation or an operator action can use it.

func (*Tracker) Snapshot 

func (t *Tracker) Snapshot() Snapshot

Snapshot returns a caller-owned immutable state generation.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.