Skip to content

Commit 061ea19

Browse files
committed
chore: added documentation for prometheus
1 parent 4259a8c commit 061ea19

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# 2.5.1
2+
3+
### Notable enhancements and fixes
4+
5+
- 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
6+
7+
18
# 2.5.0
29

310
### Notable enhancements and fixes

doc/stats.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,15 @@ We currently measure:
1717
Under the hood, we are happy to rely on https://github.com/felixge/node-measured[measured] for all our metrics needs.
1818

1919
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`].
20+
21+
22+
=== Prometheus scraper
23+
24+
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:
25+
26+
- ueberdb stats
27+
- gc
28+
- memory
29+
- event loop lag
30+
- v8
31+
- and more

0 commit comments

Comments
 (0)