check

Documentation

Index

• func RunCheck(collector Collector, host, port string, opts ...Option) error
• type CollectedInfo
• type Collector
• type Option
  • func CollectTiming() Option
  • func UseNameserver(nameserver string) Option
  • func WithContext(ctx context.Context) Option
• type Options

Functions

func RunCheck

func RunCheck(collector Collector, host, port string, opts ...Option) error

RunCheck executes checks and collects facts for provided host and port.

Types

type CollectedInfo

type CollectedInfo struct {
	Name     string
	Value    string
	Duration time.Duration
}

CollectedInfo is key-value information used to represent facts collected from an endpoint check execution.

type Collector

type Collector chan CollectedInfo

Collector is a channel that collected information is published to.

type Option

type Option func(*Options)

func CollectTiming

func CollectTiming() Option

CollectTiming directs the check execution to collecting timing facts.

func UseNameserver

func UseNameserver(nameserver string) Option

UseNameserver directs the check execution to use a specific nameserver to resolve the target/host.

func WithContext

func WithContext(ctx context.Context) Option

WithContext sets the context used with a check execution.

type Options

type Options struct {
	// contains filtered or unexported fields
}