dash

Documentation

Overview

Package dash implements the DASH network experiment.

Spec: https://github.com/ooni/spec/blob/master/nettests/ts-021-dash.md

Index

• func NewExperimentMeasurer(config Config) model.ExperimentMeasurer
• type Config
• type Measurer
  • func (m *Measurer) ExperimentName() string
  • func (m *Measurer) ExperimentVersion() string
  • func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (any, error)
  • func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error
• type ServerInfo
• type Simple
• type SummaryKeys
• type TestKeys

Functions

func NewExperimentMeasurer

func NewExperimentMeasurer(config Config) model.ExperimentMeasurer

NewExperimentMeasurer creates a new ExperimentMeasurer.

Types

type Config

type Config struct{}

Config contains the experiment config.

type Measurer

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

Measurer performs the measurement.

func (*Measurer) ExperimentName

func (m *Measurer) ExperimentName() string

ExperimentName implements model.ExperimentMeasurer.ExperimentName.

func (*Measurer) ExperimentVersion

func (m *Measurer) ExperimentVersion() string

ExperimentVersion implements model.ExperimentMeasurer.ExperimentVersion.

func (Measurer) GetSummaryKeys

func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (any, error)

GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys.

func (*Measurer) Run

func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error

Run implements model.ExperimentMeasurer.Run.

type ServerInfo

type ServerInfo struct {
	Hostname string `json:"hostname"`
	Site     string `json:"site,omitempty"`
}

ServerInfo contains information on the selected server.

This is currently an extension to the DASH specification until the data format of mlab locate v2 is finalized.

type Simple

type Simple struct {
	ConnectLatency  float64 `json:"connect_latency"`
	MedianBitrate   int64   `json:"median_bitrate"`
	MinPlayoutDelay float64 `json:"min_playout_delay"`
}

Simple contains the experiment summary.

type SummaryKeys

type SummaryKeys struct {
	Latency   float64 `json:"connect_latency"`
	Bitrate   float64 `json:"median_bitrate"`
	Delay     float64 `json:"min_playout_delay"`
	IsAnomaly bool    `json:"-"`
}

SummaryKeys contains summary keys for this experiment.

Note that this structure is part of the ABI contract with ooniprobe therefore we should be careful when changing it.

type TestKeys

type TestKeys struct {
	// ServerInfo contains information about the server we used.
	Server ServerInfo `json:"server"`

	// Simple contains simple summary statistics.
	Simple Simple `json:"simple"`

	// Failure is the failure that occurred.
	Failure *string `json:"failure"`

	// ReceiverData contains the results.
	//
	// WARNING: refactoring this field to become []*clientResults
	// would be disastrous because the measurement loop relies
	// on this slice being []clientResults to produce distinct results.
	ReceiverData []clientResults `json:"receiver_data"`
}

TestKeys contains the test keys.