probe

README

Executors

Documentation

How to write an Executor ?

Documentation

Index

• func GetIPsFromHostname(host string, ipv int) ([]string, error)
• func GetIPsWithPort(host string, port int, ipv int) ([]string, error)
• func ToMap(proberes interface{}) (map[string]interface{}, error)
• type Probe
• type ProbeAnswer
• type ProbeDuration
  • func (d ProbeDuration) MarshalJSON() ([]byte, error)
• type ProbeInfo
  • func (pi ProbeInfo) MarshalJSON() ([]byte, error)
• type ProbeReturn
• type Status
• type StepProbe

Functions

func GetIPsFromHostname

func GetIPsFromHostname(host string, ipv int) ([]string, error)

GetIPsFromHostname returns a array of IPs resolved by a Hostname Ipv4 or Ipv6 This func must be divided WIP

func GetIPsWithPort

func GetIPsWithPort(host string, port int, ipv int) ([]string, error)

func ToMap

func ToMap(proberes interface{}) (map[string]interface{}, error)

Types

type Probe

type Probe interface {
	// Start run a Step TStep
	Run(timeout time.Duration) []ProbeReturn
	GetName() string
	Initialize(StepProbe) error
	GenerateTStepName() string
	GetDefaultTimeout() time.Duration
	GetDefaultFrequency() time.Duration
}

Probe execute a testStep.

type ProbeAnswer

type ProbeAnswer map[string]interface{}

type ProbeDuration

type ProbeDuration struct {
	time.Duration
}

func (ProbeDuration) MarshalJSON

func (d ProbeDuration) MarshalJSON() ([]byte, error)

type ProbeInfo

type ProbeInfo struct {
	Error        string        `json:"error"`
	Status       Status        `json:"status"`
	ProbeCode    int           `json:"probecode"`
	ResponseTime time.Duration `json:"responsetime"`
	SubTest      string        `json:"subtest"`
}

ProbeInfo details DO NOT EDIT

func (ProbeInfo) MarshalJSON

func (pi ProbeInfo) MarshalJSON() ([]byte, error)

type ProbeReturn

type ProbeReturn struct {
	ProbeInfo ProbeInfo
	Answer    ProbeAnswer
}

ProbeReturn represents an probe result on a test step

type Status

type Status int

const (
	Success Status = 1  // Success
	Timeout Status = -2 // The probe request encountered a timeout
	Error   Status = -3 // The probe request encountered a error (can be considered as a desired state)
	Failure Status = -4 // The probe cannot create the request nor send it
)

type StepProbe

type StepProbe map[string]interface{}