microsandbox-protocol 0.5.6

Wire protocol types and serialization for the microsandbox project.
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

//! Heartbeat data for the guest agent.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// Heartbeat data written to `/.msb/heartbeat.json` inside the guest.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Heartbeat {
    /// Monotonic sequence incremented for every heartbeat write.
    pub heartbeat_seq: u64,

    /// Monotonic sequence incremented for every meaningful activity event.
    pub activity_seq: u64,

    /// Timestamp of this heartbeat.
    pub timestamp: DateTime<Utc>,

    /// Timestamp of the last meaningful activity event.
    pub last_activity: DateTime<Utc>,

    /// Number of currently active exec sessions.
    pub active_exec_sessions: u32,

    /// Number of currently active filesystem stream sessions.
    pub active_fs_streams: u32,

    /// Number of currently active TCP stream sessions.
    pub active_tcp_streams: u32,

    /// Cumulative activity counters.
    pub activity_counters: ActivityCounters,
}

/// Cumulative counters for meaningful sandbox activity.
#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize)]
pub struct ActivityCounters {
    /// Meaningful host-to-guest protocol messages.
    pub host_messages: u64,

    /// Meaningful guest-to-host protocol messages.
    pub guest_messages: u64,

    /// Bytes emitted by exec stdout, stderr, or PTY output.
    pub exec_output_bytes: u64,

    /// Bytes moved by filesystem streaming.
    pub fs_bytes: u64,

    /// Bytes moved by TCP streaming.
    pub tcp_bytes: u64,
}