healthz

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• func IsWrongType(err error) bool
• type Config
  • func DefaultConfig() Config
• type Endpoint
  • func New(config Config) (*Endpoint, error)
  • func (e *Endpoint) Decoder() kithttp.DecodeRequestFunc
  • func (e *Endpoint) Encoder() kithttp.EncodeResponseFunc
  • func (e *Endpoint) Endpoint() kitendpoint.Endpoint
  • func (e *Endpoint) Method() string
  • func (e *Endpoint) Middlewares() []kitendpoint.Middleware
  • func (e *Endpoint) Name() string
  • func (e *Endpoint) Path() string

Constants

const (
	// Method is the HTTP method this endpoint is register for.
	Method = "GET"
	// Name identifies the endpoint. It is aligned to the package path.
	Name = "healthz"
	// Path is the HTTP request path this endpoint is registered for.
	Path = "/healthz"
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsWrongType

func IsWrongType(err error) bool

IsWrongType asserts wrongTypeError.

Types

type Config

type Config struct {
	// Dependencies.
	Logger   micrologger.Logger
	Services []healthz.Service
}

Config represents the configured used to create a healthz endpoint.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new healthz endpoint by best effort.

type Endpoint

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

func New

func New(config Config) (*Endpoint, error)

New creates a new configured healthz endpoint.

func (*Endpoint) Decoder

func (e *Endpoint) Decoder() kithttp.DecodeRequestFunc

func (*Endpoint) Encoder

func (e *Endpoint) Encoder() kithttp.EncodeResponseFunc

func (*Endpoint) Endpoint

func (e *Endpoint) Endpoint() kitendpoint.Endpoint

func (*Endpoint) Method

func (e *Endpoint) Method() string

func (*Endpoint) Middlewares

func (e *Endpoint) Middlewares() []kitendpoint.Middleware

func (*Endpoint) Name

func (e *Endpoint) Name() string

func (*Endpoint) Path

func (e *Endpoint) Path() string