chore: added documentation for prometheus

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

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