check

Documentation

Overview

Package check validates a token via HTTP or a shell command.

Index

• type Checker
  • func New(c config.Check, proxy string) (Checker, error)
• type Result

Types

type Checker

type Checker interface {
	Check(ctx context.Context, token string) Result
}

Checker validates a token value.

func New

func New(c config.Check, proxy string) (Checker, error)

New builds a Checker from config. proxy applies to http checks only.

type Result

type Result struct {
	OK      bool
	Latency time.Duration
	Status  int // HTTP status, 0 for command checks
	Err     error
}

Result is the outcome of a single check.