Mercurial > prosody-modules

diff mod_measure_process/README.markdown @ 4554:025cf93acfe9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_measure_process: Provide metrics about the process itself
author Jonas Schäfer <jonas@wielicki.name>
date Wed, 28 Apr 2021 08:21:54 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_measure_process/README.markdown	Wed Apr 28 08:21:54 2021 +0200
@@ -0,0 +1,27 @@
+---
+labels:
+- Statistics
+summary: Measure process resource use metrics (cpu, memory, file descriptors)
+---
+
+Description
+===========
+
+This module exposes process resource use metrics similar to those exposed by
+default when using a Prometheus client library. Specifically, the following
+metrics are exposed:
+
+- CPU use
+- Resident set and virtual memory size
+- Number of open file descriptors and their limit
+
+This module uses the new OpenMetrics API and thus requires a recent version
+of Prosody trunk (0.12+).
+
+Compatibility
+=============
+
+  ------- -------------
+  trunk   Works
+  0.11    Does not work
+  ------- -------------