view mod_measure_process/README.markdown @ 5755:4a353ccce220

luacheckrc: Replace deprecated module:once with :on_ready So that :once is warned about properly. module:once was only added in trunk so it shouldn't have gotten very far yet.
author Kim Alvefur <zash@zash.se>
date Sat, 02 Dec 2023 11:10:43 +0100
parents 025cf93acfe9
children
line wrap: on
line source

---
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
  ------- -------------