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

//! The supervisor's retained view of the live `runtime/logs` stream.
//!
//! Retention depth, eviction, and what "recent" means are the supervisor's
//! decisions; this module owns the paged request and the record shape a
//! consumer reads back. Records use the same timestamp, severity, and
//! finite-value vocabulary as ingestion, so a retained record and a live event
//! never disagree about what a field means.

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

use crate::runtime::api::logs::{Level, LogValue, Timestamp};
use crate::runtime::api::telemetry::Cursor;

/// 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 log record. The supervisor's `sequence` orders the retained
/// view; `source_sequence` is the producer's own counter, so per-producer loss
/// stays visible after retention has merged several producers.
#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Record {
    pub sequence: u64,
    pub participant_id: String,
    pub source_sequence: u64,
    pub time: Timestamp,
    pub level: Level,
    pub target: String,
    pub message: String,
    pub fields: ::std::collections::BTreeMap<String, LogValue>,
    pub dropped: u32,
    pub truncated: u32,
}

#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
pub struct Snapshot {
    pub cursor: Cursor,
    /// Records the supervisor lost at ingestion, which no page can show.
    pub ingest_dropped: u64,
    pub records: Vec<Record>,
    /// 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 ingest_dropped: u64,
    pub record: Record,
}