# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1688162283 -7200
# Node ID 2ac5f459e097f2a2d26991af73e5a688f83f576c
# Parent  e1422ae7e4dea2278ba04172b604b09e6627c27b
mod_measure_lua: Add brief README

diff -r e1422ae7e4de -r 2ac5f459e097 mod_measure_lua/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_measure_lua/README.md	Fri Jun 30 23:58:03 2023 +0200
@@ -0,0 +1,19 @@
+This module provides two [metrics][doc:statistics]:
+
+`lua_heap_bytes`
+:   Bytes of memory as reported by `collectgarbage("count")`{.lua}
+
+`lua_info`
+:   Provides the current Lua version as a label
+
+``` openmetrics
+# HELP lua_info Lua runtime version
+# UNIT lua_info
+# TYPE lua_info gauge
+lua_info{version="Lua 5.4"} 1
+# HELP lua_heap_bytes Memory used by objects under control of the Lua
+garbage collector
+# UNIT lua_heap_bytes bytes
+# TYPE lua_heap_bytes gauge
+lua_heap_bytes 8613218
+```