Skip to content
This repository was archived by the owner on Feb 20, 2026. It is now read-only.
/ elabdoc Public archive

Commit 064d617

Browse files
committed
sysconfig: add /metrics note
1 parent 1c013a0 commit 064d617

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/sysadmin-guide.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,9 @@ To gather metrics from the php-fpm service, use ``/php-status``, which replies w
262262

263263
To gather metrics from the nginx service, use ``/nginx-status``, which replies with information about nginx processes. See the `Nginx status module documentation <https://nginx.org/en/docs/http/ngx_http_stub_status_module.html>`_ for more details.
264264

265-
The ``/php-status`` and ``/nginx-status`` pages are protected with **Basic authentication**:
265+
To gather metrics on the eLabFTW instance itself such as the number of experiments or uploaded files, an OpenMetrics 1.0 endpoint is exposed on ``/metrics``. Point your collector such as Prometheus to this endpoint to gather metrics periodically.
266+
267+
The ``/php-status``, ``/nginx-status`` and ``/metrics`` pages are protected with **Basic authentication**:
266268

267269
* user: ``elabftw``
268270
* password: the value of ``STATUS_PASSWORD`` environment variable

0 commit comments

Comments
 (0)