prober

Documentation

Index

• Variables
• func DebugOutput(module *config.Module, logBuffer *bytes.Buffer, registry *prometheus.Registry) string
• func Handler(w http.ResponseWriter, r *http.Request, c *config.Config, logger log.Logger, ...)
• func ProbeDNS(ctx context.Context, target string, module config.Module, ...) bool
• func ProbeGRPC(ctx context.Context, target string, module config.Module, ...) (success bool)
• func ProbeHTTP(ctx context.Context, target string, module config.Module, ...) (success bool)
• func ProbeICMP(ctx context.Context, target string, module config.Module, ...) (success bool)
• func ProbeTCP(ctx context.Context, target string, module config.Module, ...) bool
• type GRPCHealthCheck
  • func NewGrpcHealthCheckClient(conn *grpc.ClientConn) GRPCHealthCheck
• type ProbeFn
• type Result
• type ResultHistory
  • func (rh *ResultHistory) Add(moduleName, target, debugOutput string, success bool)
  • func (rh *ResultHistory) GetById(id int64) *Result
  • func (rh *ResultHistory) GetByTarget(target string) *Result
  • func (rh *ResultHistory) List() []*Result

Variables

var (
	Probers = map[string]ProbeFn{
		"http": ProbeHTTP,
		"tcp":  ProbeTCP,
		"icmp": ProbeICMP,
		"dns":  ProbeDNS,
		"grpc": ProbeGRPC,
	}
)

Functions

func DebugOutput

func DebugOutput(module *config.Module, logBuffer *bytes.Buffer, registry *prometheus.Registry) string

DebugOutput returns plaintext debug output for a probe.

func Handler

func Handler(w http.ResponseWriter, r *http.Request, c *config.Config, logger log.Logger, rh *ResultHistory, timeoutOffset float64, params url.Values,
	moduleUnknownCounter prometheus.Counter,
	logLevelProber level.Option)

func ProbeDNS

func ProbeDNS(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) bool

func ProbeGRPC

func ProbeGRPC(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (success bool)

func ProbeHTTP

func ProbeHTTP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (success bool)

func ProbeICMP

func ProbeICMP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) (success bool)

func ProbeTCP

func ProbeTCP(ctx context.Context, target string, module config.Module, registry *prometheus.Registry, logger log.Logger) bool

Types

type GRPCHealthCheck

type GRPCHealthCheck interface {
	Check(c context.Context, service string) (bool, codes.Code, *peer.Peer, string, error)
}

func NewGrpcHealthCheckClient

func NewGrpcHealthCheckClient(conn *grpc.ClientConn) GRPCHealthCheck

type ProbeFn

type ProbeFn func(ctx context.Context, target string, config config.Module, registry *prometheus.Registry, logger log.Logger) bool

type Result

type Result struct {
	Id          int64
	ModuleName  string
	Target      string
	DebugOutput string
	Success     bool
}

Result contains the result of the execution of a probe

type ResultHistory

type ResultHistory struct {
	MaxResults uint
	// contains filtered or unexported fields
}

ResultHistory contains two history slices: `results` contains most recent `maxResults` results. After they expire out of `results`, failures will be saved in `preservedFailedResults`. This ensures that we are always able to see debug information about recent failures.

func (*ResultHistory) Add

func (rh *ResultHistory) Add(moduleName, target, debugOutput string, success bool)

Add a result to the history.

func (*ResultHistory) GetById

func (rh *ResultHistory) GetById(id int64) *Result

Get returns a given result by id.

func (*ResultHistory) GetByTarget

func (rh *ResultHistory) GetByTarget(target string) *Result

Get returns a given result by url.

func (*ResultHistory) List

func (rh *ResultHistory) List() []*Result

List returns a list of all results.