probe-engine

Feb 1, 2021

Changes in this version

type InputProcessorSubmitterWrapper

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

type Session

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

type Submitter

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

type SubmitterConfig

+ Session SubmitterSession

+ type SubmitterSession interface

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

Jan 12, 2021

Changes in this version

+ const InputOrQueryTestLists

+ const InputStrictlyRequired

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

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

+ type LocationLookup struct

+ CountryLookupper LocationLookupCountryLookupper

+ EnableResolverLookup bool

+ PathsProvider LocationLookupsPathsProvider

+ ProbeASNLookupper LocationLookupASNLookupper

+ ProbeIPLookupper LocationLookupProbeIPLookupper

+ ResolverASNLookupper LocationLookupASNLookupper

+ ResolverIPLookupper LocationLookupResolverIPLookupper

+ ResourceUpdater LocationLookupResourceUpdater

+ func (op LocationLookup) Do(ctx context.Context) (*model.LocationInfo, error)

+ type LocationLookupASNLookupper interface

+ LookupASN func(path string, ip string) (asn uint, network string, err error)

+ type LocationLookupCountryLookupper interface

+ LookupCC func(path string, ip string) (cc string, err error)

+ type LocationLookupProbeIPLookupper interface

+ LookupProbeIP func(ctx context.Context) (addr string, err error)

+ type LocationLookupResolverIPLookupper interface

+ LookupResolverIP func(ctx context.Context) (addr string, err error)

+ type LocationLookupResourceUpdater interface

+ MaybeUpdateResources func(ctx context.Context) error

+ type LocationLookupsPathsProvider interface

+ ASNDatabasePath func() string

+ CountryDatabasePath func() string

type Session

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

+ func (s *Session) LookupCC(dbPath, probeIP string) (string, error)

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

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

Dec 7, 2020

Changes in this version

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

type Experiment

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

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

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

type ExperimentBuilder

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

+ func (b *ExperimentBuilder) SetOptionsGuessType(opts map[string]string) 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 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

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

+ func NewInputProcessorSubmitterWrapper(submitter Submitter) InputProcessorSubmitterWrapper

+ 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

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

+ type Submitter interface

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

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

+ type SubmitterConfig struct

+ Enabled bool

+ Experiment SubmitterExperiment

+ Logger model.Logger

+ type SubmitterExperiment interface

+ OpenReportContext func(ctx context.Context) error

+ ReportID func() string

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

Nov 12, 2020

Changes in this version

+ const Version

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

type Session

+ func (s *Session) LookupLocationContext(ctx context.Context) (out *model.LocationInfo, err error)

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

+ func (s *Session) MaybeProbeASN() uint

+ func (s *Session) MaybeProbeASNString() string

+ func (s *Session) MaybeProbeCC() string

+ func (s *Session) MaybeProbeIP() string

+ func (s *Session) MaybeProbeNetworkName() string

+ func (s *Session) MaybeResolverASN() uint

+ func (s *Session) MaybeResolverASNString() string

+ func (s *Session) MaybeResolverIP() string

+ func (s *Session) MaybeResolverNetworkName() string

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

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

Jun 25, 2020

Changes in this version

type Session

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

May 29, 2020

Changes in this version

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

type SessionConfig

+ AvailableProbeServices []model.Service

+ PrivacySettings model.PrivacySettings

May 14, 2020

Changes in this version

+ const InputNone

+ const InputOptional

+ const InputRequired

type ExperimentBuilder

+ func (b *ExperimentBuilder) InputPolicy() InputPolicy

+ type InputPolicy string

type Session

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

+ func (s *Session) TorBinary() string

type SessionConfig

+ TorArgs []string

+ TorBinary string

Apr 22, 2020

Changes in this version

type Session

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

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

+ func (s *Session) TunnelBootstrapTime() time.Duration

Apr 5, 2020

Changes in this version

type Experiment

+ func (e *Experiment) KibiBytesReceived() float64

+ func (e *Experiment) KibiBytesSent() float64

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

type ExperimentBuilder

+ func (b *ExperimentBuilder) Interruptible() bool

type Session

+ func (s *Session) KibiBytesReceived() float64

+ func (s *Session) KibiBytesSent() float64

Mar 9, 2020

Changes in this version

type Experiment

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

type ExperimentBuilder

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

type Session

+ func (s *Session) ASNDatabasePath() string

+ func (s *Session) CABundlePath() string

+ func (s *Session) Close() error

+ func (s *Session) CountryDatabasePath() string

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

+ func (s *Session) ExplicitProxy() bool

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

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

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

+ func (s *Session) SoftwareName() string

+ func (s *Session) SoftwareVersion() string

+ func (s *Session) TempDir() string

+ func (s *Session) UserAgent() string

Feb 22, 2020

Changes in this version

type Measurement

+ func (m *Measurement) MarshalJSON() ([]byte, error)

Jan 24, 2020

Changes in this version

type Session

+ func (sess *Session) ResolverASN() uint

+ func (sess *Session) ResolverASNString() string

+ func (sess *Session) ResolverNetworkName() string

Dec 28, 2019

Changes in this version

+ 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 KVStore interface

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

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

Dec 18, 2019

Changes in this version

type Session

+ func (sess *Session) Platform() string

+ func (sess *Session) QueryTestListsURLs(conf *TestListsURLsConfig) (*TestListsURLsResult, error)

type SessionConfig

+ KVStore model.KeyValueStore

+ type TestListsURLsConfig struct

+ BaseURL string

+ Categories []string

+ Limit int

+ func (c *TestListsURLsConfig) AddCategory(s string)

+ type TestListsURLsResult struct

+ Result []model.URLInfo

+ func (r *TestListsURLsResult) At(idx int64) (out *model.URLInfo)

+ func (r *TestListsURLsResult) Count() int64

Nov 12, 2019

Changes in this version

+ func AllExperiments() []string

+ type Callbacks interface

+ OnDataUsage func(dloadKiB, uploadKiB float64)

+ OnProgress func(percentage float64, message string)

+ type Experiment struct

+ func (e *Experiment) CloseReport() error

+ func (e *Experiment) LoadMeasurement(data []byte) (*Measurement, error)

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

+ func (e *Experiment) Name() string

+ func (e *Experiment) OpenReport() error

+ func (e *Experiment) ReportID() string

+ func (e *Experiment) SaveMeasurement(measurement *Measurement, path string) error

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

+ type ExperimentBuilder struct

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

+ func (b *ExperimentBuilder) NeedsInput() bool

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

+ func (b *ExperimentBuilder) SetCallbacks(callbacks Callbacks)

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

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

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

+ type Measurement struct

+ func (m *Measurement) AddAnnotations(annotations map[string]string)

+ func (m *Measurement) MakeGenericTestKeys() (map[string]interface{}, error)

+ type OptionInfo struct

+ Doc string

+ Type string

+ type Session struct

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

+ func (sess *Session) AddAvailableHTTPSBouncer(baseURL string)

+ func (sess *Session) AddAvailableHTTPSCollector(baseURL string)

+ func (sess *Session) MaybeLookupBackends() error

+ func (sess *Session) MaybeLookupLocation() error

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

+ func (sess *Session) NewTestListsClient() *TestListsClient

+ func (sess *Session) NewTestListsConfig() *TestListsConfig

+ func (sess *Session) ProbeASN() uint

+ func (sess *Session) ProbeASNString() string

+ func (sess *Session) ProbeCC() string

+ func (sess *Session) ProbeIP() string

+ func (sess *Session) ProbeNetworkName() string

+ func (sess *Session) ResolverIP() string

+ func (sess *Session) SetIncludeProbeASN(value bool)

+ func (sess *Session) SetIncludeProbeCC(value bool)

+ func (sess *Session) SetIncludeProbeIP(value bool)

+ type SessionConfig struct

+ AssetsDir string

+ Logger log.Logger

+ ProxyURL *url.URL

+ SoftwareName string

+ SoftwareVersion string

+ TLSConfig *tls.Config

+ TempDir string

+ type TestListsClient struct

+ func (c *TestListsClient) Fetch(config *TestListsConfig) ([]URLInfo, error)

+ type TestListsConfig struct

+ AvailableCategories []string

+ BaseURL string

+ CountryCode string

+ Limit int

+ type URLInfo interface

+ CategoryCode func() string

+ CountryCode func() string

+ URL func() string