aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKim Alvefur <zash@zash.se>2022-01-29 14:58:37 +0100
committerKim Alvefur <zash@zash.se>2022-01-29 14:58:37 +0100
commitd9f7b2632865b433e3a3cecb21f2c6c9191080b3 (patch)
tree27fd7ccf91658f03e239c542786b217b47b83b4b
parent09d7e131d07c75aac4b1d9f66ad3708aed3d3e21 (diff)
downloadprosody-d9f7b2632865b433e3a3cecb21f2c6c9191080b3.tar.gz
prosody-d9f7b2632865b433e3a3cecb21f2c6c9191080b3.zip
mod_admin_shell: Add help section about stats
-rw-r--r--plugins/mod_admin_shell.lua5
1 files changed, 4 insertions, 1 deletions
diff --git a/plugins/mod_admin_shell.lua b/plugins/mod_admin_shell.lua
index 1d57539c..2ca38be1 100644
--- a/plugins/mod_admin_shell.lua
+++ b/plugins/mod_admin_shell.lua
@@ -220,6 +220,7 @@ function commands.help(session, data)
print [[user - Commands to create and delete users, and change their passwords]]
print [[roles - Show information about user roles]]
print [[muc - Commands to create, list and manage chat rooms]]
+ print [[stats - Commands to show internal statistics]]
print [[server - Uptime, version, shutting down, etc.]]
print [[port - Commands to manage ports the server is listening on]]
print [[dns - Commands to manage and inspect the internal DNS resolver]]
@@ -294,7 +295,9 @@ function commands.help(session, data)
print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]
print [[config:get([host,] option) - Show the value of a config option.]]
elseif section == "stats" then -- luacheck: ignore 542
- -- TODO describe how stats:show() works
+ print [[stats:show(pattern) - Show internal statistics, optionally filtering by name with a pattern]]
+ print [[stats:show():cfgraph() - Show a cumulative frequency graph]]
+ print [[stats:show():histogram() - Show a histogram of selected metric]]
elseif section == "debug" then
print [[debug:logevents(host) - Enable logging of fired events on host]]
print [[debug:events(host, event) - Show registered event handlers]]