annotate mod_portcheck/mod_portcheck.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 3abbcb8584d2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4897
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 module:set_global();
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 local portmanager = require "core.portmanager";
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 local commands = module:shared("admin_shell/commands")
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 function commands.portcheck(session, line)
4899
adecfb36349e mod_portcheck: Include '*' in allowed characters so '*:port' works
Kim Alvefur <zash@zash.se>
parents: 4897
diff changeset
7 for desc, interface, port in line:gmatch("%s(%[?([%x:.*]+)%]?:(%d+))") do
4897
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 assert(portmanager.get_service_at(interface, tonumber(port)), desc);
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 end
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 session.print "OK";
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 end
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 function module.unload()
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 commands.portcheck = nil;
42a362a2bf51 mod_portcheck: Shell command to check if ports are open
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 end