latency

Documentation

Index

• Constants
• func NewCheck() checks.Check
• type Config
  • func (c *Config) For() string
  • func (c *Config) Validate() error
• type Latency
  • func (l *Latency) GetConfig() checks.Runtime
  • func (l *Latency) GetMetricCollectors() []prometheus.Collector
  • func (l *Latency) Name() string
  • func (l *Latency) RemoveLabelledMetrics(target string) error
  • func (l *Latency) Run(ctx context.Context, cResult chan checks.ResultDTO) error
  • func (l *Latency) Schema() (*openapi3.SchemaRef, error)
  • func (l *Latency) Shutdown()
  • func (l *Latency) UpdateConfig(cfg checks.Runtime) error

Constants

const CheckName = "latency"

Functions

func NewCheck

func NewCheck() checks.Check

NewCheck creates a new instance of the latency check

Types

type Config

type Config struct {
	Targets  []string           `json:"targets,omitempty" yaml:"targets,omitempty"`
	Interval time.Duration      `json:"interval" yaml:"interval"`
	Timeout  time.Duration      `json:"timeout" yaml:"timeout"`
	Retry    helper.RetryConfig `json:"retry" yaml:"retry"`
}

Config defines the configuration parameters for a latency check

func (*Config) For

func (c *Config) For() string

For returns the name of the check

func (*Config) Validate

func (c *Config) Validate() error

Validate checks if the configuration is valid

type Latency

type Latency struct {
	checks.CheckBase
	// contains filtered or unexported fields
}

Latency is a check that measures the latency to an endpoint

func (*Latency) GetConfig

func (l *Latency) GetConfig() checks.Runtime

GetConfig returns the current configuration of the latency Check

func (*Latency) GetMetricCollectors

func (l *Latency) GetMetricCollectors() []prometheus.Collector

GetMetricCollectors returns all metric collectors of check

func (*Latency) Name

func (l *Latency) Name() string

Name returns the name of the check

func (*Latency) RemoveLabelledMetrics

func (l *Latency) RemoveLabelledMetrics(target string) error

RemoveLabelledMetrics removes the metrics which have the passed target as a label

func (*Latency) Run

func (l *Latency) Run(ctx context.Context, cResult chan checks.ResultDTO) error

Run starts the latency check

func (*Latency) Schema

func (l *Latency) Schema() (*openapi3.SchemaRef, error)

Schema provides the schema of the data that will be provided by the latency check

func (*Latency) Shutdown

func (l *Latency) Shutdown()

func (*Latency) UpdateConfig

func (l *Latency) UpdateConfig(cfg checks.Runtime) error

UpdateConfig sets the configuration for the latency check