httpserver

Documentation

Overview

Copyright (c) 2015-2024 Peter Kieltyka (https://github.com/pkieltyka), Google Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func NewServer(addr string, h http.Handler, options ...Option) *http.Server
• func RenderError(w http.ResponseWriter, statusCode int, err error)
• func RenderJSON(w http.ResponseWriter, statusCode int, v any)
• func RenderText(w http.ResponseWriter, statusCode int, v string)
• type Option
  • func WithLogger(l *log.Logger) Option
  • func WithRegisterer(r prometheus.Registerer) Option
  • func WithTracerProvider(tp trace.TracerProvider) Option
• type Options
• type WrapResponseWriter
  • func NewWrapResponseWriter(w http.ResponseWriter, protoMajor int) WrapResponseWriter

Functions

func NewServer

func NewServer(addr string, h http.Handler, options ...Option) *http.Server

func RenderError

func RenderError(w http.ResponseWriter, statusCode int, err error)

func RenderJSON

func RenderJSON(w http.ResponseWriter, statusCode int, v any)

func RenderText

func RenderText(w http.ResponseWriter, statusCode int, v string)

Types

type Option

type Option func(o *Options)

func WithLogger

func WithLogger(l *log.Logger) Option

WithLogger is an option setter for specifying a logger for HTTP telemetry and error logging.

func WithRegisterer

func WithRegisterer(r prometheus.Registerer) Option

WithRegisterer sets a custom Prometheus registerer for metrics.

func WithTracerProvider

func WithTracerProvider(tp trace.TracerProvider) Option

WithTracerProvider configures OpenTelemetry tracing with the provided tracer provider.

type Options

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

type WrapResponseWriter

type WrapResponseWriter interface {
	http.ResponseWriter
	// Status returns the HTTP status of the request, or 0 if one has not
	// yet been sent.
	Status() int
	// BytesWritten returns the total number of bytes sent to the client.
	BytesWritten() int
	// Tee causes the response body to be written to the given io.Writer in
	// addition to proxying the writes through. Only one io.Writer can be
	// tee'd to at once: setting a second one will overwrite the first.
	// Writes will be sent to the proxy before being written to this
	// io.Writer. It is illegal for the tee'd writer to be modified
	// concurrently with writes.
	Tee(io.Writer)
	// Unwrap returns the original proxied target.
	Unwrap() http.ResponseWriter
	// Discard causes all writes to the original ResponseWriter be discarded,
	// instead writing only to the tee'd writer if it's set.
	// The caller is responsible for calling WriteHeader and Write on the
	// original ResponseWriter once the processing is done.
	Discard()
}

WrapResponseWriter is a proxy around an http.ResponseWriter that allows you to hook into various parts of the response process.

func NewWrapResponseWriter

func NewWrapResponseWriter(w http.ResponseWriter, protoMajor int) WrapResponseWriter

NewWrapResponseWriter wraps an http.ResponseWriter, returning a proxy that allows you to hook into various parts of the response process.