Mercurial > prosody-modules

diff mod_http_status/README.md @ 5161:6af2d74daa15

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_status: Report module statuses Uncommitted code from 2021
author Kim Alvefur <zash@zash.se>
date Mon, 30 Jan 2023 00:48:12 +0100
parents
children e274431bf4ce
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_status/README.md	Mon Jan 30 00:48:12 2023 +0100
@@ -0,0 +1,15 @@
+Prosody 0.12 added an API allowing modules to report their status. This
+module allows reading these statuses via HTTP for use in monitoring.
+
+```
+$ curl http://prosody.localhost:5280/status
+{
+   "example.com" : {
+      "c2s" : {
+         "message" : "Loaded",
+         "type" : "core"
+      }
+   }
+}
+```
+