spike

Documentation

Overview

Package spike provides a spike detector for NTP responses.

Index

• type Detector
  • func (d *Detector) IsSpike(sample Sample) bool
  • func (d *Detector) Jitter() float64
• type Sample
  • func SampleFromNTPResponse(resp *ntp.Response) Sample

Types

type Detector

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

Detector detects spikes in NTP response samples.

Zero value is ready to use.

func (*Detector) IsSpike

func (d *Detector) IsSpike(sample Sample) bool

IsSpike returns true if the given sample is a spike.

The sample is added to the detector's internal state.

func (*Detector) Jitter

func (d *Detector) Jitter() float64

Jitter returns the current jitter.

type Sample

type Sample struct {
	Offset, RTT float64 // in seconds
}

Sample is a single NTP response sample.

func SampleFromNTPResponse

func SampleFromNTPResponse(resp *ntp.Response) Sample

SampleFromNTPResponse converts an NTP response to a Sample.