Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.58 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.58 KB
Raw

Probes

Build Status Crate

Rust library to read out system stats from a machine running Unix. Currently only supports Linux.

Supported stats

System wide

  • load
  • cpu
  • memory
  • network
  • io
  • disk

Per process

  • memory (total, resident, virtual)

Contributing

Thinking of contributing to our Probes package? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Running cargo fmt before contributing changes would reduce diffs for future contributions.

Also, we would be very happy to send you Stroopwafles. Have look at everyone we send a package to so far on our Stroopwafles page.

Setup

  • Download and install Docker
  • Build the images: make build
  • Make sure that the path where this code resided can be mounted as a volume with Docker.
  • Run the tests on all images: make test
  • Add awesome features!

The tests on Travis are only run directly on that VM. Make sure to run the full test suite manually before every release.

Release

  • Update version in Cargo.toml.
  • Update CHANGELOG.md file.
  • Commit your changes.
  • Tag the release: git tag v#.#.#.
  • Run cargo publish.