Skip to main content

ServerSettings

Struct ServerSettings 

Source
pub struct ServerSettings {
    pub agent_prune_days: Option<u32>,
}
Expand description

Value stored in the server_settings KV bucket under the single key crate::kv::KEY_SERVER_SETTINGS. Operator-editable, backend-side server configuration that isn’t per-agent (so it doesn’t belong in agent_config’s layered scopes) and isn’t a fleet-wide switch every agent watches (so it doesn’t belong in fleet_config). Managed via the SPA Settings page’s “server settings” tab.

Every field is Option<_>: None (the default / the JSON value null / the field simply absent) means unset — fall back to the built-in default (ServerSettings::defaults), exactly like the agent layered-config scopes. The SPA renders the built-in default as a faint placeholder so a blank field shows what it resolves to, and when a real default is introduced here it appears in the UI (and takes effect for already-deployed-but-unset fleets) for free.

#[serde(default)] on the container keeps the document backward/forward compatible: a freshly-created or missing key decodes to all-None (pre-feature behaviour), an older backend reading a newer document ignores unknown fields, and a newer backend reading an older document fills the missing field with None. Keep that invariant — never add a field whose None doesn’t mean “behave as before”.

Fields§

§agent_prune_days: Option<u32>

Days a dead agent (one whose heartbeat stopped arriving) may linger in the agents registry before the backend cleanup task prunes its row.

None (unset) falls back to the built-in default; with no default configured that resolves to pruning disabled (see ServerSettings::effective_agent_prune_days). A positive value makes the cleanup sweep delete rows whose last_heartbeat is older than that many days. The agents table is a projection of the heartbeat stream, so a machine that’s merely offline (not gone) reappears on its next heartbeat (~30s cadence); only genuinely-retired machines stay gone.

Implementations§

Source§

impl ServerSettings

Source

pub fn defaults() -> Self

Built-in defaults applied when a field is unset (None) in the stored document. Currently every field is None: there’s no fleet-meaningful default prune window, so leaving it blank means “disabled” rather than some arbitrary number of days.

Exposed via GET /api/server-settings/defaults so the SPA renders these as faint placeholders (mirroring the agent layered-config page’s built-in floor). Introducing a real default later is a one-line change here that automatically shows up in the UI and applies to every deployment that hasn’t overridden the field.

Source

pub fn effective_agent_prune_days(&self) -> u32

The effective dead-agent prune window in days: the stored value if set, else the built-in default, else 0 (= pruning disabled). The final unwrap_or(0) is the absent-everywhere floor, not a user-facing default — the cleanup task treats 0 as “don’t prune”.

Clamped to MAX_AGENT_PRUNE_DAYS so the cleanup task’s now - Duration::days(n) can never overflow DateTime (and panic the task), even if a value larger than the PUT handler allows was written to the KV out-of-band.

Trait Implementations§

Source§

impl Clone for ServerSettings

Source§

fn clone(&self) -> ServerSettings

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerSettings

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ServerSettings

Source§

fn default() -> ServerSettings

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ServerSettings

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ServerSettings

Source§

impl PartialEq for ServerSettings

Source§

fn eq(&self, other: &ServerSettings) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ServerSettings

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ServerSettings

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more