{"id":27320437,"url":"https://github.com/mulbc/fritzdocsis","last_synced_at":"2025-04-12T09:56:24.200Z","repository":{"id":41830246,"uuid":"326727227","full_name":"mulbc/fritzdocsis","owner":"mulbc","description":"DOCSIS monitoring on FritzBox","archived":false,"fork":false,"pushed_at":"2024-12-18T08:58:26.000Z","size":164,"stargazers_count":17,"open_issues_count":2,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-12T09:56:16.749Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mulbc.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-04T15:31:30.000Z","updated_at":"2025-04-09T10:17:32.000Z","dependencies_parsed_at":"2024-05-06T16:18:11.193Z","dependency_job_id":"839c4f65-5e6a-48cc-bd20-0d9924079939","html_url":"https://github.com/mulbc/fritzdocsis","commit_stats":{"total_commits":22,"total_committers":6,"mean_commits":"3.6666666666666665","dds":0.2727272727272727,"last_synced_commit":"930d951748033853faba8ecc59eb56c53b0114c9"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mulbc%2Ffritzdocsis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mulbc%2Ffritzdocsis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mulbc%2Ffritzdocsis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mulbc%2Ffritzdocsis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mulbc","download_url":"https://codeload.github.com/mulbc/fritzdocsis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248550633,"owners_count":21122932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-12T09:56:22.883Z","updated_at":"2025-04-12T09:56:24.167Z","avatar_url":"https://github.com/mulbc.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FritzBox Docsis Monitoring\n\nThis project contains the fritzdocsis source code that can be used to monitor the coax downstream connection quality.\nThis project is an [Exporter for Prometheus](https://prometheus.io/docs/instrumenting/exporters/). To use it, you will need a [Prometheus server](https://prometheus.io/) that scrapes this exporter and [Grafana](https://grafana.com/) to display the result of the scrape.\n\n## Building and Running the Exporter\n\n### Native Golang binary\n\nTo run the exporter:\n\n1. Clone this repository and cd into it\n1. Run `go mod tidy` to get the dependencies\n1. Run `go install fritzDocsis.go` to build the binary for your platform\n1. Run `${GOPATH}/bin/fritzDocsis` to run the binary\n\nTo make live easier, this repository contains a systemd service that you can use to run and auto-start the exporter once you built and installed it.\n\n### Docker / Podman container\n\nFor convienience this repo is also available as a container at quay.io/mulbc/fritzdocsis.\nImages are automatically build for amd64 and multiple arm architectures - so this should run on most hardwares including your Raspberry Pi.\n\nTo run this, try a command like this:\n```shell\npodman run --name fritzdocsis --publish 2112:2112 quay.io/mulbc/fritzdocsis -url http://192.168.178.1 -username admin -password secret\n```\n\n## Scraping the Exporter via Prometheus\n\nHow to install and set up Promtheus is out of scope, but I recommend running Prometheus as a Docker container.\n\nThis exporter will be available on Port 2112.\n\nAn example scrape of the exporter with [all the exported metrics is available here](https://github.com/mulbc/fritzdocsis/raw/master/doc-assets/example-scrape.txt)\n\n## Looking at the data from Grafana\n\nI have created a very simple Grafana dashboard that will show the error rate and Mean Squared Error (MSE) as well as the channel power level over time.\n[The dashboard is available here](https://github.com/mulbc/fritzdocsis/raw/master/doc-assets/grafana-dashboard.json)\n\nOnce deployed, the dashboard should look similar to this:\n\n![Grafana Dashboard](https://github.com/mulbc/fritzdocsis/raw/master/doc-assets/grafana-dashboard.jpg \"Grafana Dashboard\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmulbc%2Ffritzdocsis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmulbc%2Ffritzdocsis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmulbc%2Ffritzdocsis/lists"}