view mod_server_status.wiki @ 257:53e6f43b23fc

Created wiki page through web user interface.
author MWild1@gmail.com
date Sun, 15 Jan 2012 01:35:10 +0000
parents c44f0864b33c
children 7a597092e71f
line wrap: on
line source

#summary Server status plugin
#labels Stage-Beta

= Introduction =

This module fetches the current status of configured hosts and/or stanza statistics from [http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter# mod_stanza_counter].
And outputs it in either XML or JSON format.

= Usage =

Copy the file into prosody's module directory and place it into your global's enabled modules.

Configuration example:
{{{
server_status_http_ports = {{ port = 5280, path = "mystatsbasepath" }}
server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" }
server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" }
server_status_json = true
}}}

By default the plugin's output is in XML, setting server_status_json to "true" will turn it into JSON instead.
if mod_stanza_counter isn't loaded the plugin will require at least either server_status_show_hosts or server_status_show_comps to be set.

= Compatibility =

 * Latest Trunk works
 * 0.8.x works, but components status will be not correct