From 061ea19702e05c00b9f2bc951caaebf52b5c10d5 Mon Sep 17 00:00:00 2001 From: SamTV12345 <40429738+samtv12345@users.noreply.github.com> Date: Mon, 25 Aug 2025 21:13:38 +0200 Subject: [PATCH] chore: added documentation for prometheus --- CHANGELOG.md | 7 +++++++ doc/stats.adoc | 12 ++++++++++++ 2 files changed, 19 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5b4a62b3a..53fcc4441 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +# 2.5.1 + +### Notable enhancements and fixes + +- Added endpoint for prometheus scraping. You can now scrape the metrics endpoint with prometheus. It is available at /stats/prometheus if you have enableMetrics set to true in your settings.json + + # 2.5.0 ### Notable enhancements and fixes diff --git a/doc/stats.adoc b/doc/stats.adoc index e1665a853..d1e1a6380 100644 --- a/doc/stats.adoc +++ b/doc/stats.adoc @@ -17,3 +17,15 @@ We currently measure: Under the hood, we are happy to rely on https://github.com/felixge/node-measured[measured] for all our metrics needs. To modify or simply access our stats in your plugin, simply `require('ep_etherpad-lite/stats')` which is a https://yaorg.github.io/node-measured/packages/measured-core/Collection.html[`measured.Collection`]. + + +=== Prometheus scraper + +Besides the non standard `/stats` endpoint, Etherpad also exposes a `/stats/prometheus` endpoint which is compatible with Prometheus scraping. It includes a lot more metrics than the standard `/stats` endpoint. It contains the following metrics: + +- ueberdb stats +- gc +- memory +- event loop lag +- v8 +- and more