sprawling-wire 0.0.8

The process boundary of a sprawling city: the frames its clients speak, and the server that answers them.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
// Copyright (c) 2026 2youg1 and the sprawling contributors

//! The performance monitor's pair of frames (`crates/wire/spec/Frames/Monitor.lean` §8-47g):
//! whether a session is watching, and one reading sent to it.

use serde::{Deserialize, Serialize};

/// Whether this session counts as somebody watching the monitor.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum Monitoring {
    /// Watch the whole monitor page.
    Watch,
    /// Watch only the one-line summary beside the settings tree's performance entry, which reads this process alone.
    WatchSummary,
    Release,
}

/// What one watcher looks at, which decides how much the city reads for
/// it. It does not travel: it is what `MonitorFeed::watch` is told.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Watched {
    Everything,
    Summary,
}

/// One reading of every counter the monitor shows, in integers because
/// it travels on the wire (`crates/sprawling/Spec.lean` §8-94, §8-129-6).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct Sample {
    pub core_cpu_permille: u64,
    pub core_private_bytes: u64,
    pub core_working_set_bytes: u64,
    pub core_read_bytes: u64,
    pub core_written_bytes: u64,
    pub machine_cpu_permille: u64,
    pub machine_available_bytes: u64,
    pub volume_free_bytes: u64,
    pub ledger_queue_depth: u64,
    pub durable_lag: u64,
    pub relay_p50_nanos: u64,
    pub event_to_screen_p50_nanos: u64,
    pub queued_runs: u64,
    /// Committed records the writer has handed the view thread that are
    /// not yet folded and broadcast (`crates/sprawling/Spec.lean` §8-123).
    pub view_backlog: u64,
    /// How long the beat before this one took to read the counters, by
    /// the sampler's own monotonic clock; 0 on the first beat
    /// (`crates/sprawling/Spec.lean` §8-129-6).
    pub read_nanos: u64,
}