Documentation
¶
Overview ¶
Package tsweb contains code used in various Tailscale webservers.
Index ¶
- Variables
- func AllowDebugAccess(r *http.Request) bool
- func DefaultCertDir(leafDir string) string
- func IsProd443(addr string) bool
- func Protected(h http.Handler) http.Handler
- func StdHandler(h ReturnHandler, opts HandlerOptions) http.Handler
- func Uptime() time.Duration
- func VarzHandler(w http.ResponseWriter, r *http.Request)
- func WritePrometheusExpvar(w io.Writer, kv expvar.KeyValue)
- type AccessLogRecord
- type DebugHandler
- func (d *DebugHandler) Handle(slug, desc string, handler http.Handler)
- func (d *DebugHandler) KV(k string, v interface{})
- func (d *DebugHandler) KVFunc(k string, v func() interface{})
- func (d *DebugHandler) Section(f func(w io.Writer, r *http.Request))
- func (d *DebugHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (d *DebugHandler) URL(url, desc string)
- type HTTPError
- type HandlerOptions
- type JSONHandlerFunc
- type Port80Handler
- type PrometheusMetricsReflectRooter
- type ReturnHandler
- type ReturnHandlerFunc
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var DevMode bool
DevMode controls whether extra output in shown, for when the binary is being run in dev mode.
Functions ¶
func AllowDebugAccess ¶
AllowDebugAccess reports whether r should be permitted to access various debug endpoints.
func DefaultCertDir ¶
func Protected ¶
Protected wraps a provided debug handler, h, returning a Handler that enforces AllowDebugAccess and returns forbidden replies for unauthorized requests.
func StdHandler ¶ added in v0.98.0
func StdHandler(h ReturnHandler, opts HandlerOptions) http.Handler
StdHandler converts a ReturnHandler into a standard http.Handler. Handled requests are logged using opts.Logf, as are any errors. Errors are handled as specified by the Handler interface.
func VarzHandler ¶ added in v1.4.0
func VarzHandler(w http.ResponseWriter, r *http.Request)
VarzHandler is an HTTP handler to write expvar values into the prometheus export format:
https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md
It makes the following assumptions:
- *expvar.Int are counters (unless marked as a gauge_; see below)
- a *tailscale/metrics.Set is descended into, joining keys with underscores. So use underscores as your metric names.
- an expvar named starting with "gauge_" or "counter_" is of that Prometheus type, and has that prefix stripped.
- anything else is untyped and thus not exported.
- expvar.Func can return an int or int64 (for now) and anything else is not exported.
This will evolve over time, or perhaps be replaced.
Types ¶
type AccessLogRecord ¶ added in v0.98.0
type AccessLogRecord struct {
// Timestamp at which request processing started.
When time.Time `json:"when"`
// Time it took to finish processing the request. It does not
// include the entire lifetime of the underlying connection in
// cases like connection hijacking, only the lifetime of the HTTP
// request handler.
Seconds float64 `json:"duration"`
// The client's ip:port.
RemoteAddr string `json:"remote_addr"`
// The HTTP protocol version, usually "HTTP/1.1 or HTTP/2".
Proto string `json:"proto"`
// Whether the request was received over TLS.
TLS bool `json:"tls"`
// The target hostname in the request.
Host string `json:"host"`
// The HTTP method invoked.
Method string `json:"method"`
// The unescaped request URI, including query parameters.
RequestURI string `json:"request_uri"`
// The client's user-agent
UserAgent string `json:"user_agent"`
// Where the client was before making this request.
Referer string `json:"referer"`
// The HTTP response code sent to the client.
Code int `json:"code"`
// Number of bytes sent in response body to client. If the request
// was hijacked, only includes bytes sent up to the point of
// hijacking.
Bytes int `json:"bytes"`
// Error encountered during request processing.
Err string `json:"err"`
}
AccessLogRecord is a record of one HTTP request served.
func (AccessLogRecord) String ¶ added in v0.98.0
func (m AccessLogRecord) String() string
String returns m as a JSON string.
type DebugHandler ¶ added in v1.10.0
type DebugHandler struct {
// contains filtered or unexported fields
}
DebugHandler is an http.Handler that serves a debugging "homepage", and provides helpers to register more debug endpoints and reports.
The rendered page consists of three sections: informational key/value pairs, links to other pages, and additional program-specific HTML. Callers can add to these sections using the KV, URL and Section helpers respectively.
Additionally, the Handle method offers a shorthand for correctly registering debug handlers and cross-linking them from /debug/.
func Debugger ¶ added in v1.10.0
func Debugger(mux *http.ServeMux) *DebugHandler
Debugger returns the DebugHandler registered on mux at /debug/, creating it if necessary.
func (*DebugHandler) Handle ¶ added in v1.10.0
func (d *DebugHandler) Handle(slug, desc string, handler http.Handler)
Handle registers handler at /debug/<slug> and creates a descriptive entry in /debug/ for it.
Example ¶
mux := http.NewServeMux()
dbg := Debugger(mux)
// Registers /debug/flushcache with the given handler, and adds a
// link to /debug/ with the description "Flush caches".
dbg.Handle("flushcache", "Flush caches", http.HandlerFunc(http.NotFound))
func (*DebugHandler) KV ¶ added in v1.10.0
func (d *DebugHandler) KV(k string, v interface{})
KV adds a key/value list item to /debug/.
Example ¶
mux := http.NewServeMux()
dbg := Debugger(mux)
// Adds two list items to /debug/, showing that the condition is
// red and there are 42 donuts.
dbg.KV("Condition", "red")
dbg.KV("Donuts", 42)
func (*DebugHandler) KVFunc ¶ added in v1.10.0
func (d *DebugHandler) KVFunc(k string, v func() interface{})
KVFunc adds a key/value list item to /debug/. v is called on every render of /debug/.
Example ¶
mux := http.NewServeMux()
dbg := Debugger(mux)
// Adds an count of page renders to /debug/. Note this example
// isn't concurrency-safe.
views := 0
dbg.KVFunc("Debug pageviews", func() interface{} {
views = views + 1
return views
})
dbg.KV("Donuts", 42)
func (*DebugHandler) Section ¶ added in v1.10.0
func (d *DebugHandler) Section(f func(w io.Writer, r *http.Request))
Section invokes f on every render of /debug/ to add supplemental HTML to the page body.
Example ¶
mux := http.NewServeMux()
dbg := Debugger(mux)
// Adds a section to /debug/ that dumps the HTTP request of the
// visitor.
dbg.Section(func(w io.Writer, r *http.Request) {
io.WriteString(w, "<h3>Dump of your HTTP request</h3>")
fmt.Fprintf(w, "<code>%#v</code>", r)
})
func (*DebugHandler) ServeHTTP ¶ added in v1.10.0
func (d *DebugHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements http.Handler.
func (*DebugHandler) URL ¶ added in v1.10.0
func (d *DebugHandler) URL(url, desc string)
URL adds a URL and description list item to /debug/.
Example ¶
mux := http.NewServeMux()
dbg := Debugger(mux)
// Links to the Tailscale website from /debug/.
dbg.URL("https://www.tailscale.com", "Homepage")
type HTTPError ¶ added in v0.98.0
type HTTPError struct {
Code int // HTTP response code to send to client; 0 means means 500
Msg string // Response body to send to client
Err error // Detailed error to log on the server
}
HTTPError is an error with embedded HTTP response information.
It is the error type to be (optionally) used by Handler.ServeHTTPReturn.
type HandlerOptions ¶ added in v1.2.1
type HandlerOptions struct {
Quiet200s bool // if set, do not log successfully handled HTTP requests
Logf logger.Logf
Now func() time.Time // if nil, defaults to time.Now
// If non-nil, StatusCodeCounters maintains counters
// of status codes for handled responses.
// The keys are "1xx", "2xx", "3xx", "4xx", and "5xx".
StatusCodeCounters *expvar.Map
}
type JSONHandlerFunc ¶ added in v1.2.0
JSONHandlerFunc is an HTTP ReturnHandler that writes JSON responses to the client.
Return a HTTPError to show an error message, otherwise JSONHandlerFunc will only report "internal server error" to the user with status code 500.
func (JSONHandlerFunc) ServeHTTPReturn ¶ added in v1.2.0
func (fn JSONHandlerFunc) ServeHTTPReturn(w http.ResponseWriter, r *http.Request) error
ServeHTTPReturn implements the ReturnHandler interface.
Use the following code to unmarshal the request body
body := new(DataType)
if err := json.NewDecoder(r.Body).Decode(body); err != nil {
return http.StatusBadRequest, nil, err
}
See jsonhandler_test.go for examples.
type Port80Handler ¶
Port80Handler is the handler to be given to autocert.Manager.HTTPHandler. The inner handler is the mux returned by NewMux containing registered /debug handlers.
func (Port80Handler) ServeHTTP ¶
func (h Port80Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
type PrometheusMetricsReflectRooter ¶ added in v1.14.0
type PrometheusMetricsReflectRooter interface {
expvar.Var
// PrometheusMetricsReflectRoot returns the struct or struct pointer to walk.
PrometheusMetricsReflectRoot() interface{}
}
PrometheusMetricsReflectRooter is an optional interface that expvar.Var implementations can implement to indicate that they should be walked recursively with reflect to find sets of fields to export.
type ReturnHandler ¶ added in v0.98.0
type ReturnHandler interface {
// ServeHTTPReturn is like http.Handler.ServeHTTP, except that
// it can choose to return an error instead of writing to its
// http.ResponseWriter.
//
// If ServeHTTPReturn returns an error, it caller should handle
// an error by serving an HTTP 500 response to the user. The
// error details should not be sent to the client, as they may
// contain sensitive information. If the error is an
// HTTPError, though, callers should use the HTTP response
// code and message as the response to the client.
ServeHTTPReturn(http.ResponseWriter, *http.Request) error
}
ReturnHandler is like net/http.Handler, but the handler can return an error instead of writing to its ResponseWriter.
type ReturnHandlerFunc ¶ added in v0.98.1
type ReturnHandlerFunc func(http.ResponseWriter, *http.Request) error
ReturnHandlerFunc is an adapter to allow the use of ordinary functions as ReturnHandlers. If f is a function with the appropriate signature, ReturnHandlerFunc(f) is a ReturnHandler that calls f.
func (ReturnHandlerFunc) ServeHTTPReturn ¶ added in v0.98.1
func (f ReturnHandlerFunc) ServeHTTPReturn(w http.ResponseWriter, r *http.Request) error
ServeHTTPReturn calls f(w, r).