# peach-stats

![Generic badge](https://img.shields.io/badge/version-0.1.0-<COLOR>.svg)

System statistics library for PeachCloud. Provides a wrapper around the [probes](https://crates.io/crates/probes) and [systemstat](https://crates.io/crates/systemstat) crates.

Currently offers the following statistics and associated data structures:

 - CPU: `user`, `system`, `nice`, `idle` (as values or percentages)
 - Disk usage: `filesystem`, `one_k_blocks`, `one_k_blocks_used`,
 `one_k_blocks_free`, `used_percentage`, `mountpoint`
 - Load average: `one`, `five`, `fifteen`
 - Memory: `total`, `free`, `used`
 - Uptime: `seconds`

## Example Usage

```rust
use peach_stats::StatsError;

fn main() -> Result<(), StatsError> {
    let cpu = peach_stats::cpu_stats()?;
    let cpu_percentages = peach_stats::cpu_stats_percent()?;
    let disks = peach_stats::disk_usage()?;
    let load = peach_stats::load_average()?;
    let mem = peach_stats::mem_stats()?;
    let uptime = peach_stats::uptime()?;

    // do things with the retrieved values...

    Ok(())
}
```

## License

LGPL-3.0.