annotate mod_measure_lua/README.md @ 6084:4c0e3fe57e92

mod_compliance_latest: Gracefull error logging on missing dependency. diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md --- a/mod_compliance_latest/README.md +++ b/mod_compliance_latest/README.md @@ -9,13 +9,15 @@ rockspec: # Introduction -This module will always require and load to the lastest compliance tester we have in the community modules. -Currently this is [mod_compliance_2023]. +This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules. +Currently this is [mod_compliance_2023]. See the linked module for further details. + +If you do not use the *Prosody plugin installer* this module will likely have limited value to you. +You can also just install the current compliance tester manually. # Configuration -Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer. -See the linked module for further details. +Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*. # Compatibility diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua --- a/mod_compliance_latest/mod_compliance_latest.lua +++ b/mod_compliance_latest/mod_compliance_latest.lua @@ -1,1 +1,6 @@ -module:depends("compliance_2023"); +local success, err = pcall(function() module:depends("compliance_2023") end) + +if not success then + module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?") + return 1, "Error: Couldn't load dependency mod_compliance_2023." +end
author Menel <menel@snikket.de>
date Mon, 23 Dec 2024 12:58:03 +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 ```