admin

package

v0.0.0-20180203224945-... Latest Latest Go to latest Published: Feb 3, 2018 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/qing-chi-2013/paraphernalia

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL