annotate mod_measure_lua/README.md @ 5920:254a21a104aa

mod_server_contact_info: Backport from prosody trunk
author Matthew Wild <mwild1@gmail.com>
date Fri, 07 Jun 2024 16:14:58 +0100
parents 2ac5f459e097
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5584
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 ```