api

Documentation

Index

• Constants
• func APIKeyAuthMiddleware(config types.JobConfiguration) echo.MiddlewareFunc
• func HealthMetricsMiddleware(healthMetrics *HealthMetrics) echo.MiddlewareFunc
• func Healthz() func(c echo.Context) error
• func Readyz(jobServer *jobserver.JobServer, healthMetrics *HealthMetrics) func(c echo.Context) error
• func Start(ctx context.Context, listenAddress, dataDIR string, standalone bool, ...) error
• type HealthMetrics
  • func NewHealthMetrics() *HealthMetrics
  • func (hm *HealthMetrics) GetStats() map[string]interface{}
  • func (hm *HealthMetrics) IsHealthy() bool
  • func (hm *HealthMetrics) RecordError()
  • func (hm *HealthMetrics) RecordSuccess()
• type HealthzResponse
• type ReadinessChecks
• type ReadyzResponse

Constants

const HealthCheckPath = "/healthz"

const ReadinessCheckPath = "/readyz"

Functions

func APIKeyAuthMiddleware

func APIKeyAuthMiddleware(config types.JobConfiguration) echo.MiddlewareFunc

APIKeyAuthMiddleware returns an Echo middleware that checks for the API key in the request headers.

func HealthMetricsMiddleware

func HealthMetricsMiddleware(healthMetrics *HealthMetrics) echo.MiddlewareFunc

HealthMetricsMiddleware tracks success and error rates for readiness probe

func Healthz

func Healthz() func(c echo.Context) error

Healthz is the liveness probe endpoint

func Readyz

func Readyz(jobServer *jobserver.JobServer, healthMetrics *HealthMetrics) func(c echo.Context) error

Readyz is the readiness probe endpoint

func Start

func Start(ctx context.Context, listenAddress, dataDIR string, standalone bool, config types.JobConfiguration) error

Types

type HealthMetrics

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

HealthMetrics tracks health-related metrics for the service

func NewHealthMetrics

func NewHealthMetrics() *HealthMetrics

NewHealthMetrics creates a new health metrics tracker

func (*HealthMetrics) GetStats

func (hm *HealthMetrics) GetStats() map[string]interface{}

GetStats returns current health statistics

func (*HealthMetrics) IsHealthy

func (hm *HealthMetrics) IsHealthy() bool

IsHealthy checks if the service is healthy based on error rate

func (*HealthMetrics) RecordError

func (hm *HealthMetrics) RecordError()

RecordError records an error

func (*HealthMetrics) RecordSuccess

func (hm *HealthMetrics) RecordSuccess()

RecordSuccess records a successful request

type HealthzResponse

type HealthzResponse struct {
	Status  string `json:"status"`
	Service string `json:"service"`
}

HealthzResponse represents the liveness probe response

type ReadinessChecks

type ReadinessChecks struct {
	JobServer string                 `json:"job_server"`
	ErrorRate string                 `json:"error_rate"`
	Stats     map[string]interface{} `json:"stats,omitempty"`
}

ReadinessChecks contains individual readiness check results

type ReadyzResponse

type ReadyzResponse struct {
	Service string          `json:"service"`
	Ready   bool            `json:"ready"`
	Checks  ReadinessChecks `json:"checks"`
}

ReadyzResponse represents the readiness probe response