Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
tetafro committed Sep 22, 2023
1 parent 22b3355 commit 7c1af08
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
[![Go Report](https://goreportcard.com/badge/github.com/tetafro/connectbox-exporter)](https://goreportcard.com/report/github.com/tetafro/connectbox-exporter)
[![Codecov](https://codecov.io/gh/tetafro/connectbox-exporter/branch/master/graph/badge.svg)](https://codecov.io/gh/tetafro/connectbox-exporter)

**WORK IN PROGRESS**

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

Client with full API: [connectbox](https://github.com/tetafro/connectbox).

Mostly copied from [compal_CH7465LG_py](https://github.com/ties/compal_CH7465LG_py)
and [connectbox-prometheus](https://github.com/mbugert/connectbox-prometheus).

Expand Down Expand Up @@ -69,3 +69,20 @@ Get ConnectBox metrics
```sh
curl 'http://localhost:9119/probe?target=192.168.178.1'
```

## Metrics

| Name | Type | Description |
| --------------------------------- | ----- | ------------------- |
| `connect_box_cm_docsis_mode` | gauge | DocSis mode |
| `connect_box_cm_hardware_version` | gauge | Hardware version |
| `connect_box_cm_mac_addr` | gauge | MAC address |
| `connect_box_cm_network_access` | gauge | Network access |
| `connect_box_cm_serial_number` | gauge | Serial number |
| `connect_box_cm_system_uptime` | gauge | System uptime |
| `connect_box_lan_client` | gauge | LAN client |
| `connect_box_oper_state` | gauge | Operational state |
| `connect_box_temperature` | gauge | Temperature |
| `connect_box_tunner_temperature` | gauge | Tunner temperature |
| `connect_box_wan_ipv4_addr` | gauge | WAN IPv4 address |
| `connect_box_wan_ipv6_addr` | gauge | WAN IPv6 address |

0 comments on commit 7c1af08

Please sign in to comment.