Oxynote open-source wiki embeds live PostgreSQL query charts in runbook pages

Oxynote is a new Apache-2.0 licensed internal wiki designed to combat documentation decay by embedding live data visualizations alongside explanatory text. Engineering teams can insert charts that execute SQL queries against PostgreSQL, MySQL, MariaDB, or Prometheus data sources, displaying results as time series, bar charts, or gauges within the same page as operational runbooks. The tool enforces read-only access through multiple layers: it connects exclusively to read-only roles, databases with default_transaction_read_only enabled, or standby replicas, and every session operates in read-only mode.

The project stores its own metadata in an embedded PostgreSQL 18 instance shipped inside an all-in-one Docker container. Page changes follow a Git-style workflow with drafts, diffs, and approvals before publication. Query syntax supports Grafana-style macros including $__timeFilter, $__timeGroup, and $__timeFrom, allowing teams to migrate existing dashboard queries without rewriting them.

How Oxynote integrates live queries with documentation

• Read-only safety architecture: Oxynote enforces read-only access at three levels: the database connection targets roles or databases with default_transaction_read_only enabled, or standby replicas; additionally, every database session is explicitly set to read-only mode, preventing accidental mutations from embedded queries.
• Grafana macro compatibility: Live Metrics blocks support $__timeFilter, $__timeGroup, and $__timeFrom macros, allowing engineering teams to port existing Grafana dashboard SQL directly into wiki pages without syntax changes.
• Embedded PostgreSQL 18: The all-in-one Docker image bundles PostgreSQL 18 for Oxynote's own data storage, eliminating external database dependencies for the application layer while keeping the deployment self-contained.
• Visualization types: Query results render as time series, bar charts, or gauges, supporting common operational monitoring patterns like replication lag tracking and slow query count trending.
• Git-style page workflow: Important page modifications proceed through draft, diff, and approval stages before publication, applying code review practices to operational documentation.

Why it matters

Oxynote addresses a persistent operational problem in platform engineering: runbooks and internal wikis become unreliable because they are only consulted during incidents, when accuracy matters most but verification is least likely. By pulling live PostgreSQL metrics into the same view as remediation steps, it creates daily engagement that keeps documentation current. For teams already invested in Grafana dashboards, the macro compatibility lowers adoption friction and reduces the maintenance burden of maintaining separate query libraries for monitoring and documentation systems.