phoxal 0.66.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

//! The supervisor's retained view of the live `runtime/telemetry` stream.
//!
//! Retention depth and eviction are the supervisor's decisions; this module owns
//! the paged request and the record shape a consumer reads back. A record is a
//! retained [`Rollup`](crate::runtime::api::telemetry::Rollup) with the
//! attribution retention has to store explicitly, because the bus envelope that
//! carried it is gone by the time the view is served.

crate::endpoints! {
    snapshot: Query<SnapshotRequest, Snapshot>;
    follow: Stream<Follow, Out>;
}

use crate::runtime::api::telemetry::{Cursor, Step, Topic};

/// One page of retained records, newest first.
///
/// `before_sequence` is the previous page's `next_before_sequence`, so paging
/// walks backwards through a window that keeps moving without ever repeating or
/// skipping a record.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct SnapshotRequest {
    pub participant_id: Option<String>,
    pub limit: u32,
    pub before_sequence: Option<u64>,
}

/// One retained rollup, plus the producer identity and truncation count the
/// live envelope carried.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Record {
    pub sequence: u64,
    pub participant_id: String,
    pub truncated: u32,
    pub window_ns: u64,
    pub step: Option<Step>,
    pub topics: Vec<Topic>,
    pub overflow: Option<Topic>,
}

#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Snapshot {
    pub cursor: Cursor,
    pub records: Vec<Record>,
    /// Records evicted to stay inside the retention budget.
    pub capacity_evictions: u64,
    /// The cursor for the next older page, absent at the end of the window.
    pub next_before_sequence: Option<u64>,
}

#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Follow {
    pub cursor: Cursor,
    pub record: Record,
}