view mod_munin/mod_munin.lua @ 6257:fa45ae704b79

mod_cloud_notify: Update Readme 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,109 +1,106 @@ ---- -labels: -- 'Stage-Beta' -summary: 'XEP-0357: Cloud push notifications' ---- +# Introduction -Introduction -============ +This module enables support for sending "push notifications" to clients +that need it, typically those running on certain mobile devices. -This module enables support for sending "push notifications" to clients that -need it, typically those running on certain mobile devices. +As well as this module, your client must support push notifications (the +apps that need it generally do, of course) and the app developer's push +gateway must be reachable from your Prosody server (this happens over a +normal XMPP server-to-server 's2s' connection). -As well as this module, your client must support push notifications (the apps -that need it generally do, of course) and the app developer's push gateway -must be reachable from your Prosody server (this happens over a normal XMPP -server-to-server 's2s' connection). - -Details -======= +# Details Some platforms, notably Apple's iOS and many versions of Android, impose -limits that prevent applications from running or accessing the network in the -background. This makes it difficult or impossible for an XMPP application to -remain reliably connected to a server to receive messages. - -In order for messaging and other apps to receive notifications, the OS vendors -run proprietary servers that their OS maintains a permanent connection to in -the background. Then they provide APIs to application developers that allow -sending notifications to specific devices via those servers. +limits that prevent applications from running or accessing the network +in the background. This makes it difficult or impossible for an XMPP +application to remain reliably connected to a server to receive +messages. -When you connect to your server with an app that requires push notifications, -it will use this module to set up a "push registration". When you receive -a message but your device is not connected to the server, this module will -generate a notification and send it to the push gateway operated by your -application's developers). Their gateway will then connect to your device's -OS vendor and ask them to forward the notification to your device. When your -device receives the notification, it will display it or wake up the app so it -can connect to XMPP and receive any pending messages. +In order for messaging and other apps to receive notifications, the OS +vendors run proprietary servers that their OS maintains a permanent +connection to in the background. Then they provide APIs to application +developers that allow sending notifications to specific devices via +those servers. -This protocol is described for developers in [XEP-0357: Push Notifications]. +When you connect to your server with an app that requires push +notifications, it will use this module to set up a "push registration". +When you receive a message but your device is not connected to the +server, this module will generate a notification and send it to the push +gateway operated by your application's developers). Their gateway will +then connect to your device's OS vendor and ask them to forward the +notification to your device. When your device receives the notification, +it will display it or wake up the app so it can connect to XMPP and +receive any pending messages. -For this module to work reliably, you must have [mod_smacks], [mod_mam] and -[mod_carbons] also enabled on your server. +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. -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]. +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\]. -Configuration -============= +# Configuration - Option Default Description - ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- - `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty - `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled - `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) - `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) - `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended. - `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended. + Option Default Description + -------------------------------------- ---------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty + `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled + `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) + `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours) + `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended. + `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended. -(\*) There are privacy implications for enabling these options. +(\*) There are privacy implications for enabling these options.[^1] -Internal design notes -===================== +# 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 outlined [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) are all honored[^2]. +App servers are notified about offline messages, messages stored by +\[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: -`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 delayed by a certain amount of seconds -configurable with the [mod_smacks] setting `smacks_max_ack_delay`. +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 +delayed by a certain amount of seconds configurable with the +\[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 read timeout or -connection close didn't already happen) but also aren't responding to acknowledgement -request in a timely manner. This setting thus allows conversations to be smoother -under such circumstances. +The `smacks_max_ack_delay` setting allows to send out notifications to +clients which aren't already in smacks hibernation state (because the +read timeout or connection close didn't already happen) but also aren't +responding to acknowledgement request in a timely manner. This setting +thus allows conversations to be smoother under such circumstances. -The new event `cloud-notify-ping` can be used by any module to send out a cloud -notification to either all registered endpoints for the given user or only the endpoints -given in the event data. +The new event `cloud-notify-ping` can be used by any module to send out +a cloud notification to either all registered endpoints for the given +user or only the endpoints given in the event data. -The config setting `push_notification_important_body` can be used to specify an alternative -body text to send to the remote pubsub node if the stanza is encrypted or has a body. -This way the real contents of the message aren't revealed to the push appserver but it -can still see that the push is important. -This is used by Chatsecure on iOS to send out high priority pushes in those cases for example. +The config setting `push_notification_important_body` can be used to +specify an alternative body text to send to the remote pubsub node if +the stanza is encrypted or has a body. This way the real contents of the +message aren't revealed to the push appserver but it can still see that +the push is important. This is used by Chatsecure on iOS to send out +high priority pushes in those cases for example. -Compatibility -============= - -**Note:** This module should be used with Lua 5.2 and higher. Using it with -Lua 5.1 may cause push notifications to not be sent to some clients. +# Compatibility ------- ----------------------------------------------------------------------------- - trunk Works - 0.12 Works - 0.11 Works - 0.10 Works - 0.9 Support dropped, use last supported version [675726ab06d3](//hg.prosody.im/prosody-modules/raw-file/675726ab06d3/mod_cloud_notify/mod_cloud_notify.lua) ------- ----------------------------------------------------------------------------- +**Note:** This module should be used with Lua 5.2 and higher. Using it +with Lua 5.1 may cause push notifications to not be sent to some +clients. + ------- ----------------------------------------------------------------- + trunk Works as of 25-06-13 + 13 Works + 0.12 Works + ------- ----------------------------------------------------------------- -[^1]: The service which is expected to forward notifications to something like Google Cloud Messaging or Apple Notification Service -[^2]: [business_rules.markdown](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.markdown) +[^1]: The service which is expected to forward notifications to + something like Google Cloud Messaging or Apple Notification Service + +[^2]: [business_rules.md](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.md)
author Menel <menel@snikket.de>
date Fri, 13 Jun 2025 10:36:52 +0200
parents 7e5c8186f121
children
line wrap: on
line source

module:set_global();

local s_format = string.format;
local t_insert = table.insert;
local t_concat = table.concat;
local array = require"util.array";
local it = require"util.iterators";
local mt = require"util.multitable";

local meta = mt.new(); meta.data = module:shared"meta";
local data = mt.new(); data.data = module:shared"data";

local munin_listener = {};
local munin_commands = {};

local node_name = module:get_option_string("munin_node_name", "localhost");
local ignore_stats = module:get_option_set("munin_ignored_stats", { });

local function clean_fieldname(name)
	return (name:gsub("[^A-Za-z0-9_]", "_"):gsub("^[^A-Za-z_]", "_%1"));
end

function munin_listener.onconnect(conn)
	-- require"core.statsmanager".collect();
	conn:write("# munin node at "..node_name.."\n");
end

function munin_listener.onincoming(conn, line)
	line = line and line:match("^[^\r\n]+");
	if type(line) ~= "string" then return end
	-- module:log("debug", "incoming: %q", line);
	local command = line:match"^%w+";
	command = munin_commands[command];
	if not command then
		conn:write("# Unknown command.\n");
		return;
	end
	local ok, err = pcall(command, conn, line);
	if not ok then
		module:log("error", "Error running %q: %s", line, err);
		conn:close();
	end
end

function munin_listener.ondisconnect() end

function munin_commands.cap(conn)
	conn:write("cap\n");
end

function munin_commands.list(conn)
	conn:write(array(it.keys(data.data)):concat(" ") .. "\n");
end

function munin_commands.config(conn, line)
	-- TODO what exactly?
	local stat = line:match("%s(%S+)");
	if not stat then conn:write("# Unknown service\n.\n"); return end
	for _, _, k, value in meta:iter(stat, "", nil) do
		conn:write(s_format("%s %s\n", k, value));
	end
	for _, name, k, value in meta:iter(stat, nil, nil) do
		if name ~= "" and not ignore_stats:contains(name) then
			conn:write(s_format("%s.%s %s\n", name, k, value));
		end
	end
	conn:write(".\n");
end

function munin_commands.fetch(conn, line)
	local stat = line:match("%s(%S+)");
	if not stat then conn:write("# Unknown service\n.\n"); return end
	for _, name, value in data:iter(stat, nil) do
		if not ignore_stats:contains(name) then
			conn:write(s_format("%s.value %.12f\n", name, value));
		end
	end
	conn:write(".\n");
end

function munin_commands.quit(conn)
	conn:close();
end

module:hook("stats-updated", function (event)
	local all_stats, this = event.stats_extra;
	local host, sect, name, typ, key;
	for stat, value in pairs(event.changed_stats) do
		if not ignore_stats:contains(stat) then
			this = all_stats[stat];
			-- module:log("debug", "changed_stats[%q] = %s", stat, tostring(value));
			host, sect, name, typ = stat:match("^/([^/]+)/([^/]+)/(.+):(%a+)$");
			if host == nil then
				sect, name, typ = stat:match("^([^.]+)%.(.+):(%a+)$");
			elseif host == "*" then
				host = nil;
			end
			if sect:find("^mod_measure_.") then
				sect = sect:sub(13);
			elseif sect:find("^mod_statistics_.") then
				sect = sect:sub(16);
			end
			key = clean_fieldname(s_format("%s_%s_%s", host or "global", sect, typ));

			if not meta:get(key) then
				if host then
					meta:set(key, "", "graph_title", s_format("%s %s on %s", sect, typ, host));
				else
					meta:set(key, "", "graph_title", s_format("Global %s %s", sect, typ));
				end
				meta:set(key, "", "graph_vlabel", this and this.units or typ);
				meta:set(key, "", "graph_category", sect);

				meta:set(key, name, "label", name);
			elseif not meta:get(key, name, "label") then
				meta:set(key, name, "label", name);
			end

			data:set(key, name, value);
		end
	end
end);

local function openmetrics_handler(event)
	local registry = event.metric_registry
	local host, sect, name, typ, key;
	for family_name, metric_family in pairs(registry:get_metric_families()) do
		if not ignore_stats:contains(family_name) then
			-- module:log("debug", "changed_stats[%q] = %s", stat, tostring(value));
			local host_key
			if metric_family.label_keys[1] == "host" then
				host_key = 1
			end
			if family_name:sub(1, 12) == "prosody_mod_" then
				sect, name = family_name:match("^prosody_mod_([^/]+)/(.+)$")
			else
				sect, name = family_name:match("^([^_]+)_(.+)$")
			end
			name = clean_fieldname(name)

			local metric_type = metric_family.type_
			if metric_type == "gauge" or metric_type == "unknown" then
				typ = "GAUGE"
			else
				typ = "DCOUNTER"
			end

			for labelset, metric in metric_family:iter_metrics() do
				host = host_key and labelset[host_key] or "global"
				local name_parts = {}
				for i, label in ipairs(labelset) do
					if i ~= host_key then
						t_insert(name_parts, label)
					end
				end
				local full_name = t_concat(name_parts, "_")
				local display_name = #name_parts > 0 and full_name or name
				key = clean_fieldname(s_format("%s_%s_%s", host or "global", sect, name));

				local unit
				local factor = 1
				unit = metric_family.unit
				if unit == "seconds" and typ == "DCOUNTER" then
					factor = 100
					unit = "%time"
				elseif typ == "DCOUNTER" then
					unit = unit .. "/s"
				end

				if not meta:get(key, "") then
					meta:set(key, "", "graph_title", s_format(metric_family.description));
					if unit ~= "" then
						meta:set(key, "", "graph_vlabel", unit);
					end
					meta:set(key, "", "graph_category", sect);
				end
				if not meta:get(key, display_name) then
					meta:set(key, display_name, "label", display_name);
					meta:set(key, display_name, "type", typ)
				end

				for suffix, extra_labels, value in metric:iter_samples() do
					if metric_type == "histogram" or metric_type == "summary" then
						if suffix == "_sum" then
							data:set(key, display_name, value * factor)
						end
					elseif suffix == "_total" or suffix == "" then
						data:set(key, display_name, value * factor)
					end
				end
			end
		end
	end
end

module:hook("openmetrics-updated", openmetrics_handler);

module:provides("net", {
	listener = munin_listener;
	default_mode = "*l";
	default_port = 4949;
});