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

runtimebudget

package module

Go to main page

Versions in this module

v0

v0.3.1

Aug 30, 2026

Changes in this version

+ var ErrCumulativeMetric = errors.New(...)

v0.3.0

Aug 29, 2026

Changes in this version

+ var ErrInvalidWatchInterval = errors.New("runtimebudget: watch interval must be positive")

+ var ErrNilCallback = errors.New("runtimebudget: nil callback")

+ var ErrNilContext = errors.New("runtimebudget: nil context")

+ func WatchRate(ctx context.Context, interval time.Duration, budgets map[string]float64, ...) error

v0.2.0

Aug 29, 2026

Changes in this version

type Report

+ func CheckDelta(previous, current Snapshot, budgets map[string]float64) Report

+ func CheckRate(previous, current Snapshot, budgets map[string]float64) Report

v0.1.0

Aug 29, 2026

Changes in this version

+ var ErrBudgetExceeded = errors.New("runtimebudget: budget exceeded")

+ var ErrCounterReset = errors.New("runtimebudget: cumulative metric decreased")

+ var ErrHistogramBudget = errors.New("runtimebudget: histogram budget needs bucket handling")

+ var ErrHistogramLayout = errors.New("runtimebudget: histogram bucket layout mismatch")

+ var ErrHistogramRequired = errors.New("runtimebudget: metric is not a histogram")

+ var ErrHistogramScalarDelta = errors.New("runtimebudget: histogram needs bucket handling")

+ var ErrInvalidBudget = errors.New("runtimebudget: budget limit must be finite")

+ var ErrInvalidInterval = errors.New("runtimebudget: snapshot interval must be positive")

+ var ErrKindMismatch = errors.New("runtimebudget: metric kind mismatch")

+ var ErrMetricMissing = errors.New("runtimebudget: metric missing from snapshot")

+ var ErrMetricUnavailable = errors.New("runtimebudget: metric unavailable")

+ var ErrNotCumulative = errors.New("runtimebudget: metric is not cumulative")

+ var ErrUnknownMetric = errors.New("runtimebudget: unknown metric")

+ var ErrUnsupportedKind = errors.New("runtimebudget: unsupported metric kind")

+ func Rate(previous, current Snapshot, name string) (float64, error)

+ type Histogram struct

+ Buckets []float64

+ Counts []uint64

+ func HistogramDelta(previous, current Snapshot, name string) (Histogram, error)

+ type Issue struct

+ Err error

+ Name string

+ func (i Issue) Error() string

+ type Report struct

+ Issues []Issue

+ Violations []Violation

+ func Check(snapshot Snapshot, budgets map[string]float64) Report

+ func (r Report) Err() error

+ func (r Report) OK() bool

+ type ReportError struct

+ Report Report

+ func (e *ReportError) Error() string

+ func (e *ReportError) Unwrap() []error

+ type Snapshot struct

+ func Read(names ...string) Snapshot

+ func ReadAll() Snapshot

+ func (s Snapshot) At() time.Time

+ func (s Snapshot) Get(name string) (Value, bool)

+ func (s Snapshot) Names() []string

+ type Value struct

+ func Delta(previous, current Snapshot, name string) (Value, error)

+ func (v Value) Float64() (float64, bool)

+ func (v Value) Histogram() (Histogram, bool)

+ func (v Value) Kind() metrics.ValueKind

+ func (v Value) Uint64() (uint64, bool)

+ type Violation struct

+ Kind metrics.ValueKind

+ Limit float64

+ Name string

+ Value float64

+ func (v Violation) Error() string