(minor) unify log keys

bittorrent/peer.go

@@ -126,7 +126,7 @@ func (p Peer) Addr() netip.Addr {
 // MarshalZerologObject writes fields into zerolog event
 func (p Peer) MarshalZerologObject(e *zerolog.Event) {
 	e.Stringer("id", p.ID).
-		Stringer("address", p.Addr()).
+		Stringer("addr", p.Addr()).
 		Uint16("port", p.Port())
 }
 

bittorrent/request.go

@@ -25,7 +25,7 @@ func (a RequestAddress) IsValid() bool {
 
 // MarshalZerologObject writes fields into zerolog event
 func (a RequestAddress) MarshalZerologObject(e *zerolog.Event) {
-	e.Stringer("address", a.Addr).Bool("provided", a.Provided)
+	e.Stringer("addr", a.Addr).Bool("provided", a.Provided)
 }
 
 // RequestAddresses is an array of RequestAddress used mainly for
@@ -168,7 +168,7 @@ func (r AnnounceRequest) MarshalZerologObject(e *zerolog.Event) {
 		Uint64("left", r.Left).
 		Uint64("downloaded", r.Downloaded).
 		Uint64("uploaded", r.Uploaded).
-		Object("peers", r.RequestPeer).
+		Object("source", r.RequestPeer).
 		Object("params", r.Params)
 }
 

cmd/mochi/server.go

@@ -27,7 +27,7 @@ type Server struct {
 // creation of a new one.
 func (r *Server) Run(cfg *Config) (err error) {
 	if len(cfg.MetricsAddr) > 0 {
-		log.Info().Str("address", cfg.MetricsAddr).Msg("starting metrics server")
+		log.Info().Str("addr", cfg.MetricsAddr).Msg("starting metrics server")
 		r.frontends = append(r.frontends, metrics.NewServer(cfg.MetricsAddr))
 	} else {
 		log.Info().Msg("metrics disabled because of empty address")

frontend/frontend.go

@@ -58,7 +58,7 @@ func NewFrontends(configs []conf.NamedMapConfig, logic *middleware.Logic) (fs []
 	buildersMU.RLock()
 	defer buildersMU.RUnlock()
 	for _, c := range configs {
-		logger.Debug().Object("frontend", c).Msg("starting frontend")
+		logger.Debug().Str("name", c.Name).Object("config", c).Msg("starting frontend")
 		newFrontend, ok := builders[c.Name]
 		if !ok {
 			err = fmt.Errorf("hook with name '%s' does not exists", c.Name)

frontend/http/frontend.go

@@ -207,6 +207,7 @@ func NewFrontend(c conf.MapConfig, logic *middleware.Logic) (frontend.Frontend,
 }
 
 func runServer(s *fasthttp.Server, cfg *Config) {
+	logger.Debug().Str("addr", cfg.Addr).Msg("starting listener")
 	ln, err := cfg.ListenTCP()
 	if err == nil {
 		if s.TLSConfig == nil {
@@ -217,9 +218,9 @@ func runServer(s *fasthttp.Server, cfg *Config) {
 	}
 	defer ln.Close()
 	if err == nil {
-		logger.Info().Msg("server stopped")
+		logger.Info().Str("addr", cfg.Addr).Msg("listener stopped")
 	} else if !errors.Is(err, http.ErrServerClosed) {
-		logger.Fatal().Err(err).Msg("server failed")
+		logger.Fatal().Str("addr", cfg.Addr).Err(err).Msg("listener failed")
 	}
 }
 

frontend/http/params.go

@@ -33,5 +33,5 @@ func (qp queryParams) InfoHashes() bittorrent.InfoHashes {
 
 // MarshalZerologObject writes fields into zerolog event
 func (qp queryParams) MarshalZerologObject(e *zerolog.Event) {
-	e.Stringer("query", qp.Args)
+	e.Str("query", str2bytes.BytesToString(qp.Args.QueryString()))
 }

frontend/udp/frontend.go

@@ -137,12 +137,15 @@ func NewFrontend(c conf.MapConfig, logic *middleware.Logic) (frontend.Frontend,
 
 	var ctx context.Context
 	ctx, f.ctxCancel = context.WithCancel(context.Background())
+	logger.Debug().Str("addr", cfg.Addr).Msg("starting listener")
 	for i := range f.sockets {
 		if f.sockets[i], err = cfg.ListenUDP(); err == nil {
 			f.wg.Add(1)
 			go func(socket *net.UDPConn, ctx context.Context) {
 				if err := f.serve(ctx, socket); err != nil {
-					logger.Fatal().Err(err).Msg("server failed")
+					logger.Fatal().Str("addr", cfg.Addr).Err(err).Msg("listener failed")
+				} else {
+					logger.Info().Str("addr", cfg.Addr).Msg("listener stopped")
 				}
 			}(f.sockets[i], ctx)
 		}

middleware/hooks.go

@@ -140,7 +140,7 @@ type fetchArgs struct {
 
 func (h *responseHook) appendPeers(ctx context.Context, req *bittorrent.AnnounceRequest, resp *bittorrent.AnnounceResponse) (err error) {
 	seeding := req.Left == 0
-	max := int(req.NumWant)
+	maxPeers := int(req.NumWant)
 	peers := make([]bittorrent.Peer, 0, len(resp.IPv4Peers)+len(resp.IPv6Peers))
 	primaryIP := req.GetFirst()
 	v6First := primaryIP.Is6()
@@ -158,24 +158,24 @@ func (h *responseHook) appendPeers(ctx context.Context, req *bittorrent.Announce
 		peers = append(peers, resp.IPv4Peers...)
 		peers = append(peers, resp.IPv6Peers...)
 	}
-	if l := len(peers); l > max {
+	if l := len(peers); l > maxPeers {
-		peers, max = peers[:max], 0
+		peers, maxPeers = peers[:maxPeers], 0
 	} else {
-		max -= l
+		maxPeers -= l
 	}
 
 	for _, a := range args {
-		if max <= 0 {
+		if maxPeers <= 0 {
 			break
 		}
 		var storePeers []bittorrent.Peer
-		storePeers, err = h.store.AnnouncePeers(ctx, a.ih, seeding, max, a.v6)
+		storePeers, err = h.store.AnnouncePeers(ctx, a.ih, seeding, maxPeers, a.v6)
 		if err != nil && !errors.Is(err, storage.ErrResourceDoesNotExist) {
 			return err
 		}
 		err = nil
 		peers = append(peers, storePeers...)
-		max -= len(storePeers)
+		maxPeers -= len(storePeers)
 	}
 
 	// Some clients expect a minimum of their own peer representation returned to

middleware/jwt/jwt.go

@@ -82,6 +82,7 @@ func build(config conf.MapConfig, _ storage.PeerStorage) (h middleware.Hook, err
 			cfg.Header = authorizationHeader
 			logger.Warn().
 				Str("name", "Header").
+				Str("provided", "").
 				Str("default", cfg.Header).
 				Msg("falling back to default configuration")
 		}
@@ -149,7 +150,7 @@ func (h *hook) HandleAnnounce(ctx context.Context, req *bittorrent.AnnounceReque
 				logger.Info().
 					Stringer("claimInfoHash", claimIH).
 					Stringer("requestInfoHash", req.InfoHash).
-					Object("peer", req.RequestPeer).
+					Object("source", req.RequestPeer).
 					Msg("unequal 'infohash' claim when validating JWT")
 				err = ErrInvalidJWT
 			}
@@ -220,7 +221,7 @@ func (h *hook) HandleScrape(ctx context.Context, req *bittorrent.ScrapeRequest,
 		} else {
 			logger.Info().
 				Err(jwtErr).
-				Array("source", &req.RequestAddresses).
+				Array("addresses", &req.RequestAddresses).
 				Msg("JWT validation failed")
 			err = ErrInvalidJWT
 		}

middleware/middleware.go

@@ -48,7 +48,7 @@ func NewHooks(configs []conf.NamedMapConfig, storage storage.PeerStorage) (hooks
 	buildersMU.RLock()
 	defer buildersMU.RUnlock()
 	for _, c := range configs {
-		logger.Debug().Object("hook", c).Msg("starting hook")
+		logger.Debug().Str("name", c.Name).Object("hook", c).Msg("starting hook")
 		newHook, ok := builders[c.Name]
 		if !ok {
 			err = fmt.Errorf("hook with name '%s' does not exists", c.Name)

storage/storage.go

@@ -236,7 +236,7 @@ func RegisterDriver(name string, d Driver) {
 func NewStorage(cfg conf.NamedMapConfig) (ps PeerStorage, err error) {
 	driversMU.RLock()
 	defer driversMU.RUnlock()
-	logger.Debug().Object("cfg", cfg).Msg("staring storage")
+	logger.Debug().Object("config", cfg).Msg("staring storage")
 
 	var b Driver
 	b, ok := drivers[cfg.Name]