annotate mod_measure_lua/README.md @ 6319:04c3273cb81f

mod_auth_cyrus: Add empty 'profile' table to SASL handler objects This is for compatibility with Prosody's built-in util.sasl objects. A SASL profile table usually includes methods supported by the backend, which can be used by SASL mechanism handlers to perform operations (such as testing the password). It also optionally contains a 'cb' field with channel binding method handlers. The Cyrus backend doesn't support channel binding, and doesn't have the same concept of auth backend methods (it handles all that internally, and Prosody has no insight or control over it). Thus, we create an empty profile which informs Prosody that the SASL handler does not support any of the auth or channel binding methods. Some features will not work, but they didn't work anyway. This just makes it explicit. This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to always contain a 'profile' field.
author Matthew Wild <mwild1@gmail.com>
date Thu, 04 Sep 2025 10:14:46 +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 ```