jmrplens/mikroscope repository overview

⁠mikroscope (collector)

The collector half of mikroscope⁠: it reads the sub-second kernel telemetry that the jmrplens/mikroscope-agent container exposes on a MikroTik router, merges it with the RouterOS API tier, and writes the stream to a store or a dashboard.

This image is for mikroscope forward. The deployment verbs (doctor, install, upgrade, uninstall) shell out to ssh and scp, which are not in here on purpose: a container that could reconfigure a router is a larger thing to hand someone than one that reads from it. Install the agent with the CLI from the releases page or go install github.com/jmrplens/mikroscope/cmd/mikroscope@latest.

docker run --rm -e [email protected] -e GRAFANA_TOKEN=… \
  jmrplens/mikroscope forward \
  --influx http://influx:8181 --influx-db mikroscope \
  --grafana http://grafana:3000   # creates the datasource and publishes the dashboard

forward writes to eleven sinks: the file, Prometheus, InfluxDB 3, Loki, OTLP, Graphite, Elasticsearch, PostgreSQL (as a script and down a connection), Telegraf and standard output. The repository's deploy/ directory has two compose files, each a collector and somewhere for it to write, with the dashboard already in the Grafana beside it.

⁠Image

Built on distroless/static rather than scratch: the stores and Grafana it reaches are ordinarily behind TLS, and a static binary with no CA bundle fails every one of them. No shell, no package manager; runs as nonroot. Same binary as the CLI archive of the same release. Also published at ghcr.io/jmrplens/mikroscope.

⁠Platforms

linux/amd64, linux/arm64.

⁠Links

• Source: https://github.com/jmrplens/mikroscope⁠
• Documentation: https://jmrp.io/docs/mikroscope/⁠
• Sinks: https://jmrp.io/docs/mikroscope/sinks/⁠
• Five minutes with a router: https://jmrp.io/docs/mikroscope/start/walkthrough/⁠
• Agent image: https://hub.docker.com/r/jmrplens/mikroscope-agent⁠

MIT license. By José M. Requena Plens, https://jmrp.io/⁠.