metrics

package

v1.19.5 Latest Latest Go to latest Published: Aug 14, 2026 License: MIT Imports: 11 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type GaugeDefinition struct {
	Name     string
	Labels   map[string]string
	Expected float64
}

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

func NewMetricsClient(httpClient client.HTTP, options ...Option) *MetricsClient

func (c *MetricsClient) Fetch(ctx context.Context) (*Snapshot, error)

func (c *MetricsClient) WaitForGauge(ctx context.Context, definition GaugeDefinition, pollInterval time.Duration) error

func (c *MetricsClient) WaitForSnapshot(
	ctx context.Context,
	pollInterval time.Duration,
	check func(*Snapshot) error,
) (*Snapshot, error)

type Option func(*MetricsClient)

func WithFetchTimeout(timeout time.Duration) Option

func WithWaitTimeout(timeout time.Duration) Option

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

func (s *Snapshot) Gauge(name string, labels map[string]string) (float64, error)

func (s *Snapshot) GaugeSum(name string, labels map[string]string) (float64, error)

func (s *Snapshot) HistogramCount(name string, labels map[string]string) (uint64, error)

func (s *Snapshot) Payload() string

type SnapshotCheck func(*Snapshot) error

func GaugeAtLeast(name string, labels map[string]string, minimum float64) SnapshotCheck

func GaugeEquals(name string, labels map[string]string, expected float64) SnapshotCheck

func GaugeSumEquals(name string, labels map[string]string, expected float64) SnapshotCheck

func HistogramCountAtLeast(name string, labels map[string]string, minimum uint64) SnapshotCheck