Skip to main content

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

Project description

rstats-logreader

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.

Usage

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]
		     logpath

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:
	--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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file rstats-logreader-3.1.2.tar.gz.

File metadata

  • Download URL: rstats-logreader-3.1.2.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for rstats-logreader-3.1.2.tar.gz
Algorithm Hash digest
SHA256 63761294abf328aa2739b86640d5da1cbc988eb8224ce71a07e312ab3868ab28
MD5 de15665bb5095cf005172779d0b94535
BLAKE2b-256 b0cd3ad89deb6d4d5a1b175ae4236749a59f291c11bc00bc7b4036fcd79c250b

See more details on using hashes here.

File details

Details for the file rstats_logreader-3.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for rstats_logreader-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3c1018df21ad7ef19dfce3d9e520a7f9832ca9f4b28dcf2353c42d7f8dde1e5a
MD5 ecab3f5aee399d06628ed24b4a5caac8
BLAKE2b-256 53c97e26b364ae35a8285e6dc9d33a5cc67041f6ae446b833492ef0b1f021b0b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page