signal

Documentation

Overview

Package signal implements the signal experiment.

Index

• type Measurer
  • func NewMeasurer(rawOptions json.RawMessage) *Measurer
  • func (m *Measurer) ExperimentName() string
  • func (m *Measurer) ExperimentVersion() string
  • func (m *Measurer) GetSummaryKeys(*model.Measurement) (any, error)
  • func (m *Measurer) Run(ctx context.Context, args *model.ExperimentArgs) error
• type SummaryKeys

Types

type Measurer

type Measurer struct {
	// RawOptions contains the raw options for this experiment.
	RawOptions json.RawMessage
}

Measurer is the signal measurer.

func NewMeasurer

func NewMeasurer(rawOptions json.RawMessage) *Measurer

NewMeasurer returns a new Measurer instance.

func (*Measurer) ExperimentName

func (m *Measurer) ExperimentName() string

ExperimentName implements model.ExperimentMeasurer

func (*Measurer) ExperimentVersion

func (m *Measurer) ExperimentVersion() string

ExperimentVersion implements model.ExperimentMeasurer

func (*Measurer) GetSummaryKeys

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

GetSummaryKeys implements model.ExperimentMeasurer

func (*Measurer) Run

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

Run implements model.ExperimentMeasurer

type SummaryKeys

type SummaryKeys struct {
	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.