view mod_host_status_heartbeat/mod_host_status_heartbeat.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 7f955f92bbbb
children
line wrap: on
line source

local st = require "util.stanza";
local time = require "socket".gettime;

local heartbeat_interval = module:get_option_number("status_check_heartbeat_interval", 5);
local heartbeat_mode = module:get_option_string("status_check_heartbeat_mode", "remote");

local local_heartbeats = module:shared("/*/host_status_check/heartbeats");

local heartbeat_methods = {
	["local"] = function()
		module:log("debug", "Local heartbeat");
		local_heartbeats[module.host] = time();
		return heartbeat_interval;
	end;

	["remote"] = function ()
		module:fire_event("route/remote", {
			origin = prosody.hosts[module.host];
			stanza = st.stanza("heartbeat", { xmlns = "xmpp:prosody.im/heartbeat" });
		});
		return heartbeat_interval;
	end;		
}

local send_heartbeat = assert(heartbeat_methods[heartbeat_mode], "Unknown heartbeat_mode: "..heartbeat_mode);

module:add_timer(0, send_heartbeat);