sampler

Documentation

Index

• type Rate
  • func (r *Rate) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (r Rate) Validate() error
  • func (r Rate) Value() float64
• type Sampler
  • func NewSampler(sampleRate Rate) (*Sampler, error)
  • func (t *Sampler) Sample() bool
  • func (t *Sampler) SampleRate() Rate

Types

type Rate

type Rate float64

Rate is a sample rate.

func (*Rate) UnmarshalYAML

func (r *Rate) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals a sample rate.

func (Rate) Validate

func (r Rate) Validate() error

Validate validates a sample rate.

func (Rate) Value

func (r Rate) Value() float64

Value returns the float64 sample rate value.

type Sampler

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

Sampler samples the requests, out of 100 sample calls, 100*sampleRate calls will be sampled.

func NewSampler

func NewSampler(sampleRate Rate) (*Sampler, error)

NewSampler creates a new sampler with a sample rate.

func (*Sampler) Sample

func (t *Sampler) Sample() bool

Sample returns true when the call is sampled.

func (*Sampler) SampleRate

func (t *Sampler) SampleRate() Rate

SampleRate returns the effective sample rate.