hoststats 0.0.4

Host stats

hoststats

hoststats captures resource usage (memory usage, CPU cycles, network transfers) for a set of hosts over a period of time.

A Python API is provided for starting and finishing collection, and pulling the results to a CSV file.

This is a quick-and-dirty project to support experiments on distributed systems, and not intended for anything more serious.

Usage

Install:

pip3 install hoststats

Start the hoststats server (must be done on each host on which you wish to collect stats). Note that this runs in the foreground, so you can put it to the background however you see fit, e.g.

hoststats start 2>&1 > /tmp/hoststats.log

Check it's up with:

curl localhost:5000/ping

Create a client on another host with:

# Get list of IPs/ hostnames for hosts to be monitored
ip_list = ["1.2.3.4", "5.6.7.8"]

# Set up the client
hs = HostStats(ip_list)

# Start collection
hs.start_collection()

# Wait some time

# Write stats to CSV
hs.stop_and_write_to_csv("hoststats.csv")

Development

Ensure pip and setuptools are up to date and install requirements.

To develop:

pip3 install -e .

Run tests:

./bin/tests.sh

Releasing

To push to PyPI, make sure you have set up Twine keyring support, or a pypirc.

Then increment the version in VERSION.

Then:

# Tag the code
./bin/tag.sh

# Build the Docker image
./bin/build.sh

# Check the distributed tests passs
./bin/dist_test.sh

# Push the package
./bin/release.sh