phoxal 0.67.0

Phoxal - production-oriented autonomous robot framework: the one framework library, holding the runtime engine, the api contract tree, the typed bus, the canonical model, and the bundle.
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Runtime performance a process measures about itself: its step cadence and
//! its per-topic bus accounting, rolled up over one window.
//!
//! The producing participant is the bus envelope's source attribution, so a
//! rollup carries no identity field of its own. Retained, replayable views over
//! these same samples belong to whatever host tool collects them; this family
//! owns only the live rollup and the sample vocabulary it is written in.

crate::endpoints! {
    self: Stream<Rollup, Out>;
}

/// Position in one retained sample sequence.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, Eq, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Cursor {
    pub sequence: u64,
}

/// Which side of a topic a row accounts for. `Mixed` exists for a summary row
/// that spans several topics and therefore names no single direction.
#[derive(
    phoxal_macros::DescribeWire,
    Clone,
    Copy,
    Debug,
    Eq,
    Ord,
    PartialEq,
    PartialOrd,
    serde::Serialize,
    serde::Deserialize,
)]
#[serde(rename_all = "snake_case")]
pub enum Direction {
    Publish,
    Subscribe,
    Mixed,
}

/// Which buffer a row accounts for. `Mixed` exists for a summary row that
/// spans several buffers.
#[derive(
    phoxal_macros::DescribeWire,
    Clone,
    Copy,
    Debug,
    Eq,
    Ord,
    PartialEq,
    PartialOrd,
    serde::Serialize,
    serde::Deserialize,
)]
#[serde(rename_all = "snake_case")]
pub enum BufferKind {
    Outbound,
    Latest,
    Subscriber,
    Mixed,
}

/// Step cadence measured over one window, for a participant that has a
/// cadence at all.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Step {
    pub target_period_ns: u64,
    pub completed: u64,
    pub errors: u64,
    pub mean_duration_ns: u64,
    pub max_duration_ns: u64,
    pub mean_lateness_ns: u64,
    pub max_lateness_ns: u64,
    pub missed_ticks: u64,
    pub overruns: u64,
}

/// One topic's traffic and buffer accounting over one window.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Topic {
    pub topic: String,
    pub direction: Direction,
    pub buffer_kind: BufferKind,
    pub count: u64,
    pub rate_millihz: u64,
    pub drops: u64,
    pub latest_overwrites: u64,
    pub bounded_evictions: u64,
    pub capacity: u64,
    pub current_depth: u64,
    pub high_water_depth: u64,
    pub decode_errors: u64,
    pub timeline_filtered: u64,
    /// Rows folded into this one; zero on an ordinary per-topic row.
    pub overflowed_rows: u32,
}

/// One window of runtime performance: the step section, the bounded per-topic
/// rows, and the single row everything that did not fit was folded into.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Rollup {
    pub window_ns: u64,
    pub step: Option<Step>,
    pub topics: Vec<Topic>,
    pub overflow: Option<Topic>,
}