annotate mod_measure_lua/README.md @ 5668:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
| author |
Kim Alvefur <zash@zash.se> |
| date |
Fri, 06 Oct 2023 18:34:39 +0200 |
| parents |
2ac5f459e097 |
| children |
|
| rev |
line source |
|
5584
|
1 This module provides two [metrics][doc:statistics]: |
|
|
2 |
|
|
3 `lua_heap_bytes` |
|
|
4 : Bytes of memory as reported by `collectgarbage("count")`{.lua} |
|
|
5 |
|
|
6 `lua_info` |
|
|
7 : Provides the current Lua version as a label |
|
|
8 |
|
|
9 ``` openmetrics |
|
|
10 # HELP lua_info Lua runtime version |
|
|
11 # UNIT lua_info |
|
|
12 # TYPE lua_info gauge |
|
|
13 lua_info{version="Lua 5.4"} 1 |
|
|
14 # HELP lua_heap_bytes Memory used by objects under control of the Lua |
|
|
15 garbage collector |
|
|
16 # UNIT lua_heap_bytes bytes |
|
|
17 # TYPE lua_heap_bytes gauge |
|
|
18 lua_heap_bytes 8613218 |
|
|
19 ``` |
