modules

type ProbeData struct {
	IsUp        *float64     // Indicates the success/failure of the probe.
	PayloadSize *float64     // Optional. Response payload size.
	Latency     *float64     // Latency in milli seconds.
	StartTime   *int64       // Unix epoch in nano seconds.
	EndTime     *int64       // Unix epoch in nano seconds.
	Headers     *http.Header // Optional, primarily for the http module.
	Payload     *[]byte      // Optional.
}

type Prober interface {
	// Prepare is used to set up the probe module. Use it to do custom initialization.
	// Prepare is guranteed to be called before executing the Run() method of the module.
	Prepare() error

	// Run runs the probe. It will be called in a loop. This is the most import method of the interface.
	// Implementation should send the probe response data using the ProbeData struct.
	// In case of any error, the same should be send via the error channel. The response channel
	// should not be used in error situations.
	Run(chan<- *ProbeData, chan<- error)

	// Name returns the name of the probe.
	Name() *string

	// TimeoutSecs returns the timeout for a given probe.
	TimeoutSecs() *int

	// RunIntervalSecs returns the frequency of the probe.
	RunIntervalSecs() *int

	// RetConfig returns the config values of the probe module. This will be used in the http ui.
	RetConfig() string
}

type TestProbe struct {
	ProbeName     *string `json:"probe_name"`
	ProbeInterval *int    `json:"probe_interval"`
	ProbeTimeout  *int    `json:"probe_timeout"`
	ProbeMyConfig *string `json:"probe_my_config"` // this config field is specific to this module.
}