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

bench

package

Go to main page

Versions in this module

v0

v0.20.0

Apr 27, 2026

v0.19.0

Apr 27, 2026

v0.18.0

Apr 9, 2026

v0.17.0

May 14, 2024

v0.16.1

May 10, 2024

v0.15.3

May 10, 2024

v0.14.1

May 9, 2024

v0.13.2

May 1, 2024

v0.11.1

Aug 1, 2023

v0.11.0

Jul 31, 2023

Changes in this version

+ var UserAgent = fmt.Sprintf("Benchtool/%s", version.Version)

+ type Config struct

+ ID string

+ InstanceName string

+ Query QueryConfig

+ RingCheck RingCheckConfig

+ WorkloadFilePath string

+ Write WriteBenchConfig

+ func (cfg *Config) RegisterFlags(f *flag.FlagSet)

+ type LabelDesc struct

+ Name string

+ UniqueValues int

+ ValuePrefix string

+ type QueryConfig struct

+ BasicAuthPasword string

+ BasicAuthUsername string

+ Enabled bool

+ Endpoint string

+ func (cfg *QueryConfig) RegisterFlags(f *flag.FlagSet)

+ type QueryDesc struct

+ ExprTemplate string

+ InjectExactSerierMatcher bool

+ Interval time.Duration

+ NumQueries int

+ Regex bool

+ RequiredSeriesType SeriesType

+ TimeRange time.Duration

+ type RingCheckConfig struct

+ CheckInterval time.Duration

+ Enabled bool

+ MemberlistKV memberlist.KVConfig

+ RingConfig ring.Config

+ func (cfg *RingCheckConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

+ type RingChecker struct

+ MemberlistKV *memberlist.KVInitService

+ Ring *ring.Ring

+ func NewRingChecker(id string, instanceName string, cfg RingCheckConfig, workload *WriteWorkload, ...) (*RingChecker, error)

+ func (r *RingChecker) Run(ctx context.Context) error

+ type Runner struct

+ func NewBenchRunner(cfg Config, logger log.Logger, reg prometheus.Registerer) (*Runner, error)

+ func (b *Runner) Run(ctx context.Context) error

+ type SeriesDesc struct

+ Labels []LabelDesc

+ Name string

+ StaticLabels map[string]string

+ Type SeriesType

+ type SeriesType string

+ const CounterOne

+ const CounterRandom

+ const GaugeRandom

+ const GaugeZero

+ type Timeseries struct

+ func SeriesDescToSeries(seriesDescs []SeriesDesc) ([]*Timeseries, map[SeriesType]int)

+ type WorkloadDesc struct

+ QueryDesc []QueryDesc

+ Replicas int

+ Series []SeriesDesc

+ Write WriteDesc

+ type WriteBenchConfig struct

+ BasicAuthPasword string

+ BasicAuthUsername string

+ Enabled bool

+ Endpoint string

+ ProxyURL string

+ func (cfg *WriteBenchConfig) RegisterFlags(f *flag.FlagSet)

+ type WriteBenchmarkRunner struct

+ func NewWriteBenchmarkRunner(id string, tenantName string, cfg WriteBenchConfig, workload *WriteWorkload, ...) (*WriteBenchmarkRunner, error)

+ func (w *WriteBenchmarkRunner) Run(ctx context.Context) error

+ type WriteDesc struct

+ BatchSize int

+ Interval time.Duration

+ Timeout time.Duration

+ type WriteWorkload struct

+ Replicas int

+ Series []*Timeseries

+ TotalSeries int

+ TotalSeriesTypeMap map[SeriesType]int

+ func (w *WriteWorkload) GenerateTimeSeries(id string, t time.Time) []prompb.TimeSeries