Comparison

plugins/mod_admin_shell.lua @ 12225:e9f34a04067e

mod_admin_shell: Add help section about stats
author Kim Alvefur <zash@zash.se>
date Sat, 29 Jan 2022 14:58:37 +0100
parent 12224:2b348d65cd69
child 12226:7db81c9cbbbf
comparison
equal deleted inserted replaced
12224:2b348d65cd69 12225:e9f34a04067e
218 print [[module - Commands to load/reload/unload modules/plugins]] 218 print [[module - Commands to load/reload/unload modules/plugins]]
219 print [[host - Commands to activate, deactivate and list virtual hosts]] 219 print [[host - Commands to activate, deactivate and list virtual hosts]]
220 print [[user - Commands to create and delete users, and change their passwords]] 220 print [[user - Commands to create and delete users, and change their passwords]]
221 print [[roles - Show information about user roles]] 221 print [[roles - Show information about user roles]]
222 print [[muc - Commands to create, list and manage chat rooms]] 222 print [[muc - Commands to create, list and manage chat rooms]]
223 print [[stats - Commands to show internal statistics]]
223 print [[server - Uptime, version, shutting down, etc.]] 224 print [[server - Uptime, version, shutting down, etc.]]
224 print [[port - Commands to manage ports the server is listening on]] 225 print [[port - Commands to manage ports the server is listening on]]
225 print [[dns - Commands to manage and inspect the internal DNS resolver]] 226 print [[dns - Commands to manage and inspect the internal DNS resolver]]
226 print [[xmpp - Commands for sending XMPP stanzas]] 227 print [[xmpp - Commands for sending XMPP stanzas]]
227 print [[debug - Commands for debugging the server]] 228 print [[debug - Commands for debugging the server]]
292 print [[xmpp:ping(localhost, remotehost) -- Sends a ping to a remote XMPP server and reports the response]] 293 print [[xmpp:ping(localhost, remotehost) -- Sends a ping to a remote XMPP server and reports the response]]
293 elseif section == "config" then 294 elseif section == "config" then
294 print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]] 295 print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]
295 print [[config:get([host,] option) - Show the value of a config option.]] 296 print [[config:get([host,] option) - Show the value of a config option.]]
296 elseif section == "stats" then -- luacheck: ignore 542 297 elseif section == "stats" then -- luacheck: ignore 542
297 -- TODO describe how stats:show() works 298 print [[stats:show(pattern) - Show internal statistics, optionally filtering by name with a pattern]]
299 print [[stats:show():cfgraph() - Show a cumulative frequency graph]]
300 print [[stats:show():histogram() - Show a histogram of selected metric]]
298 elseif section == "debug" then 301 elseif section == "debug" then
299 print [[debug:logevents(host) - Enable logging of fired events on host]] 302 print [[debug:logevents(host) - Enable logging of fired events on host]]
300 print [[debug:events(host, event) - Show registered event handlers]] 303 print [[debug:events(host, event) - Show registered event handlers]]
301 print [[debug:timers() - Show information about scheduled timers]] 304 print [[debug:timers() - Show information about scheduled timers]]
302 elseif section == "console" then 305 elseif section == "console" then