dns

Documentation

Index

• Constants
• type Checker
  • func New(config json.RawMessage) (Checker, error)
  • func (c Checker) Check() (types.Result, error)
  • func (Checker) Type() string

Constants

const Type = "dns"

Type should match the package name

Types

type Checker

type Checker struct {
	// Name is the name of the endpoint.
	Name string `json:"endpoint_name"`
	// This is the name of the DNS server you are testing.
	URL string `json:"endpoint_url"`
	// This is the fqdn of the target server to query the DNS server for.
	Host string `json:"hostname_fqdn,omitempty"`
	// Timeout is the maximum time to wait for a
	// TCP connection to be established.
	Timeout time.Duration `json:"timeout,omitempty"`
	// ThresholdRTT is the maximum round trip time to
	// allow for a healthy endpoint. If non-zero and a
	// request takes longer than ThresholdRTT, the
	// endpoint will be considered unhealthy. Note that
	// this duration includes any in-between network
	// latency.
	ThresholdRTT time.Duration `json:"threshold_rtt,omitempty"`
	// Attempts is how many requests the client will
	// make to the endpoint in a single check.
	Attempts int `json:"attempts,omitempty"`
}

Checker implements a Checker for TCP endpoints.

func New

func New(config json.RawMessage) (Checker, error)

New creates a new Checker instance based on json config

func (Checker) Check

func (c Checker) Check() (types.Result, error)

Check performs checks using c according to its configuration. An error is only returned if there is a configuration error.

func (Checker) Type

func (Checker) Type() string

Type returns the checker package name