Mercurial > prosody-modules

view mod_measure_process/README.markdown @ 5668:ecfd7aece33b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
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
  ------- -------------