admin

Documentation

Overview

Package admin simplifies the setup of various administrative endpoints such as healthchecks, debugging, and service information.

Index

• func Runner(port string, options ...OptionFunc) ifrit.Runner
• type OptionFunc
  • func WithInfo(info ServiceInfo) OptionFunc
  • func WithUptime() OptionFunc
• type ServiceInfo

Functions

func Runner

func Runner(port string, options ...OptionFunc) ifrit.Runner

Runner builds and returns a runner that, when run, will start an HTTP server listening on the specified port that provides the Go pprof endpoints from the standard library along with the additional trace endpoints.

Types

type OptionFunc

type OptionFunc func(*server)

OptionFunc is used to configure the runner.

func WithInfo

func WithInfo(info ServiceInfo) OptionFunc

WithInfo configures the information endpoint to present information about the service.

func WithUptime

func WithUptime() OptionFunc

WithUptime adds a handler to the administrative endpoint that returns the uptime of the service. It is registered at /uptime.

type ServiceInfo

type ServiceInfo struct {
	Name        string
	Description string
	Team        string
}

ServiceInfo represents information about a service that operators may find useful.