sb6183-stats-for-influxdb's Introduction

SB6183 Modem Stats emitted to Influxdb running as a Docker container

This tool is a parser of the Arris SB6183 cable modem to emit signal & power metrics to InfluxDB

Grafana dashboard example

See this example json for a grafana dashboard as shown in the screenshot above

Configuration within config.ini

GENERAL

Key	Description
Delay	Delay between runs
Output	Write console output while tool is running

INFLUXDB

Key	Description
Address	Delay between updating metrics
Port	InfluxDB port to connect to. 8086 in most cases
Database	Database to write collected stats to
Username	User that has access to the database
Password	Password for above user

MODEM

Key	Description
URL	URL of the cable modem info page. Leave blank for http://192.168.100.1/RgConnect.asp

Usage

Before the first use run pip3 install -r requirements.txt

Enter your desired information in config.ini and run SB6183.py

Optionally, you can specify the --config argument to load the config file from a different location.

Requirements

Python 3+

You will need the influxdb library installed to use this - Found Here

Docker Setup

Install Docker
Make a directory to hold the config.ini file. Navigate to that directory and download the sample config.ini in this repo.

mkdir SB6183-stats-for-influxdb
curl -O https://raw.githubusercontent.com/billimek/SB6183-stats-for-influxdb/blob/master/config.ini SB6183-stats-for-influxdb/config.ini
cd SB6183-stats-for-influxdb

Modify the config file with your influxdb settings.

vim config.ini

Modify the 'Address =' line include the ip or hostname of your influxdb instance. Example:

Address = 10.13.14.200

. Run the container, pointing to the directory with the config file. This should now pull the image from Docker hub. You can do this by either running docker run or by using docker-compose.

docker run -d \
--name="sb6183" \
-v $PWD/config.ini:/src/config.ini \
--restart="always" \
billimek/sb6183-for-influxdb

sb6183-stats-for-influxdb's People

Contributors

Stargazers

Watchers

sb6183-stats-for-influxdb's Issues

Support for SB8200?

Is there any chance you could add support for an Arris SB8200? I tried to run the docker image as-is but get:

docker start modemmonitor;docker logs -f modemmonitor
modemmonitor
Loading Configuration File config.ini
Configuration Successfully Loaded
Getting modem stats
Traceback (most recent call last):
  File "/src/SB6183.py", line 188, in <module>
    main()
  File "/src/SB6183.py", line 185, in main
    collector.run()
  File "/src/SB6183.py", line 145, in run
    self.parse_modem()
  File "/src/SB6183.py", line 95, in parse_modem
    'channel_id': int(channel_id),
ValueError: invalid literal for int() with base 10: 'SC-QAM'

Recommend Projects