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 ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInputRequired indicates that no richer-input target was provided. ErrInputRequired = targetloading.ErrInputRequired // ErrInvalidInputType indicates that the richer-input target has the wrong type. ErrInvalidInputType = targetloading.ErrInvalidInputType )
Functions ¶
func NewExperimentMeasurer ¶
func NewExperimentMeasurer() model.ExperimentMeasurer
NewExperimentMeasurer creates a new ExperimentMeasurer.
func NewLoader ¶ added in v0.37.0
func NewLoader(loader *targetloading.Loader, gopts any) model.ExperimentTargetLoader
NewLoader constructs a new model.ExperimentTargetLoader instance.
This function PANICS if options is not an instance of *psiphon.Config.
Types ¶
type Measurer ¶
Measurer is the psiphon measurer.
func (*Measurer) ExperimentName ¶
ExperimentName returns the experiment name
func (*Measurer) ExperimentVersion ¶
ExperimentVersion returns the experiment version
type SummaryKeys ¶
type SummaryKeys struct {
BootstrapTime float64 `json:"bootstrap_time"`
Failure string `json:"failure"`
IsAnomaly bool `json:"-"`
}
SummaryKeys contains summary keys for this experiment.
func (*SummaryKeys) Anomaly ¶ added in v0.28.0
func (sk *SummaryKeys) Anomaly() bool
Anomaly implements model.MeasurementSummaryKeys.
type Target ¶ added in v0.37.0
type Target struct {
// Config contains the configuration.
Config *Config
// URL is the input URL.
URL string
}
Target is a richer-input target that this experiment should measure.
func (*Target) Category ¶ added in v0.37.0
Category implements model.ExperimentTarget.
func (*Target) Country ¶ added in v0.37.0
Country implements model.ExperimentTarget.
func (*Target) Input ¶ added in v0.37.0
Input implements model.ExperimentTarget.
func (*Target) Options ¶ added in v0.37.0
Options implements model.ExperimentTarget.
func (*Target) String ¶ added in v0.37.0
String implements model.ExperimentTarget.
type TestKeys ¶
TestKeys contains the experiment's result.
func (*TestKeys) MeasurementSummaryKeys ¶ added in v0.28.0
func (tk *TestKeys) MeasurementSummaryKeys() model.MeasurementSummaryKeys
MeasurementSummaryKeys implements model.MeasurementSummaryKeysProvider.