srvhttp

Documentation

Index

• type Config
  • func (cfg *Config[T]) Build() (any, error)
• type HTTPMetrics
  • func (m *HTTPMetrics) AddInflightRequests(ctx context.Context, props metrics.HTTPProperties, quantity int)
  • func (m *HTTPMetrics) ObserveHTTPRequestDuration(ctx context.Context, props metrics.HTTPReqProperties, duration time.Duration)
  • func (m *HTTPMetrics) ObserveHTTPResponseSize(ctx context.Context, props metrics.HTTPReqProperties, sizeBytes int64)
  • func (m *HTTPMetrics) RegisterMetrics(reg *prometheus.Registry) error
• type MetricsContributor
• type Server
  • func (Server[T]) BuildConfig() (app.Materializer, error)
  • func (t *Server[T]) Close(ctx context.Context) error
  • func (r *Server[T]) Deps() []any
  • func (t *Server[T]) HealthCheck(_ context.Context) error
  • func (r *Server[T]) Inject(args []any)
  • func (t *Server[T]) Start(ctx context.Context) error

Types

type Config

type Config[T http.Handler] struct {
	Label common.Label
	Host  common.Host
	Port  common.Port
}

Config is the HTTP server spec (Label, Host, Port); ecfg fills before Build.

func (*Config[T]) Build

func (cfg *Config[T]) Build() (any, error)

type HTTPMetrics

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

HTTPMetrics is a singleton pool resource: contributor + shared slok Recorder for all srv-http servers.

func (*HTTPMetrics) AddInflightRequests

func (m *HTTPMetrics) AddInflightRequests(ctx context.Context, props metrics.HTTPProperties, quantity int)

func (*HTTPMetrics) ObserveHTTPRequestDuration

func (m *HTTPMetrics) ObserveHTTPRequestDuration(ctx context.Context, props metrics.HTTPReqProperties, duration time.Duration)

func (*HTTPMetrics) ObserveHTTPResponseSize

func (m *HTTPMetrics) ObserveHTTPResponseSize(ctx context.Context, props metrics.HTTPReqProperties, sizeBytes int64)

func (*HTTPMetrics) RegisterMetrics

func (m *HTTPMetrics) RegisterMetrics(reg *prometheus.Registry) error

type MetricsContributor

type MetricsContributor interface {
	RegisterMetrics(reg *prometheus.Registry) error
}

MetricsContributor registers HTTP metrics collectors into a shared registry. Same method signature as github.com/omcrgnt/ops/metrics.MetricsContributor.

type Server

type Server[T http.Handler] struct {
	http.Server
	// contains filtered or unexported fields
}

Server is a catalog slot for an HTTP server bound to handler type T. Zero value implements app.Configurable via BuildConfig; materialized *Server[T] is the runtime resource.

func (Server[T]) BuildConfig

func (Server[T]) BuildConfig() (app.Materializer, error)

func (*Server[T]) Close

func (t *Server[T]) Close(ctx context.Context) error

func (*Server[T]) Deps

func (r *Server[T]) Deps() []any

func (*Server[T]) HealthCheck

func (t *Server[T]) HealthCheck(_ context.Context) error

func (*Server[T]) Inject

func (r *Server[T]) Inject(args []any)

func (*Server[T]) Start

func (t *Server[T]) Start(ctx context.Context) error