From dab608292a5cada2bccab521d0f7d9b77a461db6 Mon Sep 17 00:00:00 2001 From: Stanislav Chzhen Date: Fri, 6 Dec 2024 16:01:58 +0300 Subject: [PATCH] Pull request 2314: AGDNS-2374-slog-home-webapi Squashed commit of the following: commit 7c457d92b5a2d931c22388d37ad30f10dc0ecd89 Merge: bcd3d29df 11dfc7a3e Author: Stanislav Chzhen Date: Thu Dec 5 18:24:08 2024 +0300 Merge branch 'master' into AGDNS-2374-slog-home-webapi commit bcd3d29dfde4af7d223e2d2468dd01635f799bb9 Author: Stanislav Chzhen Date: Thu Dec 5 18:24:01 2024 +0300 all: imp code commit f3af1bf3dd476733d0286eeea9f6dd5ebbdb4950 Author: Stanislav Chzhen Date: Wed Dec 4 18:33:35 2024 +0300 home: imp code commit 035477513f433346c7bf3215083c317466b4b734 Author: Stanislav Chzhen Date: Tue Dec 3 19:01:55 2024 +0300 home: imp code commit 5368d8de50d266b438a4909d81b5fec76b5ca65c Author: Stanislav Chzhen Date: Tue Dec 3 17:25:37 2024 +0300 home: imp code commit fce1bf475f33f6fe45252e2276ea8ebf2a82a8b2 Author: Stanislav Chzhen Date: Mon Dec 2 18:20:31 2024 +0300 home: slog webapi --- internal/home/controlinstall.go | 87 ++++++++++++++----------- internal/home/controlupdate.go | 42 +++++++----- internal/home/dns.go | 2 +- internal/home/home.go | 34 +++++----- internal/home/options.go | 3 +- internal/home/web.go | 111 +++++++++++++++++++++----------- scripts/translations/main.go | 5 +- 7 files changed, 175 insertions(+), 109 deletions(-) diff --git a/internal/home/controlinstall.go b/internal/home/controlinstall.go index 3051f0f6..9d7a96a0 100644 --- a/internal/home/controlinstall.go +++ b/internal/home/controlinstall.go @@ -5,6 +5,7 @@ import ( "encoding/json" "fmt" "io" + "log/slog" "net/http" "net/netip" "os" @@ -19,7 +20,7 @@ import ( "github.com/AdguardTeam/AdGuardHome/internal/aghnet" "github.com/AdguardTeam/AdGuardHome/internal/version" "github.com/AdguardTeam/golibs/errors" - "github.com/AdguardTeam/golibs/log" + "github.com/AdguardTeam/golibs/logutil/slogutil" "github.com/quic-go/quic-go/http3" ) @@ -124,6 +125,8 @@ func (req *checkConfReq) validateWeb(tcpPorts aghalg.UniqChecker[tcpPort]) (err // be set. canAutofix is true if the port can be unbound by AdGuard Home // automatically. func (req *checkConfReq) validateDNS( + ctx context.Context, + l *slog.Logger, tcpPorts aghalg.UniqChecker[tcpPort], ) (canAutofix bool, err error) { defer func() { err = errors.Annotate(err, "validating ports: %w") }() @@ -154,10 +157,10 @@ func (req *checkConfReq) validateDNS( } // Try to fix automatically. - canAutofix = checkDNSStubListener() + canAutofix = checkDNSStubListener(ctx, l) if canAutofix && req.DNS.Autofix { - if derr := disableDNSStubListener(); derr != nil { - log.Error("disabling DNSStubListener: %s", err) + if derr := disableDNSStubListener(ctx, l); derr != nil { + l.ErrorContext(ctx, "disabling DNSStubListener", slogutil.KeyError, err) } err = aghnet.CheckPort("udp", netip.AddrPortFrom(req.DNS.IP, port)) @@ -184,7 +187,7 @@ func (web *webAPI) handleInstallCheckConfig(w http.ResponseWriter, r *http.Reque resp.Web.Status = err.Error() } - if resp.DNS.CanAutofix, err = req.validateDNS(tcpPorts); err != nil { + if resp.DNS.CanAutofix, err = req.validateDNS(r.Context(), web.logger, tcpPorts); err != nil { resp.DNS.Status = err.Error() } else if !req.DNS.IP.IsUnspecified() { resp.StaticIP = handleStaticIP(req.DNS.IP, req.SetStaticIP) @@ -233,27 +236,39 @@ func handleStaticIP(ip netip.Addr, set bool) staticIPJSON { return resp } -// Check if DNSStubListener is active -func checkDNSStubListener() bool { +// checkDNSStubListener returns true if DNSStubListener is active. +func checkDNSStubListener(ctx context.Context, l *slog.Logger) (ok bool) { if runtime.GOOS != "linux" { return false } cmd := exec.Command("systemctl", "is-enabled", "systemd-resolved") - log.Tracef("executing %s %v", cmd.Path, cmd.Args) + l.DebugContext(ctx, "executing", "cmd", cmd.Path, "args", cmd.Args) _, err := cmd.Output() if err != nil || cmd.ProcessState.ExitCode() != 0 { - log.Info("command %s has failed: %v code:%d", - cmd.Path, err, cmd.ProcessState.ExitCode()) + l.InfoContext( + ctx, + "execution failed", + "cmd", cmd.Path, + "code", cmd.ProcessState.ExitCode(), + slogutil.KeyError, err, + ) + return false } cmd = exec.Command("grep", "-E", "#?DNSStubListener=yes", "/etc/systemd/resolved.conf") - log.Tracef("executing %s %v", cmd.Path, cmd.Args) + l.DebugContext(ctx, "executing", "cmd", cmd.Path, "args", cmd.Args) _, err = cmd.Output() if err != nil || cmd.ProcessState.ExitCode() != 0 { - log.Info("command %s has failed: %v code:%d", - cmd.Path, err, cmd.ProcessState.ExitCode()) + l.InfoContext( + ctx, + "execution failed", + "cmd", cmd.Path, + "code", cmd.ProcessState.ExitCode(), + slogutil.KeyError, err, + ) + return false } @@ -269,8 +284,9 @@ DNSStubListener=no ) const resolvConfPath = "/etc/resolv.conf" -// Deactivate DNSStubListener -func disableDNSStubListener() (err error) { +// disableDNSStubListener deactivates DNSStubListerner and returns an error, if +// any. +func disableDNSStubListener(ctx context.Context, l *slog.Logger) (err error) { dir := filepath.Dir(resolvedConfPath) err = os.MkdirAll(dir, 0o755) if err != nil { @@ -290,7 +306,7 @@ func disableDNSStubListener() (err error) { } cmd := exec.Command("systemctl", "reload-or-restart", "systemd-resolved") - log.Tracef("executing %s %v", cmd.Path, cmd.Args) + l.DebugContext(ctx, "executing", "cmd", cmd.Path, "args", cmd.Args) _, err = cmd.Output() if err != nil { return err @@ -327,9 +343,9 @@ func copyInstallSettings(dst, src *configuration) { // shutdownTimeout is the timeout for shutting HTTP server down operation. const shutdownTimeout = 5 * time.Second -// shutdownSrv shuts srv down and prints error messages to the log. -func shutdownSrv(ctx context.Context, srv *http.Server) { - defer log.OnPanic("") +// shutdownSrv shuts down srv and logs the error, if any. l must not be nil. +func shutdownSrv(ctx context.Context, l *slog.Logger, srv *http.Server) { + defer slogutil.RecoverAndLog(ctx, l) if srv == nil { return @@ -340,19 +356,19 @@ func shutdownSrv(ctx context.Context, srv *http.Server) { return } - const msgFmt = "shutting down http server %q: %s" - if errors.Is(err, context.Canceled) { - log.Debug(msgFmt, srv.Addr, err) - } else { - log.Error(msgFmt, srv.Addr, err) + lvl := slog.LevelDebug + if !errors.Is(err, context.Canceled) { + lvl = slog.LevelError } + + l.Log(ctx, lvl, "shutting down http server", "addr", srv.Addr, slogutil.KeyError, err) } -// shutdownSrv3 shuts srv down and prints error messages to the log. +// shutdownSrv3 shuts down srv and logs the error, if any. l must not be nil. // // TODO(a.garipov): Think of a good way to merge with [shutdownSrv]. -func shutdownSrv3(srv *http3.Server) { - defer log.OnPanic("") +func shutdownSrv3(ctx context.Context, l *slog.Logger, srv *http3.Server) { + defer slogutil.RecoverAndLog(ctx, l) if srv == nil { return @@ -363,12 +379,12 @@ func shutdownSrv3(srv *http3.Server) { return } - const msgFmt = "shutting down http/3 server %q: %s" - if errors.Is(err, context.Canceled) { - log.Debug(msgFmt, srv.Addr, err) - } else { - log.Error(msgFmt, srv.Addr, err) + lvl := slog.LevelDebug + if !errors.Is(err, context.Canceled) { + lvl = slog.LevelError } + + l.Log(ctx, lvl, "shutting down http/3 server", "addr", srv.Addr, slogutil.KeyError, err) } // PasswordMinRunes is the minimum length of user's password in runes. @@ -436,7 +452,7 @@ func (web *webAPI) handleInstallConfigure(w http.ResponseWriter, r *http.Request // moment we'll allow setting up TLS in the initial configuration or the // configuration itself will use HTTPS protocol, because the underlying // functions potentially restart the HTTPS server. - err = startMods(web.logger) + err = startMods(web.baseLogger) if err != nil { Context.firstRun = true copyInstallSettings(config, curConfig) @@ -472,12 +488,11 @@ func (web *webAPI) handleInstallConfigure(w http.ResponseWriter, r *http.Request // and with its own context, because it waits until all requests are handled // and will be blocked by it's own caller. go func(timeout time.Duration) { - defer log.OnPanic("web") - ctx, cancel := context.WithTimeout(context.Background(), timeout) + defer slogutil.RecoverAndLog(ctx, web.logger) defer cancel() - shutdownSrv(ctx, web.httpServer) + shutdownSrv(ctx, web.logger, web.httpServer) }(shutdownTimeout) } diff --git a/internal/home/controlupdate.go b/internal/home/controlupdate.go index aeab8810..bdecc4e9 100644 --- a/internal/home/controlupdate.go +++ b/internal/home/controlupdate.go @@ -4,6 +4,7 @@ import ( "context" "encoding/json" "fmt" + "log/slog" "net/http" "os" "os/exec" @@ -16,7 +17,8 @@ import ( "github.com/AdguardTeam/AdGuardHome/internal/aghnet" "github.com/AdguardTeam/AdGuardHome/internal/updater" "github.com/AdguardTeam/golibs/errors" - "github.com/AdguardTeam/golibs/log" + "github.com/AdguardTeam/golibs/logutil/slogutil" + "github.com/AdguardTeam/golibs/osutil" ) // temporaryError is the interface for temporary errors from the Go standard @@ -52,7 +54,7 @@ func (web *webAPI) handleVersionJSON(w http.ResponseWriter, r *http.Request) { } } - err = web.requestVersionInfo(resp, req.Recheck) + err = web.requestVersionInfo(r.Context(), resp, req.Recheck) if err != nil { // Don't wrap the error, because it's informative enough as is. aghhttp.Error(r, w, http.StatusBadGateway, "%s", err) @@ -73,7 +75,11 @@ func (web *webAPI) handleVersionJSON(w http.ResponseWriter, r *http.Request) { // requestVersionInfo sets the VersionInfo field of resp if it can reach the // update server. -func (web *webAPI) requestVersionInfo(resp *versionResponse, recheck bool) (err error) { +func (web *webAPI) requestVersionInfo( + ctx context.Context, + resp *versionResponse, + recheck bool, +) (err error) { updater := web.conf.updater for range 3 { resp.VersionInfo, err = updater.VersionInfo(recheck) @@ -89,7 +95,9 @@ func (web *webAPI) requestVersionInfo(resp *versionResponse, recheck bool) (err // See https://github.com/AdguardTeam/AdGuardHome/issues/934. const sleepTime = 2 * time.Second - log.Info("update: temp net error: %v; sleeping for %s and retrying", err, sleepTime) + err = fmt.Errorf("temp net error: %w; sleeping for %s and retrying", err, sleepTime) + web.logger.InfoContext(ctx, "updating version info", slogutil.KeyError, err) + time.Sleep(sleepTime) continue @@ -140,7 +148,7 @@ func (web *webAPI) handleUpdate(w http.ResponseWriter, r *http.Request) { // The background context is used because the underlying functions wrap it // with timeout and shut down the server, which handles current request. It // also should be done in a separate goroutine for the same reason. - go finishUpdate(context.Background(), execPath, web.conf.runningAsService) + go finishUpdate(context.Background(), web.logger, execPath, web.conf.runningAsService) } // versionResponse is the response for /control/version.json endpoint. @@ -180,15 +188,17 @@ func tlsConfUsesPrivilegedPorts(c *tlsConfigSettings) (ok bool) { return c.Enabled && (c.PortHTTPS < 1024 || c.PortDNSOverTLS < 1024 || c.PortDNSOverQUIC < 1024) } -// finishUpdate completes an update procedure. -func finishUpdate(ctx context.Context, execPath string, runningAsService bool) { - var err error +// finishUpdate completes an update procedure. It is intended to be used as a +// goroutine. +func finishUpdate(ctx context.Context, l *slog.Logger, execPath string, runningAsService bool) { + defer slogutil.RecoverAndExit(ctx, l, osutil.ExitCodeFailure) - log.Info("stopping all tasks") + l.InfoContext(ctx, "stopping all tasks") cleanup(ctx) cleanupAlways() + var err error if runtime.GOOS == "windows" { if runningAsService { // NOTE: We can't restart the service via "kardianos/service" @@ -199,28 +209,28 @@ func finishUpdate(ctx context.Context, execPath string, runningAsService bool) { cmd := exec.Command("cmd", "/c", "net stop AdGuardHome & net start AdGuardHome") err = cmd.Start() if err != nil { - log.Fatalf("restarting: stopping: %s", err) + panic(fmt.Errorf("restarting service: %w", err)) } - os.Exit(0) + os.Exit(osutil.ExitCodeSuccess) } cmd := exec.Command(execPath, os.Args[1:]...) - log.Info("restarting: %q %q", execPath, os.Args[1:]) + l.InfoContext(ctx, "restarting", "exec_path", execPath, "args", os.Args[1:]) cmd.Stdin = os.Stdin cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr err = cmd.Start() if err != nil { - log.Fatalf("restarting:: %s", err) + panic(fmt.Errorf("restarting: %w", err)) } - os.Exit(0) + os.Exit(osutil.ExitCodeSuccess) } - log.Info("restarting: %q %q", execPath, os.Args[1:]) + l.InfoContext(ctx, "restarting", "exec_path", execPath, "args", os.Args[1:]) err = syscall.Exec(execPath, os.Args, os.Environ()) if err != nil { - log.Fatalf("restarting: %s", err) + panic(fmt.Errorf("restarting: %w", err)) } } diff --git a/internal/home/dns.go b/internal/home/dns.go index 5b07e795..1c1fb202 100644 --- a/internal/home/dns.go +++ b/internal/home/dns.go @@ -47,7 +47,7 @@ func onConfigModified() { // initDNS updates all the fields of the [Context] needed to initialize the DNS // server and initializes it at last. It also must not be called unless -// [config] and [Context] are initialized. l must not be nil. +// [config] and [Context] are initialized. baseLogger must not be nil. func initDNS(baseLogger *slog.Logger, statsDir, querylogDir string) (err error) { anonymizer := config.anonymizer() diff --git a/internal/home/home.go b/internal/home/home.go index 8ac6ae22..750916a3 100644 --- a/internal/home/home.go +++ b/internal/home/home.go @@ -167,13 +167,13 @@ func setupContext(opts options) (err error) { if err != nil { log.Error("parsing configuration file: %s", err) - os.Exit(1) + os.Exit(osutil.ExitCodeFailure) } if opts.checkConfig { log.Info("configuration file is ok") - os.Exit(0) + os.Exit(osutil.ExitCodeSuccess) } return nil @@ -522,18 +522,20 @@ func isUpdateEnabled(ctx context.Context, l *slog.Logger, opts *options, customU } } -// initWeb initializes the web module. +// initWeb initializes the web module. upd and baseLogger must not be nil. func initWeb( ctx context.Context, opts options, clientBuildFS fs.FS, upd *updater.Updater, - l *slog.Logger, + baseLogger *slog.Logger, customURL bool, ) (web *webAPI, err error) { + logger := baseLogger.With(slogutil.KeyPrefix, "webapi") + var clientFS fs.FS if opts.localFrontend { - log.Info("warning: using local frontend files") + logger.WarnContext(ctx, "using local frontend files") clientFS = os.DirFS("build/static") } else { @@ -543,10 +545,12 @@ func initWeb( } } - disableUpdate := !isUpdateEnabled(ctx, l, &opts, customURL) + disableUpdate := !isUpdateEnabled(ctx, baseLogger, &opts, customURL) webConf := &webConfig{ - updater: upd, + updater: upd, + logger: logger, + baseLogger: baseLogger, clientFS: clientFS, @@ -562,7 +566,7 @@ func initWeb( serveHTTP3: config.DNS.ServeHTTP3, } - web = newWebAPI(webConf, l) + web = newWebAPI(ctx, webConf) if web == nil { return nil, errors.Error("can not initialize web") } @@ -640,7 +644,7 @@ func run(opts options, clientBuildFS fs.FS, done chan struct{}) { fatalOnError(err) if config.HTTPConfig.Pprof.Enabled { - startPprof(config.HTTPConfig.Pprof.Port) + startPprof(slogLogger, config.HTTPConfig.Pprof.Port) } } @@ -692,7 +696,7 @@ func run(opts options, clientBuildFS fs.FS, done chan struct{}) { checkPermissions(ctx, slogLogger, Context.workDir, confPath, dataDir, statsDir, querylogDir) } - Context.web.start() + Context.web.start(ctx) // Wait for other goroutines to complete their job. <-done @@ -803,15 +807,15 @@ func (c *configuration) anonymizer() (ipmut *aghnet.IPMut) { return aghnet.NewIPMut(anonFunc) } -// startMods initializes and starts the DNS server after installation. l must -// not be nil. -func startMods(l *slog.Logger) (err error) { +// startMods initializes and starts the DNS server after installation. +// baseLogger must not be nil. +func startMods(baseLogger *slog.Logger) (err error) { statsDir, querylogDir, err := checkStatsAndQuerylogDirs(&Context, config) if err != nil { return err } - err = initDNS(l, statsDir, querylogDir) + err = initDNS(baseLogger, statsDir, querylogDir) if err != nil { return err } @@ -984,7 +988,7 @@ func loadCmdLineOpts() (opts options) { exitWithError() } - os.Exit(0) + os.Exit(osutil.ExitCodeSuccess) } return opts diff --git a/internal/home/options.go b/internal/home/options.go index dd7e53e4..e0750e3e 100644 --- a/internal/home/options.go +++ b/internal/home/options.go @@ -10,6 +10,7 @@ import ( "github.com/AdguardTeam/AdGuardHome/internal/configmigrate" "github.com/AdguardTeam/AdGuardHome/internal/version" "github.com/AdguardTeam/golibs/log" + "github.com/AdguardTeam/golibs/osutil" "github.com/AdguardTeam/golibs/stringutil" ) @@ -329,7 +330,7 @@ var cmdLineOpts = []cmdLineOpt{{ fmt.Println(version.Full()) } - os.Exit(0) + os.Exit(osutil.ExitCodeSuccess) return nil }, nil diff --git a/internal/home/web.go b/internal/home/web.go index 1909720b..0ea0272b 100644 --- a/internal/home/web.go +++ b/internal/home/web.go @@ -3,6 +3,7 @@ package home import ( "context" "crypto/tls" + "fmt" "io/fs" "log/slog" "net/http" @@ -15,9 +16,11 @@ import ( "github.com/AdguardTeam/AdGuardHome/internal/updater" "github.com/AdguardTeam/golibs/errors" "github.com/AdguardTeam/golibs/log" + "github.com/AdguardTeam/golibs/logutil/slogutil" "github.com/AdguardTeam/golibs/netutil" "github.com/AdguardTeam/golibs/netutil/httputil" "github.com/AdguardTeam/golibs/netutil/urlutil" + "github.com/AdguardTeam/golibs/osutil" "github.com/NYTimes/gziphandler" "github.com/quic-go/quic-go/http3" "golang.org/x/net/http2" @@ -39,6 +42,13 @@ const ( type webConfig struct { updater *updater.Updater + // logger is a slog logger used in webAPI. It must not be nil. + logger *slog.Logger + + // baseLogger is used to create loggers for other entities. It must not be + // nil. + baseLogger *slog.Logger + clientFS fs.FS // BindAddr is the binding address with port for plain HTTP web interface. @@ -94,21 +104,26 @@ type webAPI struct { // logger is a slog logger used in webAPI. It must not be nil. logger *slog.Logger + // baseLogger is used to create loggers for other entities. It must not be + // nil. + baseLogger *slog.Logger + // httpsServer is the server that handles HTTPS traffic. If it is not nil, // [Web.http3Server] must also not be nil. httpsServer httpsServer } -// newWebAPI creates a new instance of the web UI and API server. l must not be -// nil. +// newWebAPI creates a new instance of the web UI and API server. conf must be +// valid. // // TODO(a.garipov): Return a proper error. -func newWebAPI(conf *webConfig, l *slog.Logger) (w *webAPI) { - log.Info("web: initializing") +func newWebAPI(ctx context.Context, conf *webConfig) (w *webAPI) { + conf.logger.InfoContext(ctx, "initializing") w = &webAPI{ - conf: conf, - logger: l, + conf: conf, + logger: conf.logger, + baseLogger: conf.baseLogger, } clientFS := http.FileServer(http.FS(conf.clientFS)) @@ -118,7 +133,11 @@ func newWebAPI(conf *webConfig, l *slog.Logger) (w *webAPI) { // add handlers for /install paths, we only need them when we're not configured yet if conf.firstRun { - log.Info("This is the first launch of AdGuard Home, redirecting everything to /install.html ") + conf.logger.InfoContext( + ctx, + "This is the first launch of AdGuard Home, redirecting everything to /install.html", + ) + Context.mux.Handle("/install.html", preInstallHandler(clientFS)) w.registerInstallHandlers() } else { @@ -154,7 +173,9 @@ func webCheckPortAvailable(port uint16) (ok bool) { // tlsConfigChanged updates the TLS configuration and restarts the HTTPS server // if necessary. func (web *webAPI) tlsConfigChanged(ctx context.Context, tlsConf tlsConfigSettings) { - log.Debug("web: applying new tls configuration") + defer slogutil.RecoverAndExit(ctx, web.logger, osutil.ExitCodeFailure) + + web.logger.DebugContext(ctx, "applying new tls configuration") enabled := tlsConf.Enabled && tlsConf.PortHTTPS != 0 && @@ -165,7 +186,7 @@ func (web *webAPI) tlsConfigChanged(ctx context.Context, tlsConf tlsConfigSettin if enabled { cert, err = tls.X509KeyPair(tlsConf.CertificateChainData, tlsConf.PrivateKeyData) if err != nil { - log.Fatal(err) + panic(err) } } @@ -173,8 +194,8 @@ func (web *webAPI) tlsConfigChanged(ctx context.Context, tlsConf tlsConfigSettin if web.httpsServer.server != nil { var cancel context.CancelFunc ctx, cancel = context.WithTimeout(ctx, shutdownTimeout) - shutdownSrv(ctx, web.httpsServer.server) - shutdownSrv3(web.httpsServer.server3) + shutdownSrv(ctx, web.logger, web.httpsServer.server) + shutdownSrv3(ctx, web.logger, web.httpsServer.server3) cancel() } @@ -185,12 +206,17 @@ func (web *webAPI) tlsConfigChanged(ctx context.Context, tlsConf tlsConfigSettin web.httpsServer.cond.L.Unlock() } +// loggerKeyServer is the key used by [webAPI] to identify servers. +const loggerKeyServer = "server" + // start - start serving HTTP requests -func (web *webAPI) start() { - log.Println("AdGuard Home is available at the following addresses:") +func (web *webAPI) start(ctx context.Context) { + defer slogutil.RecoverAndExit(ctx, web.logger, osutil.ExitCodeFailure) + + web.logger.InfoContext(ctx, "AdGuard Home is available at the following addresses:") // for https, we have a separate goroutine loop - go web.tlsServerLoop() + go web.tlsServerLoop(ctx) // this loop is used as an ability to change listening host and/or port for !web.httpsServer.inShutdown { @@ -200,17 +226,19 @@ func (web *webAPI) start() { // Use an h2c handler to support unencrypted HTTP/2, e.g. for proxies. hdlr := h2c.NewHandler(withMiddlewares(Context.mux, limitRequestBody), &http2.Server{}) + logger := web.baseLogger.With(loggerKeyServer, "plain") + // Create a new instance, because the Web is not usable after Shutdown. web.httpServer = &http.Server{ - ErrorLog: log.StdLog("web: plain", log.DEBUG), Addr: web.conf.BindAddr.String(), Handler: hdlr, ReadTimeout: web.conf.ReadTimeout, ReadHeaderTimeout: web.conf.ReadHeaderTimeout, WriteTimeout: web.conf.WriteTimeout, + ErrorLog: slog.NewLogLogger(logger.Handler(), slog.LevelError), } go func() { - defer log.OnPanic("web: plain") + defer slogutil.RecoverAndLog(ctx, web.logger) errs <- web.httpServer.ListenAndServe() }() @@ -218,7 +246,7 @@ func (web *webAPI) start() { err := <-errs if !errors.Is(err, http.ErrServerClosed) { cleanupAlways() - log.Fatal(err) + panic(err) } // We use ErrServerClosed as a sign that we need to rebind on a new @@ -228,7 +256,7 @@ func (web *webAPI) start() { // close gracefully shuts down the HTTP servers. func (web *webAPI) close(ctx context.Context) { - log.Info("stopping http server...") + web.logger.InfoContext(ctx, "stopping http server") web.httpsServer.cond.L.Lock() web.httpsServer.inShutdown = true @@ -238,14 +266,16 @@ func (web *webAPI) close(ctx context.Context) { ctx, cancel = context.WithTimeout(ctx, shutdownTimeout) defer cancel() - shutdownSrv(ctx, web.httpsServer.server) - shutdownSrv3(web.httpsServer.server3) - shutdownSrv(ctx, web.httpServer) + shutdownSrv(ctx, web.logger, web.httpsServer.server) + shutdownSrv3(ctx, web.logger, web.httpsServer.server3) + shutdownSrv(ctx, web.logger, web.httpServer) - log.Info("stopped http server") + web.logger.InfoContext(ctx, "stopped http server") } -func (web *webAPI) tlsServerLoop() { +func (web *webAPI) tlsServerLoop(ctx context.Context) { + defer slogutil.RecoverAndExit(ctx, web.logger, osutil.ExitCodeFailure) + for { web.httpsServer.cond.L.Lock() if web.httpsServer.inShutdown { @@ -273,38 +303,40 @@ func (web *webAPI) tlsServerLoop() { }() addr := netip.AddrPortFrom(web.conf.BindAddr.Addr(), portHTTPS).String() + logger := web.baseLogger.With(loggerKeyServer, "https") + web.httpsServer.server = &http.Server{ - ErrorLog: log.StdLog("web: https", log.DEBUG), - Addr: addr, + Addr: addr, + Handler: withMiddlewares(Context.mux, limitRequestBody), TLSConfig: &tls.Config{ Certificates: []tls.Certificate{web.httpsServer.cert}, RootCAs: Context.tlsRoots, CipherSuites: Context.tlsCipherIDs, MinVersion: tls.VersionTLS12, }, - Handler: withMiddlewares(Context.mux, limitRequestBody), ReadTimeout: web.conf.ReadTimeout, ReadHeaderTimeout: web.conf.ReadHeaderTimeout, WriteTimeout: web.conf.WriteTimeout, + ErrorLog: slog.NewLogLogger(logger.Handler(), slog.LevelError), } printHTTPAddresses(urlutil.SchemeHTTPS) if web.conf.serveHTTP3 { - go web.mustStartHTTP3(addr) + go web.mustStartHTTP3(ctx, addr) } - log.Debug("web: starting https server") + web.logger.DebugContext(ctx, "starting https server") err := web.httpsServer.server.ListenAndServeTLS("", "") if !errors.Is(err, http.ErrServerClosed) { cleanupAlways() - log.Fatalf("web: https: %s", err) + panic(fmt.Errorf("https: %w", err)) } } } -func (web *webAPI) mustStartHTTP3(address string) { - defer log.OnPanic("web: http3") +func (web *webAPI) mustStartHTTP3(ctx context.Context, address string) { + defer slogutil.RecoverAndExit(ctx, web.logger, osutil.ExitCodeFailure) web.httpsServer.server3 = &http3.Server{ // TODO(a.garipov): See if there is a way to use the error log as @@ -319,16 +351,16 @@ func (web *webAPI) mustStartHTTP3(address string) { Handler: withMiddlewares(Context.mux, limitRequestBody), } - log.Debug("web: starting http/3 server") + web.logger.DebugContext(ctx, "starting http/3 server") err := web.httpsServer.server3.ListenAndServe() if !errors.Is(err, http.ErrServerClosed) { cleanupAlways() - log.Fatalf("web: http3: %s", err) + panic(fmt.Errorf("http3: %w", err)) } } // startPprof launches the debug and profiling server on the provided port. -func startPprof(port uint16) { +func startPprof(baseLogger *slog.Logger, port uint16) { addr := netip.AddrPortFrom(netutil.IPv4Localhost(), port) runtime.SetBlockProfileRate(1) @@ -337,13 +369,16 @@ func startPprof(port uint16) { mux := http.NewServeMux() httputil.RoutePprof(mux) - go func() { - defer log.OnPanic("pprof server") + ctx := context.Background() + logger := baseLogger.With(slogutil.KeyPrefix, "pprof") - log.Info("pprof: listening on %q", addr) + go func() { + defer slogutil.RecoverAndLog(ctx, logger) + + logger.InfoContext(ctx, "listening", "addr", addr) err := http.ListenAndServe(addr.String(), mux) if !errors.Is(err, http.ErrServerClosed) { - log.Error("pprof: shutting down: %s", err) + logger.ErrorContext(ctx, "shutting down", slogutil.KeyError, err) } }() } diff --git a/scripts/translations/main.go b/scripts/translations/main.go index c1f6a3cc..e8dc0473 100644 --- a/scripts/translations/main.go +++ b/scripts/translations/main.go @@ -22,6 +22,7 @@ import ( "github.com/AdguardTeam/AdGuardHome/internal/aghos" "github.com/AdguardTeam/golibs/errors" "github.com/AdguardTeam/golibs/logutil/slogutil" + "github.com/AdguardTeam/golibs/osutil" ) const ( @@ -124,12 +125,12 @@ Commands: if addStr != "" { fmt.Printf("%s\n%s\n", addStr, usageStr) - os.Exit(1) + os.Exit(osutil.ExitCodeFailure) } fmt.Println(usageStr) - os.Exit(0) + os.Exit(osutil.ExitCodeSuccess) } // twoskyConfig is the configuration structure for localization.