checkgrp

package

v0.0.0-...-c2300e3 Latest Latest Go to latest Published: Dec 28, 2023 License: Apache-2.0 Imports: 8 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/nhaancs/bhms

Documentation ¶

Overview ¶

Package checkgrp maintains the group of handlers for health checking.

Index ¶

type Handlers
- func New(build string, db *sqlx.DB) *Handlers
- func (h *Handlers) Liveness(ctx context.Context, w http.ResponseWriter, r *http.Request) error
- func (h *Handlers) Readiness(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Handlers ¶

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

Handlers manages the set of check endpoints.

func New ¶

func New(build string, db *sqlx.DB) *Handlers

New constructs a Handlers api for the check group.

func (*Handlers) Liveness ¶

func (h *Handlers) Liveness(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Liveness returns simple status info if the service is alive. If the app is deployed to a Kubernetes cluster, it will also return pod, node, and namespace details via the Downward API. The Kubernetes environment variables need to be set within your Pod/Deployment manifest.

func (*Handlers) Readiness ¶

func (h *Handlers) Readiness(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Readiness checks if the database is ready and if not will return a 500 status. Do not respond by just returning an error because further up in the call stack it will interpret that as a non-trusted error.

Source Files ¶

View all Source files

checkgrp.go

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