ntfy/server/log.go

111 lines
2.9 KiB
Go
Raw Normal View History

2023-02-05 03:26:40 +01:00
package server
import (
"fmt"
"github.com/emersion/go-smtp"
2023-02-06 22:01:32 +01:00
"github.com/gorilla/websocket"
2023-02-05 03:26:40 +01:00
"golang.org/x/time/rate"
"heckel.io/ntfy/log"
"heckel.io/ntfy/util"
"net/http"
"strings"
"unicode/utf8"
)
2023-02-06 05:34:27 +01:00
// logr creates a new log event with HTTP request fields
2023-02-05 03:26:40 +01:00
func logr(r *http.Request) *log.Event {
2023-02-06 22:01:32 +01:00
return log.Fields(httpContext(r))
2023-02-05 03:26:40 +01:00
}
2023-02-06 05:34:27 +01:00
// logr creates a new log event with visitor fields
2023-02-05 03:26:40 +01:00
func logv(v *visitor) *log.Event {
2023-02-06 05:34:27 +01:00
return log.With(v)
2023-02-05 03:26:40 +01:00
}
2023-02-06 05:34:27 +01:00
// logr creates a new log event with HTTP request and visitor fields
2023-02-05 03:26:40 +01:00
func logvr(v *visitor, r *http.Request) *log.Event {
2023-02-07 18:02:25 +01:00
return logv(v).
Fields(httpContext(r)).
Fields(requestLimiterFields(v.RequestLimiter()))
2023-02-05 03:26:40 +01:00
}
2023-02-06 05:34:27 +01:00
// logvrm creates a new log event with HTTP request, visitor fields and message fields
2023-02-05 03:26:40 +01:00
func logvrm(v *visitor, r *http.Request, m *message) *log.Event {
2023-02-06 05:34:27 +01:00
return logvr(v, r).With(m)
2023-02-05 03:26:40 +01:00
}
2023-02-06 05:34:27 +01:00
// logvrm creates a new log event with visitor fields and message fields
2023-02-05 03:26:40 +01:00
func logvm(v *visitor, m *message) *log.Event {
2023-02-06 05:34:27 +01:00
return logv(v).With(m)
2023-02-05 03:26:40 +01:00
}
2023-02-06 05:34:27 +01:00
// logem creates a new log event with email fields
2023-02-05 03:26:40 +01:00
func logem(state *smtp.ConnectionState) *log.Event {
return log.
Tag(tagSMTP).
2023-02-06 05:34:27 +01:00
Fields(log.Context{
2023-02-05 03:26:40 +01:00
"smtp_hostname": state.Hostname,
"smtp_remote_addr": state.RemoteAddr.String(),
})
}
2023-02-06 22:01:32 +01:00
func httpContext(r *http.Request) log.Context {
2023-02-05 03:26:40 +01:00
requestURI := r.RequestURI
if requestURI == "" {
requestURI = r.URL.Path
}
2023-02-06 22:01:32 +01:00
return log.Context{
2023-02-05 03:26:40 +01:00
"http_method": r.Method,
"http_path": requestURI,
}
}
2023-02-06 22:01:32 +01:00
func websocketErrorContext(err error) log.Context {
if c, ok := err.(*websocket.CloseError); ok {
return log.Context{
"error": c.Error(),
"error_code": c.Code,
"error_type": "websocket.CloseError",
}
}
return log.Context{
"error": err.Error(),
}
}
2023-02-05 03:26:40 +01:00
func requestLimiterFields(limiter *rate.Limiter) map[string]any {
return map[string]any{
"visitor_request_limiter_limit": limiter.Limit(),
"visitor_request_limiter_tokens": limiter.Tokens(),
}
}
func renderHTTPRequest(r *http.Request) string {
peekLimit := 4096
lines := fmt.Sprintf("%s %s %s\n", r.Method, r.URL.RequestURI(), r.Proto)
for key, values := range r.Header {
for _, value := range values {
lines += fmt.Sprintf("%s: %s\n", key, value)
}
}
lines += "\n"
body, err := util.Peek(r.Body, peekLimit)
if err != nil {
lines = fmt.Sprintf("(could not read body: %s)\n", err.Error())
} else if utf8.Valid(body.PeekedBytes) {
lines += string(body.PeekedBytes)
if body.LimitReached {
lines += fmt.Sprintf(" ... (peeked %d bytes)", peekLimit)
}
lines += "\n"
} else {
if body.LimitReached {
lines += fmt.Sprintf("(peeked bytes not UTF-8, peek limit of %d bytes reached, hex: %x ...)\n", peekLimit, body.PeekedBytes)
} else {
lines += fmt.Sprintf("(peeked bytes not UTF-8, %d bytes, hex: %x)\n", len(body.PeekedBytes), body.PeekedBytes)
}
}
r.Body = body // Important: Reset body, so it can be re-read
return strings.TrimSpace(lines)
}