health

Documentation

Overview

Package health provides handler for health checks.

Index

• func GetVersion() string
• func SetupRouter(r chi.Router, p ...Pinger)
• type PingFunc
  • func (f PingFunc) Ping(ctx context.Context) error
• type Pinger
• type VersionResponse

Functions

func GetVersion

func GetVersion() string

GetVersion returns service's version and commit.

func SetupRouter

func SetupRouter(r chi.Router, p ...Pinger)

SetupRouter setups all pingers to /health.

Types

type PingFunc

type PingFunc func(ctx context.Context) error

PingFunc is wrapper for raw func.

func (PingFunc) Ping

func (f PingFunc) Ping(ctx context.Context) error

Ping ...

type Pinger

type Pinger interface {
	Ping(ctx context.Context) error
}

Pinger pings external service.

type VersionResponse

type VersionResponse struct {
	Version string `json:"version"`
	Commit  string `json:"commit"`
}

VersionResponse ...