connectbox-exporter

command module
v0.1.12 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2023 License: MIT Imports: 23 Imported by: 0

README

ConnectBox Exporter

License Github CI Go Report Codecov

WORK IN PROGRESS

A Prometheus exporter for ConnectBox routers used by Ziggo internet provider in the Netherlands.

Mostly copied from compal_CH7465LG_py and connectbox-prometheus.

Run

Use docker

Create a config file config.yml (example).

docker run -d \
    --volume /host-dir/config.yml:/etc/prometheus/connectbox-exporter.yml \
    --publish 9119:9119 \
    --name connectbox-exporter \
    ghcr.io/tetafro/connectbox-exporter:latest
Download binary

Download and unpack latest release.

Create a config file config.yml (example).

Run

./connectbox-exporter -config config.yml
Build from sources

Clone the repository

git clone git@github.com:tetafro/connectbox-exporter.git
cd connectbox-exporter

Copy and populate config

cp config.example.yml config.yml

Build and run

make build run

Get metrics

Get exporter internal metrics

curl 'http://localhost:9119/metrics'

Get ConnectBox metrics

curl 'http://localhost:9119/probe?target=192.168.178.1'

Documentation

Overview

Package main is a generated GoMock package.

ConnectBox exporter reads metrics from ConnectBox router using HTTP API, and returns them in Prometheus format.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL