engine

Aug 8, 2024

Changes in this version

type Session

+ func (s *Session) FetchOpenVPNConfig(ctx context.Context, provider, cc string) (*model.OOAPIVPNProviderConfig, error)

May 22, 2024

Changes in this version

+ func SaveMeasurement(measurement *model.Measurement, filePath string) error

Mar 27, 2024

Changes in this version

+ func MeasurementSummaryKeys(m *model.Measurement) model.MeasurementSummaryKeys

+ type ExperimentMeasurementSummaryKeysNotImplemented struct

+ func (*ExperimentMeasurementSummaryKeysNotImplemented) Anomaly() bool

Feb 20, 2023

Changes in this version

type SessionConfig

+ SnowflakeRendezvous string

Feb 23, 2022

Changes in this version

type Experiment

+ func (e *Experiment) MeasureAsync(ctx context.Context, input string) (<-chan *model.Measurement, error)

type InputProcessorExperiment

+ MeasureAsync func(ctx context.Context, input string) (<-chan *model.Measurement, error)

type InputProcessorExperimentWrapper

+ MeasureAsync func(ctx context.Context, input string, idx int) (<-chan *model.Measurement, error)

type Session

+ func (s *Session) TunnelDir() string

Dec 14, 2021

Changes in this version

+ const InputOrStaticDefault

+ var ErrNoStaticInput = errors.New("no static input for this experiment")

+ func CheckEmbeddedPsiphonConfig() error

+ func StaticBareInputForExperiment(name string) ([]string, error)

type InputLoader

+ ExperimentName string

May 19, 2021

Changes in this version

type Session

+ func (s *Session) FetchPsiphonConfig(ctx context.Context) ([]byte, error)

+ func (s *Session) FetchTorTargets(ctx context.Context, cc string) (map[string]model.TorTarget, error)

+ func (s *Session) FetchURLList(ctx context.Context, config model.URLListConfig) ([]model.URLInfo, error)

type SessionConfig

+ TunnelDir string

Apr 7, 2021

Changes in this version

type InputLoader

+ Logger InputLoaderLogger

+ type InputLoaderLogger interface

+ Warnf func(format string, v ...interface{})

Apr 1, 2021

Changes in this version

+ const InputOrQueryBackend

+ var ErrNoURLsReturned = errors.New("no URLs returned")

type InputLoader

+ CheckInConfig *model.CheckInConfig

+ InputPolicy InputPolicy

+ Session InputLoaderSession

+ SourceFiles []string

+ StaticInputs []string

type InputLoaderSession

+ CheckIn func(ctx context.Context, config *model.CheckInConfig) (*model.CheckInInfo, error)

type InputProcessor

+ MaxRuntime time.Duration

type Session

+ func (s *Session) CheckIn(ctx context.Context, config *model.CheckInConfig) (*model.CheckInInfo, error)

Feb 3, 2021

Changes in this version

+ const InputNone

+ const InputOptional

+ const InputOrQueryTestLists

+ const InputStrictlyRequired

+ var ErrAllProbeServicesFailed = errors.New("all available probe services failed")

+ var ErrAlreadyUsingProxy = errors.New(...)

+ var ErrDetectedEmptyFile = errors.New("file did not contain any input")

+ var ErrInputRequired = errors.New("no input provided")

+ var ErrNoInputExpected = errors.New("we did not expect any input")

+ func AllExperiments() []string

+ type Experiment struct

+ func NewExperiment(sess *Session, measurer model.ExperimentMeasurer) *Experiment

+ func (e *Experiment) GetSummaryKeys(m *model.Measurement) (interface{}, error)

+ func (e *Experiment) KibiBytesReceived() float64

+ func (e *Experiment) KibiBytesSent() float64

+ func (e *Experiment) Measure(input string) (*model.Measurement, error)

+ func (e *Experiment) MeasureWithContext(ctx context.Context, input string) (measurement *model.Measurement, err error)

+ func (e *Experiment) Name() string

+ func (e *Experiment) OpenReport() (err error)

+ func (e *Experiment) OpenReportContext(ctx context.Context) error

+ func (e *Experiment) ReportID() string

+ func (e *Experiment) SaveMeasurement(measurement *model.Measurement, filePath string) error

+ func (e *Experiment) SubmitAndUpdateMeasurement(measurement *model.Measurement) error

+ func (e *Experiment) SubmitAndUpdateMeasurementContext(ctx context.Context, measurement *model.Measurement) error

+ type ExperimentBuilder struct

+ func (b *ExperimentBuilder) InputPolicy() InputPolicy

+ func (b *ExperimentBuilder) Interruptible() bool

+ func (b *ExperimentBuilder) NewExperiment() *Experiment

+ func (b *ExperimentBuilder) Options() (map[string]OptionInfo, error)

+ func (b *ExperimentBuilder) SetCallbacks(callbacks model.ExperimentCallbacks)

+ func (b *ExperimentBuilder) SetOptionBool(key string, value bool) error

+ func (b *ExperimentBuilder) SetOptionGuessType(key, value string) error

+ func (b *ExperimentBuilder) SetOptionInt(key string, value int64) error

+ func (b *ExperimentBuilder) SetOptionString(key, value string) error

+ func (b *ExperimentBuilder) SetOptionsGuessType(opts map[string]string) error

+ type FileSystemKVStore struct

+ func NewFileSystemKVStore(basedir string) (kvs *FileSystemKVStore, err error)

+ func (kvs *FileSystemKVStore) Get(key string) ([]byte, error)

+ func (kvs *FileSystemKVStore) Set(key string, value []byte) error

+ type InputLoader interface

+ Load func(ctx context.Context) ([]model.URLInfo, error)

+ func NewInputLoader(config InputLoaderConfig) InputLoader

+ type InputLoaderConfig struct

+ InputPolicy InputPolicy

+ Session InputLoaderSession

+ SourceFiles []string

+ StaticInputs []string

+ URLCategories []string

+ URLLimit int64

+ type InputLoaderSession interface

+ MaybeLookupLocationContext func(ctx context.Context) error

+ NewOrchestraClient func(ctx context.Context) (model.ExperimentOrchestraClient, error)

+ ProbeCC func() string

+ type InputPolicy string

+ type InputProcessor struct

+ Annotations map[string]string

+ Experiment InputProcessorExperimentWrapper

+ Inputs []model.URLInfo

+ Options []string

+ Saver InputProcessorSaverWrapper

+ Submitter InputProcessorSubmitterWrapper

+ func (ip InputProcessor) Run(ctx context.Context) error

+ type InputProcessorExperiment interface

+ MeasureWithContext func(ctx context.Context, input string) (*model.Measurement, error)

+ type InputProcessorExperimentWrapper interface

+ MeasureWithContext func(ctx context.Context, idx int, input string) (*model.Measurement, error)

+ func NewInputProcessorExperimentWrapper(exp InputProcessorExperiment) InputProcessorExperimentWrapper

+ type InputProcessorSaverWrapper interface

+ SaveMeasurement func(idx int, m *model.Measurement) error

+ func NewInputProcessorSaverWrapper(saver Saver) InputProcessorSaverWrapper

+ type InputProcessorSubmitterWrapper interface

+ Submit func(ctx context.Context, idx int, m *model.Measurement) error

+ func NewInputProcessorSubmitterWrapper(submitter Submitter) InputProcessorSubmitterWrapper

+ type KVStore interface

+ Get func(key string) (value []byte, err error)

+ Set func(key string, value []byte) (err error)

+ type OptionInfo struct

+ Doc string

+ Type string

+ type Saver interface

+ SaveMeasurement func(m *model.Measurement) error

+ func NewSaver(config SaverConfig) (Saver, error)

+ type SaverConfig struct

+ Enabled bool

+ Experiment SaverExperiment

+ FilePath string

+ Logger model.Logger

+ type SaverExperiment interface

+ SaveMeasurement func(m *model.Measurement, filepath string) error

+ type Session struct

+ func NewSession(config SessionConfig) (*Session, error)

+ func (s *Session) ASNDatabasePath() string

+ func (s *Session) Close() error

+ func (s *Session) CountryDatabasePath() string

+ func (s *Session) DefaultHTTPClient() *http.Client

+ func (s *Session) GetTestHelpersByName(name string) ([]model.Service, bool)

+ func (s *Session) KeyValueStore() model.KeyValueStore

+ func (s *Session) KibiBytesReceived() float64

+ func (s *Session) KibiBytesSent() float64

+ func (s *Session) Logger() model.Logger

+ func (s *Session) LookupASN(dbPath, ip string) (uint, string, error)

+ func (s *Session) LookupLocationContext(ctx context.Context) (*geolocate.Results, error)

+ func (s *Session) MaybeLookupBackends() error

+ func (s *Session) MaybeLookupBackendsContext(ctx context.Context) (err error)

+ func (s *Session) MaybeLookupLocation() error

+ func (s *Session) MaybeLookupLocationContext(ctx context.Context) error

+ func (s *Session) MaybeStartTunnel(ctx context.Context, name string) error

+ func (s *Session) MaybeUpdateResources(ctx context.Context) error

+ func (s *Session) NewExperimentBuilder(name string) (*ExperimentBuilder, error)

+ func (s *Session) NewOrchestraClient(ctx context.Context) (model.ExperimentOrchestraClient, error)

+ func (s *Session) NewProbeServicesClient(ctx context.Context) (*probeservices.Client, error)

+ func (s *Session) NewSubmitter(ctx context.Context) (Submitter, error)

+ func (s *Session) Platform() string

+ func (s *Session) ProbeASN() uint

+ func (s *Session) ProbeASNString() string

+ func (s *Session) ProbeCC() string

+ func (s *Session) ProbeIP() string

+ func (s *Session) ProbeNetworkName() string

+ func (s *Session) ProxyURL() *url.URL

+ func (s *Session) ResolverASN() uint

+ func (s *Session) ResolverASNString() string

+ func (s *Session) ResolverIP() string

+ func (s *Session) ResolverNetworkName() string

+ func (s *Session) SoftwareName() string

+ func (s *Session) SoftwareVersion() string

+ func (s *Session) TempDir() string

+ func (s *Session) TorArgs() []string

+ func (s *Session) TorBinary() string

+ func (s *Session) UserAgent() (useragent string)

+ type SessionConfig struct

+ AssetsDir string

+ AvailableProbeServices []model.Service

+ KVStore KVStore

+ Logger model.Logger

+ ProxyURL *url.URL

+ SoftwareName string

+ SoftwareVersion string

+ TempDir string

+ TorArgs []string

+ TorBinary string

+ type Submitter interface

+ Submit func(ctx context.Context, m *model.Measurement) error

+ func NewSubmitter(ctx context.Context, config SubmitterConfig) (Submitter, error)

+ type SubmitterConfig struct

+ Enabled bool

+ Logger model.Logger

+ Session SubmitterSession

+ type SubmitterSession interface

+ NewSubmitter func(ctx context.Context) (Submitter, error)