tailscale/tsweb/log.go
David Anderson 98eceae55e tsweb: add a Handler type.
Handler is like http.Handler, but returns errors. ErrHandler
converts back to an http.Handler, with added error handling
and logging.

Signed-off-by: David Anderson <dave@natulte.net>
2020-03-17 21:34:44 -07:00

62 lines
1.7 KiB
Go

// Copyright (c) 2020 Tailscale Inc & AUTHORS All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package tsweb
import (
"encoding/json"
"fmt"
"strings"
"time"
)
// Msg is a structured event log entry.
type Msg struct {
Where string `json:"where"`
When time.Time `json:"when"`
Duration time.Duration `json:"duration,omitempty"`
Domain string `json:"domain,omitempty"`
Msg string `json:"msg,omitempty"`
Err error `json:"err,omitempty"`
HTTP *MsgHTTP `json:"http,omitempty"`
Data interface{} `json:"data,omitempty"`
}
// MsgHTTP contains information about the processing of one HTTP
// request.
type MsgHTTP struct {
Code int `json:"code"`
Path string `json:"path"`
RemoteAddr string `json:"remote_addr"`
UserAgent string `json:"user_agent"`
Referer string `json:"referer"`
}
// String returns m as a JSON string.
func (m Msg) String() string {
if m.When.IsZero() {
m.When = time.Now()
}
var buf strings.Builder
json.NewEncoder(&buf).Encode(m)
return strings.TrimRight(buf.String(), "\n")
}
// HTTPError is an error with embedded HTTP response information. When
// received by an ErrHandler, the Code and Msg are sent to the client,
// while Err is logged on the server.
type HTTPError struct {
Code int
Msg string // sent to the end-user
Err error
}
// Error implements the error interface.
func (e HTTPError) Error() string { return fmt.Sprintf("httperror{%d, %q, %v}", e.Code, e.Msg, e.Err) }
// Error returns an HTTPError containing the given information.
func Error(code int, msg string, err error) HTTPError {
return HTTPError{Code: code, Msg: msg, Err: err}
}