Mercurial > prosody-modules

view mod_measure_lua/README.md @ 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 2ac5f459e097
children
line wrap: on
line source

This module provides two [metrics][doc:statistics]:

`lua_heap_bytes`
:   Bytes of memory as reported by `collectgarbage("count")`{.lua}

`lua_info`
:   Provides the current Lua version as a label

``` openmetrics
# HELP lua_info Lua runtime version
# UNIT lua_info
# TYPE lua_info gauge
lua_info{version="Lua 5.4"} 1
# HELP lua_heap_bytes Memory used by objects under control of the Lua
garbage collector
# UNIT lua_heap_bytes bytes
# TYPE lua_heap_bytes gauge
lua_heap_bytes 8613218
```