latency

Documentation

Overview

Package latency tracks the global network connectivity statistics.

Index

• Constants
• func New(ctx context.Context, cfg Config) components.Component
• type Config
  • func ParseConfig(b any, dbRW *sql.DB, dbRO *sql.DB) (*Config, error)
  • func (cfg Config) Validate() error
• type Output
  • func ParseOutputJSON(data []byte) (*Output, error)
  • func ParseStateLatency(m map[string]string) (*Output, error)
  • func ParseStatesToOutput(states ...components.State) (*Output, error)
  • func (o *Output) JSON() ([]byte, error)
  • func (o *Output) States(cfg Config) ([]components.State, error)

Constants

const (
	StateNameLatency = "network-latency"

	StateKeyLatencyData         = "data"
	StateKeyLatencyEncoding     = "encoding"
	StateKeyLatencyEncodingJSON = "json"
)

const (
	// 1 second
	MinGlobalMillisecondThreshold = 1000
	// 7 seconds by default to reach any of the DERP servers.
	DefaultGlobalMillisecondThreshold = 7000
)

Functions

func New

func New(ctx context.Context, cfg Config) components.Component

Types

type Config

type Config struct {
	Query query_config.Config `json:"query"`

	// GlobalMillisecondThreshold is the global threshold in milliseconds for the DERP latency.
	// If all DERP latencies are greater than this threshold, the component will be marked as failed.
	// If at least one DERP latency is less than this threshold, the component will be marked as healthy.
	GlobalMillisecondThreshold int64 `json:"global_millisecond_threshold"`
}

func ParseConfig

func ParseConfig(b any, dbRW *sql.DB, dbRO *sql.DB) (*Config, error)

func (Config) Validate

func (cfg Config) Validate() error

type Output

type Output struct {
	// EgressLatencies is the list of egress latencies to global edge servers.
	EgressLatencies latency.Latencies `json:"egress_latencies"`
}

func ParseOutputJSON

func ParseOutputJSON(data []byte) (*Output, error)

func ParseStateLatency

func ParseStateLatency(m map[string]string) (*Output, error)

func ParseStatesToOutput

func ParseStatesToOutput(states ...components.State) (*Output, error)

func (*Output) JSON

func (o *Output) JSON() ([]byte, error)

func (*Output) States

func (o *Output) States(cfg Config) ([]components.State, error)