Oxynote is a new open-source (Apache-2.0) internal wiki for engineering teams. 
A page can include a chart that runs its own query against Prometheus, 
PostgreSQL, MySQL, or MariaDB right next to the explanatory text, and changes 
to important pages go through a draft, a diff, and approval, like a pull 
request.

Internal docs go stale because people open them only when something breaks. 
Live data gives the team a reason to open a page every day, and pages read 
daily stay up to date.

How it works with PostgreSQL:

* Live Metrics blocks run SQL against your PostgreSQL databases and show the 
result as a time series, bar chart or gauge.
* Queries can use Grafana-style macros such as `$__timeFilter`, `$__timeGroup` 
and `$__timeFrom`, so existing dashboard queries carry over.
* Oxynote only connects to read-only data sources: a role or database with 
`default_transaction_read_only` enabled, or a standby. Every session also runs 
in read-only mode.
* Oxynote stores its own data in PostgreSQL 18, which is embedded in the 
all-in-one Docker image.

A typical use is a runbook that shows replication lag or slow query counts next 
to the steps for handling them, so the chart and its explanation are reviewed 
together.

Oxynote is available from:

* [Source and install instructions](https://github.com/oxynote/oxynote)
* [Latest release](https://github.com/oxynote/oxynote/releases)

Reply via email to