Documentation
¶
Overview ¶
Package server provides a preconfigured HTTP server with diagnostic hooks.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var Set = wire.NewSet( New, wire.Struct(new(Options), "RequestLogger", "HealthChecks", "TraceExporter", "DefaultSamplingPolicy", "Driver"), wire.Value(&DefaultDriver{}), wire.Bind(new(driver.Server), new(*DefaultDriver)), )
Set is a Wire provider set that produces a *Server given the fields of Options.
Functions ¶
This section is empty.
Types ¶
type DefaultDriver ¶
DefaultDriver implements the driver.Server interface. The zero value is a valid http.Server.
func NewDefaultDriver ¶
func NewDefaultDriver() *DefaultDriver
NewDefaultDriver creates a driver with an http.Server with default timeouts.
func (*DefaultDriver) ListenAndServe ¶
func (dd *DefaultDriver) ListenAndServe(addr string, h http.Handler) error
ListenAndServe sets the address and handler on DefaultDriver's http.Server, then calls ListenAndServe on it.
func (*DefaultDriver) ListenAndServeTLS ¶ added in v0.20.0
func (dd *DefaultDriver) ListenAndServeTLS(addr, certFile, keyFile string, h http.Handler) error
ListenAndServeTLS sets the address and handler on DefaultDriver's http.Server, then calls ListenAndServeTLS on it.
DefaultDriver.Server.TLSConfig may be set to configure additional TLS settings.
type Options ¶
type Options struct {
// RequestLogger specifies the logger that will be used to log requests.
RequestLogger requestlog.Logger
// HealthChecks specifies the health checks to be run when the
// /healthz/readiness endpoint is requested.
HealthChecks []health.Checker
// TraceExporter exports sampled trace spans.
TraceExporter trace.Exporter
// DefaultSamplingPolicy is a function that takes a
// trace.SamplingParameters struct and returns a true or false decision about
// whether it should be sampled and exported.
DefaultSamplingPolicy trace.Sampler
// Driver serves HTTP requests.
Driver driver.Server
}
Options is the set of optional parameters.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server is a preconfigured HTTP server with diagnostic hooks. The zero value is a server with the default options.
func (*Server) ListenAndServe ¶
ListenAndServe is a wrapper to use wherever http.ListenAndServe is used. It wraps the http.Handler provided to New with a handler that handles tracing and request logging. If the handler is nil, then http.DefaultServeMux will be used. A configured Requestlogger will log all requests except HealthChecks.
func (*Server) ListenAndServeTLS ¶ added in v0.20.0
ListenAndServeTLS is a wrapper to use wherever http.ListenAndServeTLS is used. It wraps the http.Handler provided to New with a handler that handles tracing and request logging. If the handler is nil, then http.DefaultServeMux will be used. A configured Requestlogger will log all requests except HealthChecks.
func (*Server) Shutdown ¶
Shutdown gracefully shuts down the server without interrupting any active connections.
Example ¶
package main
import (
"context"
"fmt"
"log"
"net/http"
"os"
"os/signal"
"gocloud.dev/server"
)
func main() {
// OPTIONAL: Specify a driver in the options for the constructor.
// NewDefaultDriver will be used by default if it is not explicitly set, and
// uses http.Server with read, write, and idle timeouts set. When Shutdown
// is called on the server, it is called on the driver.
srvOptions := &server.Options{
Driver: server.NewDefaultDriver(),
}
// Pass the options to the Server constructor.
srv := server.New(http.DefaultServeMux, srvOptions)
// If your application will be behind a load balancer that handles graceful
// shutdown of requests, you may not need to call Shutdown on the server
// directly. If you need to ensure graceful shutdown directly, it is important
// to have a separate goroutine, because ListenAndServe blocks indefinitely.
go func() {
interrupt := make(chan os.Signal, 1)
signal.Notify(interrupt, os.Interrupt)
// Receive off the chanel in a loop, because the interrupt could be sent
// before ListenAndServe starts.
for {
<-interrupt
srv.Shutdown(context.Background())
}
}()
// Register a route.
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprintln(w, "Hello, World!")
})
// Start the server. You will see requests logged to STDOUT.
// In the absence of an error, ListenAndServe blocks forever.
if err := srv.ListenAndServe(":8080"); err != nil {
log.Fatalf("%v", err)
}
}
Output:
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package driver defines an interface for custom HTTP listeners.
|
Package driver defines an interface for custom HTTP listeners. |
|
Package health provides health check handlers.
|
Package health provides health check handlers. |
|
sqlhealth
Package sqlhealth provides a health check for a SQL database connection.
|
Package sqlhealth provides a health check for a SQL database connection. |
|
Package requestlog provides an http.Handler that logs information about requests.
|
Package requestlog provides an http.Handler that logs information about requests. |
|
Package sdserver provides the diagnostic hooks for a server using Stackdriver.
|
Package sdserver provides the diagnostic hooks for a server using Stackdriver. |
|
Package xrayserver provides the diagnostic hooks for a server using AWS X-Ray.
|
Package xrayserver provides the diagnostic hooks for a server using AWS X-Ray. |