README.md

Prometheus Etherpad integration

Exposes endpoint at /metrics for Grafana / Prometheus to slobber from.

Usage

See the collected stats at /metrics

Example queries for Grafana

{__name__=~"ep_performance_test_hooks_loadTimes__(.*)_fetchUntilResponseEndTime"}

{__name__=~"ep_performance_test_hooks_loadTimes__(.*)_fetchUntilResponseEndTime"}

ep_performance_test_hooks_etherpadHooksDuration_postAceInit

totalUsers

(memoryUsageHeap / 1024 / 1024)

Installation

Install from the Etherpad admin UI (Admin → Manage Plugins, search for ep_prometheus and click Install), or from the Etherpad root directory:

pnpm run plugins install ep_prometheus

⚠️ Don't run npm i / npm install yourself from the Etherpad source tree — Etherpad tracks installed plugins through its own plugin-manager, and hand-editing package.json can leave the server unable to start.

After installing, restart Etherpad.