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
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

herd

package module

Go to main page

Versions in this module

v0

v0.5.3

Mar 31, 2026

v0.5.2

Mar 31, 2026

v0.5.1

Mar 31, 2026

v0.5.0

Mar 30, 2026

Changes in this version

+ type FirecrackerFactory struct

+ FirecrackerPath string

+ GuestAgentPath string

+ IPAM *network.IPAM

+ KernelImagePath string

+ SocketPathDir string

+ Storage *storage.Manager

+ func (f *FirecrackerFactory) Spawn(ctx context.Context, sessionID string, config TenantConfig) (Worker[*http.Client], error)

+ func (f *FirecrackerFactory) WarmImage(ctx context.Context, imageRef string) error

+ type FirecrackerWorker struct

+ func (f *FirecrackerWorker) Address() string

+ func (f *FirecrackerWorker) Client() *http.Client

+ func (f *FirecrackerWorker) Close() error

+ func (f *FirecrackerWorker) GuestIP() string

+ func (f *FirecrackerWorker) Healthy(ctx context.Context) error

+ func (f *FirecrackerWorker) ID() string

+ func (f *FirecrackerWorker) OnCrash(fn func(sessionID string))

+ func (f *FirecrackerWorker) VsockUDSPath() string

type Option

+ func WithMaxWorkers(max int) Option

type Pool

+ func (p *Pool[C]) Factory() WorkerFactory[C]

+ func (p *Pool[C]) KillWorker(sessionID string, reason string) error

+ type TenantConfig struct

+ Command []string

+ Env map[string]string

+ HealthInterval string

+ IdleTimeoutSeconds int

+ Image string

+ TTLSeconds int

type WorkerFactory

+ WarmImage func(ctx context.Context, imageRef string) error

v0.4.0

Mar 25, 2026

Changes in this version

+ var ErrWorkerDead = errors.New("worker process has died")

+ func NewLocalRegistry[C any]() *localRegistry[C]

+ type Option func(*config)

+ func WithAutoScale(min, max int) Option

+ func WithCrashHandler(fn func(sessionID string)) Option

+ func WithHealthInterval(d time.Duration) Option

+ func WithStartHealthCheckDelay(d time.Duration) Option

+ func WithTTL(d time.Duration) Option

+ func WithWorkerReuse(reuse bool) Option

+ type Pool struct

+ func New[C any](factory WorkerFactory[C], opts ...Option) (*Pool[C], error)

+ func (p *Pool[C]) Acquire(ctx context.Context, sessionID string) (*Session[C], error)

+ func (p *Pool[C]) GetSession(ctx context.Context, sessionID string) (*Session[C], error)

+ func (p *Pool[C]) KillSession(sessionID string) error

+ func (p *Pool[C]) Shutdown(ctx context.Context) error

+ func (p *Pool[C]) Stats() PoolStats

+ type PoolStats struct

+ ActiveSessions int

+ AvailableWorkers int

+ InflightAcquires int

+ Node observer.NodeStats

+ TotalWorkers int

+ type ProcessFactory struct

+ func NewProcessFactory(binary string, args ...string) *ProcessFactory

+ func (f *ProcessFactory) Spawn(ctx context.Context) (Worker[*http.Client], error)

+ func (f *ProcessFactory) WithCPULimit(cores float64) *ProcessFactory

+ func (f *ProcessFactory) WithEnv(kv string) *ProcessFactory

+ func (f *ProcessFactory) WithHealthPath(path string) *ProcessFactory

+ func (f *ProcessFactory) WithInsecureSandbox() *ProcessFactory

+ func (f *ProcessFactory) WithMemoryLimit(bytes int64) *ProcessFactory

+ func (f *ProcessFactory) WithPIDsLimit(n int64) *ProcessFactory

+ func (f *ProcessFactory) WithStartHealthCheckDelay(d time.Duration) *ProcessFactory

+ func (f *ProcessFactory) WithStartTimeout(d time.Duration) *ProcessFactory

+ type ProcessWorker struct

+ func (w *ProcessWorker) Address() string

+ func (w *ProcessWorker) Client() *http.Client

+ func (w *ProcessWorker) Close() error

+ func (w *ProcessWorker) Healthy(ctx context.Context) error

+ func (w *ProcessWorker) ID() string

+ func (w *ProcessWorker) OnCrash(fn func(string))

+ type Session struct

+ ID string

+ Worker Worker[C]

+ func (s *Session[C]) ConnRelease()

+ func (s *Session[C]) Release()

+ type SessionRegistry interface

+ Delete func(ctx context.Context, sessionID string) error

+ Get func(ctx context.Context, sessionID string) (Worker[C], error)

+ Len func() int

+ List func(ctx context.Context) (map[string]Worker[C], error)

+ Put func(ctx context.Context, sessionID string, w Worker[C]) error

+ type Worker interface

+ Address func() string

+ Client func() C

+ Healthy func(ctx context.Context) error

+ ID func() string

+ OnCrash func(func(sessionID string))

+ type WorkerFactory interface

+ Spawn func(ctx context.Context) (Worker[C], error)