model

Documentation

Index

• type ClientInfo
• type Measurement
• type Results
• type ServerInfo

Types

type ClientInfo

type ClientInfo struct {
	ASN       string
	City      string
	Country   string
	Hostname  string
	IP        string
	Latitude  float32
	Longitude float32
	ISP       string
	Postal    string
	Region    string
	Timezone  string
}

ClientInfo is a data structure for storing client-related metadata.

type Measurement

type Measurement struct {
	ID int64 `pg:",pk"`

	// Timestamp is the timestamp of this Measurement.
	Timestamp time.Time

	// UUID is the server-generated UUID for the S2C test.
	UUID string `pg:",unique"`

	// BrowserID is a unique identifier for this Measurement's uploader.
	BrowserID string `sql:",notnull" validate:"required"`

	// DeviceType is a free-form string identifying the device type.
	DeviceType string

	// Notes is a free-form string containing browser-specific notes.
	Notes string

	// ClientInfo is a JSONB containing information about the client.
	ClientInfo ClientInfo

	// Server is a JSONB containing information about the server.
	ServerInfo ServerInfo

	Download float64 `pg:",use_zero" validate:"required"`
	Upload   float64 `pg:",use_zero" validate:"required"`
	Latency  int     `pg:",use_zero" validate:"required"`

	// Results is a JSONB containing extra debug information about the
	// measurement.
	Results Results
}

Measurement is the data format exchanged between the uploader and this service.

type Results

type Results struct {
	AckPktsIn            string
	ClientToServerSpeed  float64
	CongestionSignals    string
	CountRTT             string
	CurMSS               string
	CurRTO               string
	DataBytesOut         string
	DupAcksIn            string
	Jitter               float64
	MaxCwnd              string
	MaxRTT               string
	MaxRwinRcvd          string
	MinRTT               string
	S2CClientIP          string `json:"NDTResult.S2C.ClientIP"`
	S2CClientPort        string `json:"NDTResult.S2C.ClientPort"`
	S2CEndTime           string `json:"NDTResult.S2C.EndTime"`
	S2CError             string `json:"NDTResult.S2C.Error"`
	S2CMinRTT            string `json:"NDTResult.S2C.MinRTT"`
	S2CServerIP          string `json:"NDTResult.S2C.ServerIP"`
	S2CServerPort        string `json:"NDTResult.S2C.ServerPort"`
	S2CStartTime         string `json:"NDTResult.S2C.StartTime"`
	S2CUUID              string `json:"NDTResult.S2C.UUID"`
	PktsOut              string
	PktsRetrans          string
	RcvWinScale          string
	ServerToClientSpeed  float64
	SndLimTimeCwnd       string
	SndLimTimeRwin       string
	SndLimTimeSender     string
	SndWinScale          string
	Sndbuf               string
	SumRTT               string
	TCPInfoATO           string `json:"TCPInfo.ATO"`
	TCPInfoAdvMSS        string `json:"TCPInfo.AdvMSS"`
	TCPInfoAppLimited    string `json:"TCPInfo.AppLimited"`
	TCPInfoBackoff       string `json:"TCPInfo.Backoff"`
	TCPInfoBusyTime      string `json:"TCPInfo.BusyTime"`
	TCPInfoBytesAcked    string `json:"TCPInfo.BytesAcked"`
	TCPInfoBytesReceived string `json:"TCPInfo.BytesReceived"`
	TCPInfoBytesRetrans  string `json:"TCPInfo.BytesRetrans"`
	TCPInfoBytesSent     string `json:"TCPInfo.BytesSent"`
	TCPInfoCAState       string `json:"TCPInfo.CAState"`
	TCPInfoDSackDups     string `json:"TCPInfo.DSackDups"`
	TCPInfoDataSegsIn    string `json:"TCPInfo.DataSegsIn"`
	TCPInfoDataSegsOut   string `json:"TCPInfo.DataSegsOut"`
	TCPInfoDelivered     string `json:"TCPInfo.Delivered"`
	TCPInfoDeliveredCE   string `json:"TCPInfo.DeliveredCE"`
	TCPInfoDeliveryRate  string `json:"TCPInfo.DeliveryRate"`
	TCPInfoFackets       string `json:"TCPInfo.Fackets"`
	TCPInfoLastAckRecv   string `json:"TCPInfo.LastAckRecv"`
	TCPInfoLastAckSent   string `json:"TCPInfo.LastAckSent"`
	TCPInfoLastDataRecv  string `json:"TCPInfo.LastDataRecv"`
	TCPInfoLastDataSent  string `json:"TCPInfo.LastDataSent"`
	TCPInfoLost          string `json:"TCPInfo.Lost"`
	TCPInfoMaxPacingRate string `json:"TCPInfo.MaxPacingRate"`
	TCPInfoMinRTT        string `json:"TCPInfo.MinRTT"`
	TCPInfoNotsentBytes  string `json:"TCPInfo.NotsentBytes"`
	TCPInfoOptions       string `json:"TCPInfo.Options"`
	TCPInfoPMTU          string `json:"TCPInfo.PMTU"`
	TCPInfoPacingRate    string `json:"TCPInfo.PacingRate"`
	TCPInfoProbes        string `json:"TCPInfo.Probes"`
	TCPInfoRTO           string `json:"TCPInfo.RTO"`
	TCPInfoRTT           string `json:"TCPInfo.RTT"`
	TCPInfoRTTVar        string `json:"TCPInfo.RTTVar"`
	TCPInfoRWndLimited   string `json:"TCPInfo.RWndLimited"`
	TCPInfoRcvMSS        string `json:"TCPInfo.RcvMSS"`
	TCPInfoRcvRTT        string `json:"TCPInfo.RcvRTT"`
	TCPInfoRcvSpace      string `json:"TCPInfo.RcvSpace"`
	TCPInfoRcvSsThresh   string `json:"TCPInfo.RcvSsThresh"`
	TCPInfoReordSeen     string `json:"TCPInfo.ReordSeen"`
	TCPInfoReordering    string `json:"TCPInfo.Reordering"`
	TCPInfoRetrans       string `json:"TCPInfo.Retrans"`
	TCPInfoRetransmits   string `json:"TCPInfo.Retransmits"`
	TCPInfoSacked        string `json:"TCPInfo.Sacked"`
	TCPInfoSegsIn        string `json:"TCPInfo.SegsIn"`
	TCPInfoSegsOut       string `json:"TCPInfo.SegsOut"`
	TCPInfoSndBufLimited string `json:"TCPInfo.SndBufLimited"`
	TCPInfoSndCwnd       string `json:"TCPInfo.SndCwnd"`
	TCPInfoSndMSS        string `json:"TCPInfo.SndMSS"`
	TCPInfoSndSsThresh   string `json:"TCPInfo.SndSsThresh"`
	TCPInfoState         string `json:"TCPInfo.State"`
	TCPInfoTotalRetrans  string `json:"TCPInfo.TotalRetrans"`
	TCPInfoUnacked       string `json:"TCPInfo.Unacked"`
	TCPInfoWScale        string `json:"TCPInfo.WScale"`
	Timeouts             string
	// contains filtered or unexported fields
}

Results represents the NDT variables sent by the server at the end of a measurement.

type ServerInfo

type ServerInfo struct {
	FQDN    string
	IPv4    string
	IPv6    string
	City    string
	Country string
	Label   string
	Metro   string
	Site    string
	URL     string
}

ServerInfo is a data structure for storing server-related metadata.