Mercurial > prosody-modules
changeset 5584:2ac5f459e097
mod_measure_lua: Add brief README
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 30 Jun 2023 23:58:03 +0200 |
| parents | e1422ae7e4de |
| children | 5b316088bef5 |
| files | mod_measure_lua/README.md |
| diffstat | 1 files changed, 19 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_measure_lua/README.md Fri Jun 30 23:58:03 2023 +0200 @@ -0,0 +1,19 @@ +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 +```