heim-rs/heim

Cross-platform async library for system information fetching 🦀

heim

Cross-platform library for system information fetching

heim is an ongoing attempt to create the best tool for system information fetching (ex., CPU, memory, disks or processes stats) in the Rust crates ecosystem.
It targets to have at least the same functionality as psutil, gopsutil or oshi eventually.

Check user guide to get more information on the heim goals, integrations and showcases.

Why should I use heim instead of {crate-name}? See the comparison page.

Examples can be found here.

Background

heim has a few key goals which define its development and public interface:

1. Async-first with tokio and async-std support.
   Bundled polyfill option could be used for other use cases, see documentation for more details.
2. Cross-platform with platform-specific extensions.
3. Modular design.
4. Idiomatic and easy to use.

Technical notes

heim requires Rust 1.45 or higher; this version is explicitly tested in CI and may be bumped in any major or minor release as needed.
Any changes to the supported minimum version will be called out in the release notes.

Platform support

Right now heim support Tier 1 platforms (Linux, macOS, and Windows for i686 and x86_64). You can check the GitHub projects page for more information.

License

Licensed under either of Apache License 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Donations

If you appreciate my work and want to support me or speed up the project development, you can do it here or support this project at Open Collective.

Contributors

Code Contributors

This project exists thanks to all the people who contribute.

Financial Contributors

Become a financial contributor and help us sustain our community.

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website.

heim's Issues

Memory

Tracking issue for heim::host::uptime support for Windows.

Code is exists already, but should be confirmed working.
It would be good also to cover it with integration test.

Processes pids stream

heim::process::pids implementation for Windows

Cpu stats

Tracking issue for heim::cpu::stats support for MacOS

Disk IO counters

Tracking issue for heim::disk::io_counters and heim::disk::io_counters_physical support for MacOS.

Detect virtualization via cpuid instruction

Probably with help of raw-cpuid crate.

Network connections

Tracking issue for heim::net::connections support for MacOS

Physical CPUs count

Detect virtualization via device tree

Check out the /proc/device-tree/ files for possible options.

Detect Xen-specific information

Things to do:

1. Check out the /proc/xen
2. hypervisor features at /sys/hypervisor/properties/features
3. /sys/hypervisor/type file

Cpu time

Tracking issue for heim::cpu::time support for Windows

Disk partitions

Tracking issue for heim::disk::partitions and heim::disk::partitions_physical support for Windows

Processes pids stream

heim::process::pids implementation for macOS

Detect virtualization via DMI information

Use /sys/class/dmi for a vendor-specific information

Virtualization detection

This is a tracking issue for virtualization detection for Linux.
Systemd' systemd-detect-virt (source) can be used as a code reference.

Code at the moment is located at the linux-virt branch.

Issues in list:

• #36
• #37
• #38
• #39
• #40
• #41
• #42
• #43

Memory

Tracking issue for heim::memory::memory support for MacOS

Host users

Tracking issue for heim::host::users support for MacOS.

Cpu frequency

Tracking issue for heim::cpu::frequency support for Windows

Cpu frequency

Tracking issue for heim::cpu::frequency support for MacOS

Cpu times

Tracking issue for heim::cpu::times support for MacOS

Cpu times

Tracking issue for heim::cpu::times support for Windows

Host uptime

Tracking issue for heim::host::uptime support for Windows

Network NIC

Tracking issue for heim::net::nic support for Windows.

Logical CPUs count

Logical CPUs count

Detect OpenVZ virtualization

Via /proc/vz

Cpu time

Tracking issue for heim::cpu::time support for MacOS

Disk usage

Tracking issue for heim::disk::usage for Windows

Logical CPUs count

Network IO counters

Tracking issue for heim::net::io_counters support for Windows.

Swap

Tracking issue for heim::memory::swap support for MacOS

Detect User-Mode Linux virtualization

Check out the vendor ID at /proc/cpuinfo

Network connections

There is an implementation exists in the source code, but it is commented out, because it depends on this PR.

Netlink sock_diag is definitely better than parsing /proc/net files, therefore this feature will be freezed until mentioned pull request merged (or other async netlink library appears).

Processes pids stream

heim::process::pids implementation for Linux

Network NIC

Tracking issue for heim::net::nic support for MacOS

Detect various containers virtualization

Detect docker, podman, rkt and other container tools.
Since the code would be the same, they were grouped into a one issue.

Network connections

Tracking issue for heim::net::connections support for Windows

Disk partitions

Tracking issue for heim::disk::partitions and heim::disk::partitions_physical support for MacOS

Detect WSL virtualization

microsoft/WSL#423 (comment)

Host platform

Tracking issue for heim::host::platform support for MacOS.

Code for it exists already at disk/src/sys/unix, but it should be confirmed working.

Host platform

Tracking issue for heim::host::platform support for Windows

process::pid_exists for macOS

Host users

Tracking issue for heim::host::users for Windows

Swap

Tracking issue for heim::memory::swap support for Windows.

Same to #21, code is exists already, but should be confirmed and covered with integration tests.

Windows host::users fails

For some reasons smoke test for host::users is failing at Azure Pipelines with a following error:

Error {
  kind: Io(
    Os {
      code: 7022,
      kind: Other,
      message: "The specified session cannot be found."
    }
  )
}

Since the code by itself seems to be working properly, it might be the Azure environment problem? Should be investigated.
At the moment this test is skipped for Windows build.

Cpu stats

Tracking issue for heim::cpu::stats support for Windows

Network IO counters

Tracking issue for heim::net::io_counters support for MacOS

Dependabot couldn't fetch the branch/reference for https://github.com/taiki-e/juliex

Your dependency file specified a branch or reference for https://github.com/taiki-e/juliex, but Dependabot couldn't find it at the project's source. Has it been removed?

You can mention @dependabot in the comments below to contact the Dependabot team.

Host uptime

Tracking issue for heim::host::uptime support for MacOS

Disk usage

Tracking issue for heim::disk::usage for MacOS

Disk IO counters

Tracking issue for heim::disk::io_counters and heim::disk::io_counters_physical support for Windows.