Documentation
¶
Overview ¶
Package httpserver contains helpers for creating zero-downtime REST APIs.
There are tools for: - observability (both for requests and connection info) - health checks
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Name is the name of the server in o11y
Name string
// Addr is the address to listen on
Addr string
// Handler is the HTTP handler to delegate requests to.
Handler http.Handler
// Optional
// Network must be "tcp", "tcp4", "tcp6", "unix", "unixpacket" or "" (which defaults to tcp).
Network string
// ShutdownGrace is the period during which the server allows requests to be fully served.
ShutdownGrace time.Duration
}
type HTTPServer ¶
type HTTPServer struct {
// contains filtered or unexported fields
}
func (HTTPServer) Addr ¶
func (s HTTPServer) Addr() string
func (*HTTPServer) MetricsProducer ¶
func (s *HTTPServer) MetricsProducer() MetricProducer
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ginrouter provides a common base for configuring a Gin router instance, wiring in the standard o11y wrappers.
|
Package ginrouter provides a common base for configuring a Gin router instance, wiring in the standard o11y wrappers. |
|
Package healthcheck contains a simple healthcheck handler.
|
Package healthcheck contains a simple healthcheck handler. |
Click to show internal directories.
Click to hide internal directories.