Skip to main content

Parse RStats-format bandwidth logfiles and perform simple analysis/aggregation.

Project description


GitHub Workflow Codecov Python Versions Package Version

Read bandwidth logfiles in the RStats format (usually created by routers running some offshoot of the Tomato firmware) and perform simple analysis/aggregation.

Supports printing bandwidth data to the console, as well as conversion to CSV or JSON formats for further ingestion downstream.

Supports arbitrary week/month beginnings and conversion to arbitrary units.


Simple Usage

Printing to screen:

$ rstats-reader --print dwm /path/to/logfile.gz

Saving to another format:

$ rstats-reader --write dwm -f json -o out.json /path/to/logfile.gz

All Options

$ rstats-reader -h

usage: rstats-reader [--print {dwm}] [-w {Mon - Sun}] [-m {1 - 31}]
		     [--write {dwm}] [-o outfile.dat] [-f {csv,json}]
		     [-u {B - TiB}] [-h] [--version]

positional arguments:
	logpath				gzipped rstats logfile

optional arguments:
	--print {dwm}			Print daily, weekly or monthly statistics to the console
	-w, --week-start {Mon - Sun}	Day of the week statistics should reset
	-m, --month-start {1 - 31}	Day of the month statistics should reset
	-u, --units {B - TiB}		Units statistics will be displayed in
	-h, --help			show this help message and exit
	--version			show program's version number and exit

	--write {dwm}			Write daily, weekly or monthly statistics to a file
	-o, --outfile outfile.dat	File to write statistics to
	-f, --format {csv,json}		Format to write statistics in

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rstats-logreader-3.1.2.tar.gz (17.1 kB view hashes)

Uploaded source

Built Distribution

rstats_logreader-3.1.2-py3-none-any.whl (10.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page