Added docs as asciidoctor with cross platform support.

This commit is contained in:
SamTV12345 2023-06-20 23:11:43 +02:00
parent 1c23a40aea
commit 4ca30166b8
No known key found for this signature in database
GPG key ID: E63EEC7466038043
29 changed files with 1401 additions and 860 deletions

19
doc/stats.adoc Normal file
View file

@ -0,0 +1,19 @@
== 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 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`].