Report how a config reload went: failures, restarts required, and the keys that need one (#1935)

This commit is contained in:
Nate Brown authored and GitHub committed 2026-10-15 15:36:39 -05:00
1 parent 42597dda7d
commit 1a0ac25db0
57 files changed
+941 -193

No files matched your search

+3 -2
View File
@@ -43,7 +43,8 @@ type Conn interface {
// its own packet, so a short count means some peers were undeliverable, not that the batch failed.
// Not safe for concurrent use on the same Conn.
WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error)
ReloadConfig(c *config.C)
// ReloadConfig applies the listen settings that can change, r is nil at startup
ReloadConfig(c *config.C, r *config.Reload)
SupportsMultipleReaders() bool
Close() error
}
@@ -68,7 +69,7 @@ func (NoopConn) WriteTo(_ []byte, _ netip.AddrPort) error {
func (NoopConn) WriteBatch(bufs [][]byte, _ []netip.AddrPort) (int, error) {
return len(bufs), nil
}
func (NoopConn) ReloadConfig(_ *config.C) {
func (NoopConn) ReloadConfig(_ *config.C, _ *config.Reload) {
return
}
func (NoopConn) Close() error {
+6
View File
@@ -24,6 +24,12 @@ type NetworkChangeMonitor struct {
// NewNetworkChangeMonitor builds a monitor for local network changes. The returned monitor is always usable: Start
// is safe to call unconditionally, it no-ops when disabled or on a platform that does not need it.
func NewNetworkChangeMonitor(ctx context.Context, l *slog.Logger, c *config.C) *NetworkChangeMonitor {
if watchesNetworkChanges {
c.RegisterReloadCallback(func(c *config.C, r *config.Reload) {
r.RestartRequiredIfChanged("listen.rebind_on_network_change")
})
}
return &NetworkChangeMonitor{
l: l,
ctx: ctx,
+3
View File
@@ -13,6 +13,9 @@ import (
"golang.org/x/sys/unix"
)
// watchesNetworkChanges is true where Start does anything
const watchesNetworkChanges = true
const (
// netChangeSettleWindow is how long we keep swallowing routing messages after the first interesting one. A
// single network change is never a single message, it is a burst: the link drops, addresses go away, new ones
+3
View File
@@ -7,6 +7,9 @@ import (
"log/slog"
)
// watchesNetworkChanges is true where Start does anything
const watchesNetworkChanges = false
// watchNetworkChanges is a no-op outside of darwin.
//
// Darwin is the platform that scopes a udp socket to the interface it came up on, so it is the platform whose socket
+16
View File
@@ -37,3 +37,19 @@ func TestNetworkChangeMonitorNilRebindIsANoOp(t *testing.T) {
m := newMonitor(t, context.Background(), "listen:\n rebind_on_network_change: true\n")
m.Start(nil)
}
// The monitor only reads listen.rebind_on_network_change when it is made
func TestNetworkChangeMonitorRestartKey(t *testing.T) {
l := test.NewLogger()
c := config.NewC(l)
require.NoError(t, c.LoadString("listen:\n rebind_on_network_change: true\n"))
NewNetworkChangeMonitor(context.Background(), l, c)
res := c.ReloadConfigString("listen:\n rebind_on_network_change: false\n")
require.NoError(t, res.Err)
if watchesNetworkChanges {
assert.Equal(t, []string{"listen.rebind_on_network_change"}, res.RestartKeys)
} else {
assert.Empty(t, res.RestartKeys, "the setting does nothing here")
}
}
+4 -2
View File
@@ -26,7 +26,9 @@ type bypassConn struct {
session *wfp.Session
}
func (b *bypassConn) ReloadConfig(c *config.C) {
func (b *bypassConn) ReloadConfig(c *config.C, r *config.Reload) {
// Only read on the first call, at startup
r.RestartRequiredIfChanged("listen.windows_bypass_wdf")
b.installOnce.Do(func() {
if !c.GetBool("listen.windows_bypass_wdf", true) {
return
@@ -45,7 +47,7 @@ func (b *bypassConn) ReloadConfig(c *config.C) {
"port", addr.Port())
b.session = s
})
b.Conn.ReloadConfig(c)
b.Conn.ReloadConfig(c, r)
}
func (b *bypassConn) Close() error {
+1 -1
View File
@@ -171,7 +171,7 @@ func (u *StdConn) LocalAddr() (netip.AddrPort, error) {
}
}
func (u *StdConn) ReloadConfig(c *config.C) {
func (u *StdConn) ReloadConfig(c *config.C, r *config.Reload) {
// TODO
}
+1 -1
View File
@@ -73,7 +73,7 @@ func (u *GenericConn) LocalAddr() (netip.AddrPort, error) {
}
}
func (u *GenericConn) ReloadConfig(c *config.C) {
func (u *GenericConn) ReloadConfig(c *config.C, r *config.Reload) {
}
+4 -1
View File
@@ -392,7 +392,7 @@ func writeSockaddr(buf []byte, addr netip.AddrPort, isV4 bool) (int, error) {
return unix.SizeofSockaddrInet6, nil
}
func (u *StdConn) ReloadConfig(c *config.C) {
func (u *StdConn) ReloadConfig(c *config.C, r *config.Reload) {
b := c.GetInt("listen.read_buffer", 0)
if b > 0 {
if err := u.SetRecvBuffer(b); err == nil {
@@ -403,6 +403,7 @@ func (u *StdConn) ReloadConfig(c *config.C) {
}
} else {
u.l.Error("Failed to set listen.read_buffer", "error", err)
r.Failed()
}
}
@@ -416,6 +417,7 @@ func (u *StdConn) ReloadConfig(c *config.C) {
}
} else {
u.l.Error("Failed to set listen.write_buffer", "error", err)
r.Failed()
}
}
@@ -430,6 +432,7 @@ func (u *StdConn) ReloadConfig(c *config.C) {
}
} else {
u.l.Error("Failed to set listen.so_mark", "error", err)
r.Failed()
}
}
}
+31
View File
@@ -0,0 +1,31 @@
//go:build linux && !android && !e2e_testing
package udp
import (
"net/netip"
"os"
"testing"
"github.com/slackhq/nebula/config"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// A setting the kernel refuses fails the reload
func TestReloadConfig_RefusedSettingFailsTheReload(t *testing.T) {
if os.Geteuid() == 0 {
t.Skip("root may set listen.so_mark, run as an unprivileged user")
}
conn, err := NewListener(testLogger(), Settings{Listen: netip.MustParseAddrPort("127.0.0.1:0"), Batch: 1})
require.NoError(t, err)
t.Cleanup(func() { _ = conn.Close() })
c := config.NewC(testLogger())
require.NoError(t, c.LoadString("listen:\n port: 0\n"))
c.RegisterReloadCallback(conn.ReloadConfig)
res := c.ReloadConfigString("listen:\n port: 0\n so_mark: 42\n")
require.NoError(t, res.Err)
assert.True(t, res.Failed)
}
+1 -1
View File
@@ -351,7 +351,7 @@ func (u *RIOConn) Rebind() error {
return nil
}
func (u *RIOConn) ReloadConfig(*config.C) {}
func (u *RIOConn) ReloadConfig(*config.C, *config.Reload) {}
func (u *RIOConn) Close() error {
if !u.isOpen.CompareAndSwap(true, false) {
+1 -1
View File
@@ -197,7 +197,7 @@ func (u *TesterConn) ListenOut(r EncReader, flush func()) error {
}
}
func (u *TesterConn) ReloadConfig(*config.C) {}
func (u *TesterConn) ReloadConfig(*config.C, *config.Reload) {}
func NewUDPStatsEmitter(_ []Conn) func() {
// No UDP stats for non-linux