health

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)
• type Health
  • func NewHealth() *Health
  • func NewHealthWithConfigPath(path string) (*Health, error)
  • func NewHealthWithOptions(options *Options) *Health
  • func (i *Health) Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)

Register registers a new health checker for fiber with options.

Types

type Health

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

Health represets a health checker plugin for fiber

func NewHealth

func NewHealth() *Health

NewHealthWithOptions returns a health checker with options.

func NewHealthWithConfigPath

func NewHealthWithConfigPath(path string) (*Health, error)

NewHealthWithOptions returns a health checker with options from config path.

func NewHealthWithOptions

func NewHealthWithOptions(options *Options) *Health

NewHealthWithOptions returns a health checker with options.

func (*Health) Register

func (i *Health) Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)

Register registers this health checker for fiber with options.

type Options

type Options struct {
	Enabled bool
	Route   string
}

Options represents healh checker for fiber options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.