Prometheus exporter for Compal CH7465LG cable modems, commonly sold as "Connect Box"
Project description
Connectbox Prometheus
A Prometheus exporter for monitoring Compal CH7465LG cable modems. These are sold under the name "Connect Box" by Unitymedia in Germany, Ziggo in the Netherlands and UPC in Switzerland/Austria/Poland. Or as "Virgin Media Super Hub 3" by Virgin Media.
Makes thorough use of compal_CH7465LG_py by @ties (thanks!).
Installation
On your Prometheus server host:
- Create a virtual environment using python3.7 or higher
- Install the exporter via
pip install connectbox-prometheus
Usage
This exporter queries exactly one Connect Box as a remote target.
To get started, modify config.yml
from this repository or start out with the following content:
# Connect Box IP address
ip_address: 192.168.0.1
# Connect Box web interface password
password: WhatEverYourPasswordIs
Then run connectbox_exporter path/to/your/config.yml
.
Prometheus Configuration
Add the following to your prometheus.yml
:
scrape_configs:
- job_name: 'connectbox'
static_configs:
- targets:
- localhost:9705
One scrape takes roughly 6 seconds.
Exported Metrics
Metric name | Description |
---|---|
connectbox_device_info |
Assorted device information |
connectbox_uptime_seconds_total |
Device uptime in seconds |
connectbox_tuner_temperature_celsius |
Tuner temperature |
connectbox_temperature_celsius |
Temperature |
connectbox_lan_user_speed_mbit |
LAN user network speed |
connectbox_downstream_frequency_hz |
Downstream channel frequency |
connectbox_downstream_power_level_dbmv |
Downstream channel power level |
connectbox_downstream_snr_db |
Downstream channel signal-to-noise ratio (SNR) |
connectbox_downstream_rxmer_db |
Downstream channel receive modulation error ratio (RxMER) |
connectbox_downstream_codewords_unerrored_total |
Unerrored downstream codewords |
connectbox_downstream_codewords_corrected_total |
Corrected downstream codewords |
connectbox_downstream_codewords_uncorrectable_total |
Uncorrectable downstream codewords |
connectbox_upstream_frequency_hz |
Upstream channel frequency |
connectbox_upstream_power_level_dbmv |
Upstream channel power level |
connectbox_upstream_symbol_rate_ksps |
Upstream channel symbol rate |
connectbox_upstream_timeouts_total |
Upstream channel timeout occurrences |
connectbox_scrape_duration_seconds |
Connect Box exporter scrape duration |
connectbox_scrape_success |
Connect Box exporter scrape success |
Grafana Dashboard
The above metrics can be monitored nicely in Grafana using this dashboard:
Contributing / Development
Pull requests are welcome. 😊 In particular, metrics on connected Wifi devices are unchartered territory since I'm not using the Wifi functionality of my device.
To install development dependencies, run:
pip install -r resources/requirements/development.txt
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for connectbox-prometheus-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf82c1f547da5ae4065b6dd0ce8de3778a57e52596e9061ba9bb5313eab6d4b9 |
|
MD5 | 2b7a02881d93c1900e53a6853ec1f535 |
|
BLAKE2b-256 | 64128ea717a9d37a63fbcaf68760ad142efb20a17e6a430150161b489e22e94f |
Hashes for connectbox_prometheus-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ca957039fa07065ce9e33a318876f488db485f6d40f7336c67719ecb3f95f97 |
|
MD5 | fda1d5f96f6890562b028dd7dc2904af |
|
BLAKE2b-256 | 5b64e0917b7c8a1993a2a6dd83603e6d8af073d75c8cbea4ce336c21f5ea81e1 |