health

Documentation

Overview

Package health contains code for health checks.

Index

• func GetVersion() string
• func SetupRouter(r chi.Router, p ...Pinger)
• type Pinger
  • func SubjectPinger(s string, f func(ctx context.Context) error) 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 Pinger

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

Pinger pings external service.

func SubjectPinger

func SubjectPinger(s string, f func(ctx context.Context) error) Pinger

SubjectPinger returns wrapper over Ping function which adds subject to error message. It is helpful for external Ping function, e.g. (sql.DB).Ping.

type VersionResponse

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

VersionResponse ...