mod_measure_lua/README.md
author Matthew Wild <mwild1@gmail.com>
Fri, 23 Feb 2024 22:50:57 +0000
changeset 5847 79ae71f52c81
parent 5588 2ac5f459e097
permissions -rw-r--r--
mod_pubsub_serverinfo: Update to use mod_server_info (fixes #1841) ...but only for Prosody trunk users, because 0.12 mod_server_contact_info does not use the new API in mod_server_info.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5588
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
This module provides two [metrics][doc:statistics]:
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
`lua_heap_bytes`
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
:   Bytes of memory as reported by `collectgarbage("count")`{.lua}
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
`lua_info`
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
:   Provides the current Lua version as a label
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
``` openmetrics
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
# HELP lua_info Lua runtime version
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
# UNIT lua_info
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
# TYPE lua_info gauge
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
lua_info{version="Lua 5.4"} 1
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
# HELP lua_heap_bytes Memory used by objects under control of the Lua
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
garbage collector
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
# UNIT lua_heap_bytes bytes
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
# TYPE lua_heap_bytes gauge
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
lua_heap_bytes 8613218
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
```