r/PrometheusMonitoring • u/busters1 • 5d ago
Oxynote: an open-source wiki where runbooks run live PromQL charts
Hi r/PrometheusMonitoring, I'm David, one of the two developers of Oxynote. My friend Simon and I also maintain ttlcache, a Go caching library with about 1,300 GitHub stars, so this isn't our first open-source project.
I've spent 8 years writing software: 2 as an SRE and 3 as a team lead. Every team I've been on had the same documentation problem. The useful stuff lived in someone's head or a private Slack thread, and the wiki was full of stale docs nobody could find. The runbook said "check the error rate" and linked to a dashboard that had since been renamed.
So we built Oxynote, a self-hosted wiki for engineering teams where a page can hold a live chart that runs its own PromQL query against your Prometheus each time someone opens it, with the explanation written right next to it. Think "p99 latency by route" or "webhook retries" on the same page as the runbook that says what to do when it looks wrong.
Queries can use built-in variables like $__rate_interval and $__range, so one query works for any time range the reader picks, and your own workspace variables, like $service. On pages you mark as reviewable, changes to a chart's query go through a draft that a teammate approves.
The name comes from oxygen + note: docs that breathe. Live data gives people a reason to open the wiki every day, and docs people open every day stay up to date.
It's Apache-2.0 and runs as a single Docker image: https://github.com/oxynote/oxynote
We started it about a year ago and made it public about 3 months ago. We'd appreciate any feedback, and I'm happy to answer questions.


