scxtop 1.1.0

sched_ext scheduler tool for observability
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

// Copyright (c) Meta Platforms, Inc. and affiliates.
//
// This software may be used and distributed according to the terms of the
// GNU General Public License version 2.

use anyhow::Result;
use log::{debug, warn};
use scx_stats::StatsClient;
use serde_json::Value as JsonValue;
use std::sync::Arc;
use std::sync::RwLock;

/// Default path for scheduler stats socket
const DEFAULT_STATS_SOCKET_PATH: &str = "/var/run/scx/root/stats";

/// Thread-safe wrapper for stats client
pub struct SharedStatsClient {
    inner: Arc<RwLock<Option<StatsClient>>>,
    socket_path: String,
}

impl SharedStatsClient {
    pub fn new(socket_path: Option<String>) -> Self {
        let socket_path = socket_path.unwrap_or_else(|| DEFAULT_STATS_SOCKET_PATH.to_string());
        Self {
            inner: Arc::new(RwLock::new(None)),
            socket_path,
        }
    }

    /// Try to connect to the scheduler's stats socket
    pub fn connect(&self) -> Result<()> {
        let client = StatsClient::new()
            .set_path(&self.socket_path)
            .connect(None)?;
        let mut inner = self.inner.write().unwrap();
        *inner = Some(client);
        debug!("Connected to stats socket at {}", self.socket_path);
        Ok(())
    }

    /// Check if connected
    pub fn is_connected(&self) -> bool {
        let inner = self.inner.read().unwrap();
        inner.is_some()
    }

    /// Request stats from the scheduler
    pub fn request_stats(&self, target: Option<Vec<(String, String)>>) -> Result<JsonValue> {
        let mut inner = self.inner.write().unwrap();

        if inner.is_none() {
            // Try to connect
            drop(inner);
            if let Err(e) = self.connect() {
                warn!("Failed to connect to stats socket: {}", e);
                return Ok(serde_json::json!({
                    "error": "not_connected",
                    "message": format!("Failed to connect to scheduler stats: {}", e),
                    "note": "Ensure a scheduler is running and providing stats at the socket path"
                }));
            }
            inner = self.inner.write().unwrap();
        }

        if let Some(ref mut client) = *inner {
            match client.request::<JsonValue>("stats", target.unwrap_or_default()) {
                Ok(result) => Ok(result),
                Err(e) => {
                    warn!("Stats request failed: {}", e);
                    // Connection might be stale, clear it
                    *inner = None;
                    Ok(serde_json::json!({
                        "error": "request_failed",
                        "message": format!("Failed to request stats: {}", e),
                        "note": "The scheduler may have stopped or restarted"
                    }))
                }
            }
        } else {
            Ok(serde_json::json!({
                "error": "not_connected",
                "message": "Not connected to scheduler stats socket"
            }))
        }
    }

    /// Request stats metadata from the scheduler
    pub fn request_stats_meta(&self) -> Result<JsonValue> {
        let mut inner = self.inner.write().unwrap();

        if inner.is_none() {
            // Try to connect
            drop(inner);
            if let Err(e) = self.connect() {
                warn!("Failed to connect to stats socket: {}", e);
                return Ok(serde_json::json!({
                    "error": "not_connected",
                    "message": format!("Failed to connect to scheduler stats: {}", e),
                }));
            }
            inner = self.inner.write().unwrap();
        }

        if let Some(ref mut client) = *inner {
            match client.request::<JsonValue>("stats_meta", vec![]) {
                Ok(result) => Ok(result),
                Err(e) => {
                    warn!("Stats meta request failed: {}", e);
                    // Connection might be stale, clear it
                    *inner = None;
                    Ok(serde_json::json!({
                        "error": "request_failed",
                        "message": format!("Failed to request stats metadata: {}", e),
                    }))
                }
            }
        } else {
            Ok(serde_json::json!({
                "error": "not_connected",
                "message": "Not connected to scheduler stats socket"
            }))
        }
    }
}

impl Clone for SharedStatsClient {
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
            socket_path: self.socket_path.clone(),
        }
    }
}