Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions crates/toride-status/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
[package]
name = "toride-status"
version = "0.1.0"
edition = "2024"

[lib]
name = "toride_status"
path = "src/lib.rs"

[features]
default = ["sysinfo-provider"]
sysinfo-provider = []
linux-procfs = ["procfs"]
linux-sensors = ["lm-sensors"]
linux-udev = ["udev"]
linux-rtnetlink = ["rtnetlink"]
linux-cgroups = ["cgroups-rs"]
os-info = ["os_info"]
cpu-cpuid = ["raw-cpuid"]
hardware-dmi = ["dmidecode"]
hardware-pci = ["pci-info", "pci-ids"]
hardware-topology = ["hwlocality"]
gpu-nvidia = ["nvml-wrapper"]
battery = ["starship-battery"]
commands = ["dep:duct"]

[dependencies]
sysinfo = "0.35"
sysconf = "0.3"
serde = { workspace = true }
serde_json = { workspace = true }
thiserror = { workspace = true }
tracing = { workspace = true }
which = { workspace = true }
nix = { version = "0.31", features = ["user", "signal", "fs"] }
dirs = { workspace = true }

# Optional dependencies
procfs = { version = "0.18", optional = true }
os_info = { version = "3", optional = true }
nvml-wrapper = { version = "0.10", optional = true }
starship-battery = { version = "0.8", optional = true }
dmidecode = { version = "1.0", optional = true }
raw-cpuid = { version = "11", optional = true }
hwlocality = { version = "1.0.0-alpha.12", optional = true }
pci-info = { version = "0.2", optional = true }
pci-ids = { version = "0.2", optional = true }
cgroups-rs = { version = "0.5", optional = true }
duct = { version = "0.13", optional = true }
lm-sensors = { version = "0.1", optional = true }
udev = { version = "0.8", optional = true }
rtnetlink = { version = "0.14", optional = true }

[dev-dependencies]
insta = "1"
tempfile = "3"

[lints]
workspace = true
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
//! # Examples
//!
//! ```no_run
//! use toride::status::capabilities::Capabilities;
//! use toride_status::capabilities::Capabilities;
//!
//! let caps = Capabilities::detect();
//! if caps.system.load_average {
Expand All @@ -49,8 +49,8 @@
//! Check capabilities before collecting:
//!
//! ```no_run
//! use toride::status::capabilities::Capabilities;
//! use toride::status::system::SystemStatus;
//! use toride_status::capabilities::Capabilities;
//! use toride_status::system::SystemStatus;
//!
//! let caps = Capabilities::detect();
//! let status = SystemStatus::collect();
Expand All @@ -73,7 +73,7 @@ use serde::Serialize;
/// # Examples
///
/// ```no_run
/// use toride::status::capabilities::Capabilities;
/// use toride_status::capabilities::Capabilities;
///
/// let caps = Capabilities::detect();
/// println!("{}", caps);
Expand Down Expand Up @@ -304,7 +304,7 @@ impl Capabilities {
/// # Examples
///
/// ```
/// use toride::status::capabilities::Capabilities;
/// use toride_status::capabilities::Capabilities;
///
/// let caps = Capabilities::detect();
/// assert!(caps.system.cpu_usage); // Always available.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
//!
//! ```no_run
//! use std::time::Duration;
//! use toride::status::collector::Collector;
//! use toride::status::presets::Preset;
//! use toride_status::collector::Collector;
//! use toride_status::presets::Preset;
//!
//! let mut collector = Collector::new(Duration::from_secs(1), Preset::Diagnostics);
//!
Expand All @@ -42,7 +42,7 @@
//!
//! ```no_run
//! use std::time::Duration;
//! use toride::status::collector::Collector;
//! use toride_status::collector::Collector;
//!
//! let mut collector = Collector::default_collector();
//! loop {
Expand All @@ -56,9 +56,9 @@ use std::time::{Duration, Instant};

use serde::Serialize;

use crate::status::presets::Preset;
use crate::status::system::SystemStatus;
use crate::status::TorideStatus;
use crate::presets::Preset;
use crate::system::SystemStatus;
use crate::TorideStatus;

/// Collector for periodic status snapshots.
pub struct Collector {
Expand All @@ -77,7 +77,7 @@ pub struct Collector {
///
/// ```no_run
/// use std::time::Duration;
/// use toride::status::collector::Collector;
/// use toride_status::collector::Collector;
///
/// let mut collector = Collector::default_collector();
/// collector.collect(); // First call, no delta.
Expand Down Expand Up @@ -185,8 +185,8 @@ impl Collector {
///
/// ```
/// use std::time::Duration;
/// use toride::status::collector::Collector;
/// use toride::status::presets::Preset;
/// use toride_status::collector::Collector;
/// use toride_status::presets::Preset;
///
/// let collector = Collector::new(Duration::from_secs(5), Preset::Minimal);
/// assert_eq!(collector.interval(), Duration::from_secs(5));
Expand All @@ -211,7 +211,7 @@ impl Collector {
/// # Examples
///
/// ```
/// use toride::status::collector::Collector;
/// use toride_status::collector::Collector;
///
/// let collector = Collector::default_collector();
/// ```
Expand Down Expand Up @@ -245,7 +245,7 @@ impl Collector {
/// # Examples
///
/// ```no_run
/// use toride::status::collector::Collector;
/// use toride_status::collector::Collector;
///
/// let mut collector = Collector::default_collector();
/// let (status, delta) = collector.collect();
Expand Down Expand Up @@ -274,7 +274,7 @@ impl Collector {
///
/// ```no_run
/// use std::time::Duration;
/// use toride::status::collector::Collector;
/// use toride_status::collector::Collector;
///
/// let mut collector = Collector::new(Duration::from_millis(100), Default::default());
/// let (status, delta) = collector.collect_after_interval();
Expand All @@ -298,7 +298,7 @@ impl Collector {
/// # Examples
///
/// ```
/// use toride::status::collector::Collector;
/// use toride_status::collector::Collector;
///
/// let mut collector = Collector::default_collector();
/// collector.collect();
Expand All @@ -321,7 +321,7 @@ impl Collector {
///
/// ```
/// use std::time::Duration;
/// use toride::status::collector::Collector;
/// use toride_status::collector::Collector;
///
/// let collector = Collector::builder()
/// .interval(Duration::from_secs(2))
Expand Down Expand Up @@ -587,7 +587,7 @@ impl SystemStatus {
///
/// ```no_run
/// use std::time::Duration;
/// use toride::status::system::SystemStatus;
/// use toride_status::system::SystemStatus;
///
/// let prev = SystemStatus::collect();
/// std::thread::sleep(Duration::from_secs(1));
Expand Down Expand Up @@ -647,7 +647,7 @@ impl std::fmt::Display for SystemDelta {
#[cfg(test)]
mod tests {
use super::*;
use crate::status::system::{
use crate::system::{
DiskIoSnapshot, DiskStatus, HardwareInventory, MemoryStatus, NetworkStatus, OsInfo,
ProcessSnapshot, SensorSnapshot, StaticInfo, SystemStatus, VirtualizationSnapshot,
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
//! # Examples
//!
//! ```no_run
//! use toride::status::daemon::DaemonStatus;
//! use toride_status::daemon::DaemonStatus;
//!
//! let status = DaemonStatus::collect();
//! if status.alive {
Expand Down Expand Up @@ -78,7 +78,7 @@ impl DaemonStatus {
/// # Examples
///
/// ```no_run
/// use toride::status::daemon::DaemonStatus;
/// use toride_status::daemon::DaemonStatus;
///
/// let status = DaemonStatus::collect();
/// if status.alive {
Expand Down Expand Up @@ -111,7 +111,7 @@ impl DaemonStatus {
///
/// ```
/// use std::path::Path;
/// use toride::status::daemon::DaemonStatus;
/// use toride_status::daemon::DaemonStatus;
///
/// let status = DaemonStatus::collect_with_paths(
/// Path::new("/var/run/myapp.pid"),
Expand Down
Loading
Loading