view mod_log_events_by_memory/README.markdown @ 5668:ecfd7aece33b

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 f781a90018f4
children
line wrap: on
line source

This module compares the memory usage reported by Lua before and after
each event and reports it to the log if it exceeds the configuration
setting `log_memory_threshold` (in bytes).

``` lua
log_memory_threshold = 20*1024
```

If you are looking to identify memory leaks, please first read [Three
kinds of memory
leaks](https://blog.nelhage.com/post/three-kinds-of-leaks/).

Prosody runs on Lua which uses automatic memory management with garbage
collection, so the numbers reported by this module are very likely to be
useless for the purpose of identifying memory leaks. Large, but
temporary, increases in memory usage can however highlight other kinds
of performance problems and sometimes even provide hits for where to
look for memory leaks.