endpoint

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 24, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Health

func Health(serviceName string, checker HealthChecker) gin.HandlerFunc

Health returns a handler that reports service health including component statuses.

func Info

func Info(serviceName string) gin.HandlerFunc

Info returns a handler that reports service version and build information.

func Liveness

func Liveness(serviceName string) gin.HandlerFunc

Liveness returns a handler for K8s liveness probes. It simply confirms the process is alive and able to serve HTTP.

func Metrics

func Metrics() gin.HandlerFunc

Metrics returns a handler that reports runtime memory and goroutine metrics.

func Readiness

func Readiness(serviceName string, checker HealthChecker) gin.HandlerFunc

Readiness returns a handler for K8s readiness probes. It checks component health via the HealthChecker to determine if the service can accept traffic.

func Version

func Version() gin.HandlerFunc

Version returns a handler that reports build version information.

Types

type HealthChecker

type HealthChecker func(ctx context.Context) []component.Health

HealthChecker returns health status for registered components.

Jump to

Keyboard shortcuts

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