psiphon

Documentation

Overview

Package psiphon implements the psiphon network experiment. This implements, in particular, v0.2.0 of the spec.

See https://github.com/ooni/spec/blob/master/nettests/ts-015-psiphon.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) (interface{}, error)
  • func (m *Measurer) Run(ctx context.Context, sess model.ExperimentSession, ...) error
• 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's configuration.

type Measurer

type Measurer struct {
	BeforeGetHook func(g urlgetter.Getter)
	Config        Config
}

Measurer is the psiphon measurer.

func (*Measurer) ExperimentName

func (m *Measurer) ExperimentName() string

ExperimentName returns the experiment name

func (*Measurer) ExperimentVersion

func (m *Measurer) ExperimentVersion() string

ExperimentVersion returns the experiment version

func (Measurer) GetSummaryKeys

func (m Measurer) GetSummaryKeys(measurement *model.Measurement) (interface{}, error)

GetSummaryKeys implements model.ExperimentMeasurer.GetSummaryKeys.

func (*Measurer) Run

func (m *Measurer) Run(
	ctx context.Context, sess model.ExperimentSession,
	measurement *model.Measurement, callbacks model.ExperimentCallbacks,
) error

Run runs the measurement

type SummaryKeys

type SummaryKeys struct {
	BootstrapTime float64 `json:"bootstrap_time"`
	Failure       string  `json:"failure"`
	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 {
	urlgetter.TestKeys
	MaxRuntime float64 `json:"max_runtime"`
}

TestKeys contains the experiment's result.