mirror of
https://github.com/netbirdio/netbird.git
synced 2026-07-16 19:49:56 +00:00
ff6aef5e2a
When the daemon is set to debug/trace, the GUI now automatically writes a rotated gui-client.log in the user's config dir and the daemon's debug bundle collects it. The UI learns the level both at startup (daemon already in debug) and live, by piggybacking the existing SubscribeEvents stream: the daemon publishes a marked log-level-changed SystemEvent (and a per-subscription snapshot), which DaemonFeed routes to guilog.DebugLog instead of an OS toast. The UI registers its log path via a new RegisterUILog RPC so the root daemon, which can't resolve the user's config dir, knows where to find the file. Manual --log-file (any value) disables the daemon-driven file logging. Fix: client/ui SetLogLevel looked up proto.LogLevel_value with the lowercase logrus name, which never matched the uppercase enum keys and silently fell back to INFO — so trace/debug requests from the bundle flow had no effect.
127 lines
4.6 KiB
Go
127 lines
4.6 KiB
Go
package debug
|
|
|
|
import (
|
|
"archive/zip"
|
|
"bytes"
|
|
"compress/gzip"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// TestAddRotatedLogFiles_PicksUpAllVariants asserts that the rotated-log
|
|
// glob picks up logs rotated by timberjack (gzipped) and by logrotate (plain
|
|
// and gzipped), and skips unrelated files.
|
|
func TestAddRotatedLogFiles_PicksUpAllVariants(t *testing.T) {
|
|
dir := t.TempDir()
|
|
|
|
writeFile(t, filepath.Join(dir, "client.log"), "active log\n")
|
|
writeFile(t, filepath.Join(dir, "other.log"), "unrelated\n")
|
|
|
|
timberjackRotated := "client-2026-05-21T10-30-45.000.log.gz"
|
|
writeGzFile(t, filepath.Join(dir, timberjackRotated), "timberjack rotated content\n")
|
|
|
|
logrotatePlain := "client.log.1"
|
|
writeFile(t, filepath.Join(dir, logrotatePlain), "logrotate plain content\n")
|
|
|
|
logrotateGz := "client.log.2.gz"
|
|
writeGzFile(t, filepath.Join(dir, logrotateGz), "logrotate gz content\n")
|
|
|
|
names := runAddRotatedLogFiles(t, dir, 10)
|
|
|
|
require.Contains(t, names, timberjackRotated, "timberjack rotated file should be in bundle")
|
|
require.Contains(t, names, logrotatePlain, "logrotate plain rotated file should be in bundle")
|
|
require.Contains(t, names, logrotateGz, "logrotate gzipped rotated file should be in bundle")
|
|
require.NotContains(t, names, "client.log", "active log should not be added by addRotatedLogFiles")
|
|
require.NotContains(t, names, "other.log", "unrelated files should not be in bundle")
|
|
}
|
|
|
|
// TestAddRotatedLogFiles_GUIPrefix asserts the prefix parameter scopes the glob
|
|
// to the GUI log: gui-client.log.* rotated siblings are picked up and the
|
|
// daemon's own client.log.* are not (and vice versa, covered above). This is
|
|
// the load-bearing check for the gui-client.log bundle collection — the old
|
|
// "client*.log.*" glob would have missed gui-client rotations.
|
|
func TestAddRotatedLogFiles_GUIPrefix(t *testing.T) {
|
|
dir := t.TempDir()
|
|
|
|
writeFile(t, filepath.Join(dir, "gui-client.log.1"), "gui rotated\n")
|
|
writeGzFile(t, filepath.Join(dir, "gui-client.log.2.gz"), "gui rotated gz\n")
|
|
writeFile(t, filepath.Join(dir, "client.log.1"), "daemon rotated\n")
|
|
|
|
names := runAddRotatedLogFilesPrefix(t, dir, "gui-client", 10)
|
|
|
|
require.Contains(t, names, "gui-client.log.1", "gui-client rotated file should be in bundle")
|
|
require.Contains(t, names, "gui-client.log.2.gz", "gui-client gz rotated file should be in bundle")
|
|
require.NotContains(t, names, "client.log.1", "daemon rotated file must not match the gui-client prefix")
|
|
}
|
|
|
|
// TestAddRotatedLogFiles_RespectsLogFileCount asserts that only the newest
|
|
// logFileCount rotated files are bundled, ordered by mtime.
|
|
func TestAddRotatedLogFiles_RespectsLogFileCount(t *testing.T) {
|
|
dir := t.TempDir()
|
|
|
|
oldest := filepath.Join(dir, "client.log.3")
|
|
middle := filepath.Join(dir, "client.log.2")
|
|
newest := filepath.Join(dir, "client.log.1")
|
|
writeFile(t, oldest, "old\n")
|
|
writeFile(t, middle, "mid\n")
|
|
writeFile(t, newest, "new\n")
|
|
|
|
now := time.Now()
|
|
require.NoError(t, os.Chtimes(oldest, now.Add(-2*time.Hour), now.Add(-2*time.Hour)))
|
|
require.NoError(t, os.Chtimes(middle, now.Add(-1*time.Hour), now.Add(-1*time.Hour)))
|
|
require.NoError(t, os.Chtimes(newest, now, now))
|
|
|
|
names := runAddRotatedLogFiles(t, dir, 2)
|
|
|
|
require.Contains(t, names, "client.log.1")
|
|
require.Contains(t, names, "client.log.2")
|
|
require.NotContains(t, names, "client.log.3", "oldest file should be dropped when logFileCount=2")
|
|
}
|
|
|
|
// runAddRotatedLogFiles calls addRotatedLogFiles against a fresh in-memory
|
|
// zip writer and returns the set of entry names that ended up in the archive.
|
|
func runAddRotatedLogFiles(t *testing.T, dir string, logFileCount uint32) map[string]struct{} {
|
|
return runAddRotatedLogFilesPrefix(t, dir, "client", logFileCount)
|
|
}
|
|
|
|
func runAddRotatedLogFilesPrefix(t *testing.T, dir, prefix string, logFileCount uint32) map[string]struct{} {
|
|
t.Helper()
|
|
|
|
var buf bytes.Buffer
|
|
g := &BundleGenerator{
|
|
archive: zip.NewWriter(&buf),
|
|
logFileCount: logFileCount,
|
|
}
|
|
g.addRotatedLogFiles(dir, prefix)
|
|
require.NoError(t, g.archive.Close())
|
|
|
|
zr, err := zip.NewReader(bytes.NewReader(buf.Bytes()), int64(buf.Len()))
|
|
require.NoError(t, err)
|
|
|
|
names := make(map[string]struct{}, len(zr.File))
|
|
for _, f := range zr.File {
|
|
names[f.Name] = struct{}{}
|
|
}
|
|
return names
|
|
}
|
|
|
|
func writeFile(t *testing.T, path, content string) {
|
|
t.Helper()
|
|
require.NoError(t, os.WriteFile(path, []byte(content), 0o644))
|
|
}
|
|
|
|
func writeGzFile(t *testing.T, path, content string) {
|
|
t.Helper()
|
|
var buf bytes.Buffer
|
|
gw := gzip.NewWriter(&buf)
|
|
_, err := io.WriteString(gw, content)
|
|
require.NoError(t, err)
|
|
require.NoError(t, gw.Close())
|
|
require.NoError(t, os.WriteFile(path, buf.Bytes(), 0o644))
|
|
}
|