p-e-w/hegemon

Introducing Hegemon

GitLab Mirror

Hegemon is a work-in-progress modular system monitor written in safe Rust.

Currently, it has the following features:

• Monitor CPU and memory usage, temperatures, and fan speeds
• Expand any data stream to reveal a more detailed graph and additional information
• Adjustable update interval
• Clean MVC architecture with good code quality
• Unit tests

Planned features include:

• macOS and BSD support (only Linux is supported at the moment)
• Monitor disk and network I/O, GPU usage (maybe), and more
• Select and reorder data streams
• Mouse control

Hegemon is built around the excellent crossbeam-channel, termion, systemstat, and sensors crates.

Building

Hegemon is currently Linux only and requires Rust 1.34 or later and the development files for libsensors. The latter can be found in the package repository of every major Linux distribution, e.g. lm_sensors-devel in Fedora and libsensors4-dev in Ubuntu.

Once these requirements are met, Hegemon can be built and run with

git clone https://github.com/p-e-w/hegemon.git
cd hegemon
cargo run

Adding new data streams

Unlike traditional system monitors such as top, which are tailor-made to display specific metrics like CPU and memory usage only, Hegemon shows the output of monitoring modules called data streams, whose behavior is defined by the Stream trait.

Streams only need to supply basic properties such as name and description, and a method for retrieving a numeric data value. Everything else is managed by Hegemon, including update scheduling, layout and rendering, adaptive scaling, and computation of statistics.

Stream objects are in turn generated by StreamProviders. This makes it possible to have streams whose exact nature and number can only be determined at runtime, such as one stream per CPU core.

Adding new streams, then, involves the following steps:

1. Create a StreamProvider
2. Make it return Stream objects from its streams method
3. Register the provider in providers/mod.rs

The providers directory contains several working provider implementations that can be used as a reference. In particular, most providers will want to use the Stream::new helper function to create streams instead of manually implementing the Stream trait.

Ideas for, and implementations of, additional data streams are very welcome!

License

Copyright © 2018-2020 Philipp Emanuel Weidmann ([email protected])

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

By contributing to this project, you agree to release your contributions under the same license.