From 5bce9bc336da12c9dc885106dc87cd3cbb5b69a9 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Sun, 27 Oct 2013 21:59:40 +0100 Subject: [PATCH] Add docs for stats --- doc/index.md | 1 + doc/stats.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 doc/stats.md diff --git a/doc/index.md b/doc/index.md index 5d3022be5..09553f686 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,4 +1,5 @@ @include documentation +@include stats @include localization @include custom_static @include api/api diff --git a/doc/stats.md b/doc/stats.md new file mode 100644 index 000000000..7da69547d --- /dev/null +++ b/doc/stats.md @@ -0,0 +1,18 @@ +# Statistics +Etherpad keeps track of the goings-on inside the edit machinery. If you'd like to have a look at this, just point your browser to `/stats`. + +We currently measure: + + - totalUsers (counter) + - connects (meter) + - disconnects (meter) + - pendingEdits (counter) + - edits (timer) + - failedChangesets (meter) + - httpRequests (timer) + - http500 (meter) + - memoryUsage (gauge) + +Under the hood, we are happy to rely on [measured](https://github.com/felixge/node-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 `measured.Collection`. \ No newline at end of file