view mod_pubsub_stats/mod_pubsub_stats.lua @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents b2ce818ec19c
children
line wrap: on
line source

local st = require "util.stanza";

local pubsub = module:depends"pubsub";

local actor = module.host .. "/modules/" .. module.name;

local pubsub_xmlns = "http://jabber.org/protocol/pubsub"

local node = module:get_option_string(module.name .. "_node", "stats");

local function publish_stats(stats, stats_extra)
	local id = "current";
	local xitem = st.stanza("item", { xmlns = pubsub_xmlns, id = id })
		:tag("query", { xmlns = "http://jabber.org/protocol/stats" });

	for name, value in pairs(stats) do
		local stat_extra = stats_extra[name];
		local unit = stat_extra and stat_extra.units;
		xitem:tag("stat", { name = name, unit = unit, value = tostring(value) }):up();
	end

	local ok, err = pubsub.service:publish(node, actor, id, xitem);
	if not ok then
		module:log("error", "Error publishing stats: %s", err);
	end
end

function module.load()
	pubsub.service:create(node, true, {
		persistent_items = false;
		max_items = 1;
	});
	pubsub.service:set_affiliation(node, true, actor, "publisher");
end

module:hook_global("stats-updated", function (event)
	publish_stats(event.stats, event.stats_extra);
end);

function module.unload()
	pubsub.service:delete(node, true);
end

module:hook("pubsub-summary/http://jabber.org/protocol/stats", function (event)
	local payload = event.payload;
	local summary = {};
	for stat in payload:childtags("stat") do
		if stat.attr.name and stat.attr.value then
			table.insert(summary, string.format("%s: %g %s", stat.attr.name, tonumber(stat.attr.value), stat.attr.units or ""));
		end
	end
	table.sort(summary);
	return table.concat(summary, "\n");
end);