health

package

v0.9.4 Latest Latest Go to latest Published: Mar 10, 2022 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/inetmock/inetmock

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func HTTP2Client(cfg Config, tlsConfig *tls.Config) *gohttp.Client
func HTTPClient(cfg Config, tlsConfig *tls.Config) *gohttp.Client
func NewHealthHandler(checker Checker) http.Handler
type Check
- func NewCheckFunc(name string, delegate func(ctx context.Context) error) Check
- func NewDNSRuleCheck(name string, resolvers ResolverForModule, logger logging.Logger, ...) (Check, error)
- func NewHTTPRuleCheck(name string, clients HTTPClientForModule, logger logging.Logger, ...) (Check, error)
type Checker
- func New() Checker
- func NewFromConfig(logger logging.Logger, cfg Config, tlsConfig *tls.Config) (Checker, error)
type ClientsConfig
type ClientsForModuleMap
- func (c ClientsForModuleMap) ClientForModule(module string) (*gohttp.Client, error)
type Config
type HTTPClientForModule
- func HTTPClients(cfg Config, tlsConfig *tls.Config) HTTPClientForModule
type ResolverForModule
- func Resolvers(cfg Config, tlsConfig *tls.Config) ResolverForModule
type ResolversForModuleMap
- func (d ResolversForModuleMap) ResolverForModule(module string) (dns.Resolver, error)
type Result
- func (r Result) CheckResult(name string) (knownCheck bool, result error)
- func (r Result) IsHealthy() (healthy bool)
- func (r Result) MarshalJSON() ([]byte, error)
type ResultWriter
- func NewResultWriter() ResultWriter
type Server
type ValidationRule

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrEmptyCheckName     = errors.New("name of the check must not be empty")
	ErrAmbiguousCheckName = errors.New("a check with the same name is already registered")
	ErrNoClientForModule  = errors.New("no client for module registered")
)

Functions ¶

func HTTP2Client ¶ added in v0.7.0

func HTTP2Client(cfg Config, tlsConfig *tls.Config) *gohttp.Client

func HTTPClient ¶ added in v0.6.0

func HTTPClient(cfg Config, tlsConfig *tls.Config) *gohttp.Client

func NewHealthHandler ¶ added in v0.6.0

func NewHealthHandler(checker Checker) http.Handler

Types ¶

type Check ¶

type Check interface {
	Name() string
	Status(ctx context.Context) error
}

func NewCheckFunc ¶ added in v0.6.0

func NewCheckFunc(name string, delegate func(ctx context.Context) error) Check

func NewDNSRuleCheck ¶ added in v0.6.0

func NewDNSRuleCheck(name string, resolvers ResolverForModule, logger logging.Logger, check *rules.Check) (Check, error)

func NewHTTPRuleCheck ¶ added in v0.6.0

func NewHTTPRuleCheck(name string, clients HTTPClientForModule, logger logging.Logger, check *rules.Check) (Check, error)

type Checker ¶

type Checker interface {
	AddCheck(check Check) error
	Status(ctx context.Context) Result
}

func New ¶

func New() Checker

func NewFromConfig ¶ added in v0.6.0

func NewFromConfig(logger logging.Logger, cfg Config, tlsConfig *tls.Config) (Checker, error)

type ClientsConfig ¶ added in v0.6.0

type ClientsConfig struct {
	HTTP  Server
	HTTPS Server
	DNS   Server
	DoT   Server
}

type ClientsForModuleMap ¶ added in v0.7.0

type ClientsForModuleMap map[string]*gohttp.Client

func (ClientsForModuleMap) ClientForModule ¶ added in v0.7.0

func (c ClientsForModuleMap) ClientForModule(module string) (*gohttp.Client, error)

type Config ¶ added in v0.6.0

type Config struct {
	Client ClientsConfig
	Rules  []ValidationRule
}

type HTTPClientForModule ¶ added in v0.7.0

type HTTPClientForModule interface {
	ClientForModule(module string) (*gohttp.Client, error)
}

func HTTPClients ¶ added in v0.7.0

func HTTPClients(cfg Config, tlsConfig *tls.Config) HTTPClientForModule

type ResolverForModule ¶ added in v0.7.0

type ResolverForModule interface {
	ResolverForModule(module string) (dns.Resolver, error)
}

func Resolvers ¶ added in v0.7.0

func Resolvers(cfg Config, tlsConfig *tls.Config) ResolverForModule

type ResolversForModuleMap ¶ added in v0.7.0

type ResolversForModuleMap map[string]dns.Resolver

func (ResolversForModuleMap) ResolverForModule ¶ added in v0.7.0

func (d ResolversForModuleMap) ResolverForModule(module string) (dns.Resolver, error)

type Result ¶

type Result map[string]error

func (Result) CheckResult ¶ added in v0.6.0

func (r Result) CheckResult(name string) (knownCheck bool, result error)

func (Result) IsHealthy ¶ added in v0.6.0

func (r Result) IsHealthy() (healthy bool)

func (Result) MarshalJSON ¶ added in v0.6.0

func (r Result) MarshalJSON() ([]byte, error)

type ResultWriter ¶ added in v0.6.0

type ResultWriter interface {
	WriteResult(checkName string, result error)
	GetResult() Result
}

func NewResultWriter ¶ added in v0.6.0

func NewResultWriter() ResultWriter

type Server ¶ added in v0.6.0

type Server struct {
	IP    string
	Port  uint16
	Proto string
}

type ValidationRule ¶ added in v0.6.0

type ValidationRule struct {
	Name string
	Rule string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
dns
http

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL