Mercurial > prosody-modules
view misc/munin/prosody_.lua @ 6258:06fbbd45ba75
mod_cloud_notify: Readme: fix links and labels that were removed in the last commit
diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md
--- a/mod_cloud_notify/README.md
+++ b/mod_cloud_notify/README.md
@@ -1,3 +1,9 @@
+----
+-labels:
+-- 'Stage-Beta'
+-summary: 'XEP-0357: Cloud push notifications'
+----
+
# Introduction
This module enables support for sending "push notifications" to clients
@@ -32,15 +38,15 @@ notification to your device. When your d
it will display it or wake up the app so it can connect to XMPP and
receive any pending messages.
-This protocol is described for developers in \[XEP-0357: Push
-Notifications\].
+This protocol is described for developers in [XEP-0357: Push
+Notifications].
-For this module to work reliably, you must have \[mod_smacks\],
-\[mod_mam\] and \[mod_carbons\] also enabled on your server.
+For this module to work reliably, you must have [mod_smacks],
+[mod_mam] and [mod_carbons] also enabled on your server.
Some clients, notably Siskin and Snikket iOS need some additional
extensions that are not currently defined in a standard XEP. To support
-these clients, see \[mod_cloud_notify_extensions\].
+these clients, see [mod_cloud_notify_extensions].
# Configuration
@@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex
# Internal design notes
App servers are notified about offline messages, messages stored by
-\[mod_mam\] or messages waiting in the smacks queue. The business rules
+[mod_mam] or messages waiting in the smacks queue. The business rules
outlined
[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html)
are all honored[^2].
-To cooperate with \[mod_smacks\] this module consumes some events:
+To cooperate with [mod_smacks] this module consumes some events:
`smacks-ack-delayed`, `smacks-hibernation-start` and
`smacks-hibernation-end`. These events allow this module to send out
notifications for messages received while the session is hibernated by
-\[mod_smacks\] or even when smacks acknowledgements for messages are
+[mod_smacks] or even when smacks acknowledgements for messages are
delayed by a certain amount of seconds configurable with the
-\[mod_smacks\] setting `smacks_max_ack_delay`.
+[mod_smacks] setting `smacks_max_ack_delay`.
The `smacks_max_ack_delay` setting allows to send out notifications to
clients which aren't already in smacks hibernation state (because the
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:44:37 +0200 |
| parents | 235d986ac20f |
| children |
line wrap: on
line source
#!/usr/bin/env lua -- Script for use with mod_statistics -- Create symlinks to this named eg prosody_c2s in /etc/munin/plugins local print = print; local pairs = pairs; local socket = require"socket"; local stats = {}; stats.c2s = { graph_title = "Prosody C2S Connections"; graph_vlabel = "users"; graph_category = "Prosody"; all_client_connections = { label = "client connections"; _key = "total_c2s"; } } stats.s2s = { graph_title = "Prosody S2S Connections"; graph_vlabel = "servers"; graph_category = "Prosody"; outgoing_connections = { label = "outgoing connections"; _key = "total_s2sout"; }; incoming_connections = { label = "incoming connections"; _key = "total_s2sin"; }; total_connections = { label = "total connections"; _key = "total_s2s"; }; } stats.mem = { graph_title = "Prosody Memory Usage"; graph_vlabel = "Bytes"; graph_args = "--base 1024 -l 0"; graph_category = "Prosody"; --memory_unused graph_order = "memory_total memory_rss memory_allocated memory_used memory_lua memory_returnable"; memory_allocated = { label = "Allocated", draw = "AREA" }; memory_lua = { label = "Lua", draw = "AREA" }; memory_rss = { label = "RSS", draw = "AREA" }; memory_total = { label = "Total", draw = "AREA" }; -- memory_unused = { label = "Unused", draw = "AREA" }; memory_used = { label = "Used", draw = "AREA" }; memory_returnable = { label = "Returnable", draw = "AREA" }; } stats.cpu = { graph_title = "Prosody CPU Usage"; graph_category = "Prosody"; graph_args = "-l 0"; graph_vlabel = "CPU time used in milliseconds"; cpu_total = { label = "CPU"; type = "DERIVE"; min = 0; }; } stats.auth = { graph_title = "Prosody Authentications"; graph_category = "Prosody"; graph_args = "--base 1000"; c2s_auth = { label = "Logins"; type = "DERIVE"; min = 0; }; c2s_authfail = { label = "Failed logins"; type = "DERIVE"; min = 0; }; } local function onerror(msg, err, exit) io.stderr:write(msg, '\n'); if err then io.stderr:write(err, '\n'); end os.exit(exit or 1); end local function connect() local conn, err = socket.connect(os.getenv"host" or "localhost", os.getenv"port" or 5782); if not conn then onerror("Could not connect to prosody", err); end conn:settimeout(1); return conn; end local function get_config(item) for k,v in pairs(item) do if type(v) == "string" then print(k .. " " .. v); elseif type(v) == "table" then for sk,v in pairs(v) do if not sk:match("^_") then print(k.."."..sk.." "..v); end end end end end local function get_stats(item) local labels = {}; for key, val in pairs(item) do if type(val) == "table" and val.label then labels[val._key or key] = key; end end local conn = connect(); local line, err = conn:receive("*l"); local stat, value, label; while line and line ~= "" and next(labels) ~= nil do stat, value = line:match('^STAT%s+"([^"]*)"%s*(%b())'); label = stat and labels[stat]; if label then print(label..".value "..tonumber(value:sub(2,-2))); labels[stat] = nil; end line, err = conn:receive("*l"); end if err then onerror(err); end end local function main(stat, mode) if mode == "suggest" then for available_stat in pairs(stats) do print(available_stat); end elseif mode == "config" then return get_config(stats[stat]); elseif stats[stat] then return get_stats(stats[stat]); end end if arg then return main(arg[0]:match("prosody_(%w*)"), ...); end return { stats = stats, get_stats = get_stats, get_config = get_config, }
