Add support for minecraft-java and minecraft-bedrock services. Prevent storing custom fields from pulses when custom fields are disabled in config.toml file.

Author: zigazajc007

docs/pulsemonitor.md

@@ -160,6 +160,36 @@ url = "redis://user:pass@redis.example.com:6379"
 timeout = 3
 ```
 
+### Minecraft Java
+
+```toml
+[monitors.pulse.minecraft-java]
+host = "mc.example.com"
+port = 25565
+timeout = 3
+
+# Optional: define a custom metric (custom1) to track the current online player count.
+[monitors.custom1]
+id = "players"
+name = "Player Count"
+unit = "players"
+```
+
+### Minecraft Bedrock
+
+```toml
+[monitors.pulse.minecraft-bedrock]
+host = "bedrock.example.com"
+port = 19132
+timeout = 3
+
+# Optional: define a custom metric (custom1) to track the current online player count.
+[monitors.custom1]
+id = "players"
+name = "Player Count"
+unit = "players"
+```
+
 ## Pulse Interval Calculation
 
 The server automatically calculates the pulse interval for PulseMonitor:

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "uptimemonitor-server",
 	"module": "src/index.ts",
-	"version": "0.2.19",
+	"version": "0.2.20",
 	"type": "module",
 	"private": true,
 	"scripts": {

src/config.ts

@@ -412,9 +412,63 @@ function validatePulseConfig(pulse: unknown, context: string): PulseConfig | und
 		}
 	}
 
+	// Validate Minecraft Java config
+	if (pulse["minecraft-java"] !== undefined) {
+		configCount++;
+		if (!isObject(pulse["minecraft-java"])) {
+			errors.push(`${context}.minecraft-java must be an object`);
+		} else {
+			const minecraftJava = pulse["minecraft-java"];
+			if (!isString(minecraftJava.host) || minecraftJava.host.trim().length === 0) {
+				errors.push(`${context}.minecraft-java.host must be a non-empty string`);
+			}
+			if (minecraftJava.port !== undefined && (!isNumber(minecraftJava.port) || minecraftJava.port <= 0 || minecraftJava.port > 65535)) {
+				errors.push(`${context}.minecraft-java.port must be a valid port number (1-65535)`);
+			}
+			if (minecraftJava.timeout !== undefined && (!isNumber(minecraftJava.timeout) || minecraftJava.timeout <= 0)) {
+				errors.push(`${context}.minecraft-java.timeout must be a positive number`);
+			}
+			if (errors.length === 0) {
+				result["minecraft-java"] = {
+					host: minecraftJava.host as string,
+					port: minecraftJava.port as number | undefined,
+					timeout: minecraftJava.timeout as number | undefined,
+				};
+			}
+		}
+	}
+
+	// Validate Minecraft Bedrock config
+	if (pulse["minecraft-bedrock"] !== undefined) {
+		configCount++;
+		if (!isObject(pulse["minecraft-bedrock"])) {
+			errors.push(`${context}.minecraft-bedrock must be an object`);
+		} else {
+			const minecraftBedrock = pulse["minecraft-bedrock"];
+			if (!isString(minecraftBedrock.host) || minecraftBedrock.host.trim().length === 0) {
+				errors.push(`${context}.minecraft-bedrock.host must be a non-empty string`);
+			}
+			if (minecraftBedrock.port !== undefined && (!isNumber(minecraftBedrock.port) || minecraftBedrock.port <= 0 || minecraftBedrock.port > 65535)) {
+				errors.push(`${context}.minecraft-bedrock.port must be a valid port number (1-65535)`);
+			}
+			if (minecraftBedrock.timeout !== undefined && (!isNumber(minecraftBedrock.timeout) || minecraftBedrock.timeout <= 0)) {
+				errors.push(`${context}.minecraft-bedrock.timeout must be a positive number`);
+			}
+			if (errors.length === 0) {
+				result["minecraft-bedrock"] = {
+					host: minecraftBedrock.host as string,
+					port: minecraftBedrock.port as number | undefined,
+					timeout: minecraftBedrock.timeout as number | undefined,
+				};
+			}
+		}
+	}
+
 	// Check that at least one config type is defined
 	if (configCount === 0) {
-		errors.push(`${context} must have at least one monitoring type configured (http, ws, tcp, udp, icmp, smtp, imap, mysql, mssql, postgresql, or redis)`);
+		errors.push(
+			`${context} must have at least one monitoring type configured (http, ws, tcp, udp, icmp, smtp, imap, mysql, mssql, postgresql, redis, minecraft-java, minecraft-bedrock)`,
+		);
 	}
 
 	if (errors.length > 0) {

src/index.ts

@@ -161,15 +161,7 @@ app.get(
 		};
 
 		if (monitor.custom1) {
-			const custom1Value = query.get(monitor.custom1.id) ?? query.get("custom1");
-			if (custom1Value !== null) {
-				const parsed = parseFloat(custom1Value);
-				if (!isNaN(parsed)) {
-					customMetrics.custom1 = parsed;
-				}
-			}
-		} else {
-			const custom1Value = query.get("custom1");
+			const custom1Value = query.get("custom1") ?? query.get(monitor.custom1.id);
 			if (custom1Value !== null) {
 				const parsed = parseFloat(custom1Value);
 				if (!isNaN(parsed)) {
@@ -179,15 +171,7 @@ app.get(
 		}
 
 		if (monitor.custom2) {
-			const custom2Value = query.get(monitor.custom2.id) ?? query.get("custom2");
-			if (custom2Value !== null) {
-				const parsed = parseFloat(custom2Value);
-				if (!isNaN(parsed)) {
-					customMetrics.custom2 = parsed;
-				}
-			}
-		} else {
-			const custom2Value = query.get("custom2");
+			const custom2Value = query.get("custom2") ?? query.get(monitor.custom2.id);
 			if (custom2Value !== null) {
 				const parsed = parseFloat(custom2Value);
 				if (!isNaN(parsed)) {
@@ -197,15 +181,7 @@ app.get(
 		}
 
 		if (monitor.custom3) {
-			const custom3Value = query.get(monitor.custom3.id) ?? query.get("custom3");
-			if (custom3Value !== null) {
-				const parsed = parseFloat(custom3Value);
-				if (!isNaN(parsed)) {
-					customMetrics.custom3 = parsed;
-				}
-			}
-		} else {
-			const custom3Value = query.get("custom3");
+			const custom3Value = query.get("custom3") ?? query.get(monitor.custom3.id);
 			if (custom3Value !== null) {
 				const parsed = parseFloat(custom3Value);
 				if (!isNaN(parsed)) {
@@ -586,50 +562,35 @@ app.websocket({
 
 			// Custom1
 			if (monitor.custom1) {
-				const custom1Value = data[monitor.custom1.id] ?? data.custom1;
+				const custom1Value = data.custom1 ?? data[monitor.custom1.id];
 				if (custom1Value !== undefined && custom1Value !== null) {
 					const parsed = parseFloat(String(custom1Value));
 					if (!isNaN(parsed)) {
 						customMetrics.custom1 = parsed;
 					}
 				}
-			} else if (data.custom1 !== undefined && data.custom1 !== null) {
-				const parsed = parseFloat(String(data.custom1));
-				if (!isNaN(parsed)) {
-					customMetrics.custom1 = parsed;
-				}
 			}
 
 			// Custom2
 			if (monitor.custom2) {
-				const custom2Value = data[monitor.custom2.id] ?? data.custom2;
+				const custom2Value = data.custom2 ?? data[monitor.custom2.id];
 				if (custom2Value !== undefined && custom2Value !== null) {
 					const parsed = parseFloat(String(custom2Value));
 					if (!isNaN(parsed)) {
 						customMetrics.custom2 = parsed;
 					}
 				}
-			} else if (data.custom2 !== undefined && data.custom2 !== null) {
-				const parsed = parseFloat(String(data.custom2));
-				if (!isNaN(parsed)) {
-					customMetrics.custom2 = parsed;
-				}
 			}
 
 			// Custom3
 			if (monitor.custom3) {
-				const custom3Value = data[monitor.custom3.id] ?? data.custom3;
+				const custom3Value = data.custom3 ?? data[monitor.custom3.id];
 				if (custom3Value !== undefined && custom3Value !== null) {
 					const parsed = parseFloat(String(custom3Value));
 					if (!isNaN(parsed)) {
 						customMetrics.custom3 = parsed;
 					}
 				}
-			} else if (data.custom3 !== undefined && data.custom3 !== null) {
-				const parsed = parseFloat(String(data.custom3));
-				if (!isNaN(parsed)) {
-					customMetrics.custom3 = parsed;
-				}
 			}
 
 			// Parse timing parameters

src/pulsemonitor.ts

@@ -118,6 +118,24 @@ export function buildPulseMonitorConfig(monitor: Monitor): any {
 				timeout: monitor.pulse.redis.timeout || 3,
 			};
 		}
+
+		// Minecraft Java monitoring
+		if (monitor.pulse["minecraft-java"]) {
+			pulseConfig["minecraft-java"] = {
+				host: monitor.pulse["minecraft-java"].host,
+				port: monitor.pulse["minecraft-java"].port,
+				timeout: monitor.pulse["minecraft-java"].timeout,
+			};
+		}
+
+		// Minecraft Bedrock monitoring
+		if (monitor.pulse["minecraft-bedrock"]) {
+			pulseConfig["minecraft-bedrock"] = {
+				host: monitor.pulse["minecraft-bedrock"].host,
+				port: monitor.pulse["minecraft-bedrock"].port,
+				timeout: monitor.pulse["minecraft-bedrock"].timeout,
+			};
+		}
 	}
 
 	return pulseConfig;

src/types.ts

@@ -147,6 +147,30 @@ export interface PulseRedisConfig {
 	timeout?: number;
 }
 
+/**
+ * Minecraft Java pulse monitoring configuration
+ */
+export interface MinecraftJavaConfig {
+	/** Server address */
+	host: string;
+	/** Server port */
+	port?: number;
+	/** Connection timeout in seconds */
+	timeout?: number;
+}
+
+/**
+ * Minecraft Bedrock pulse monitoring configuration
+ */
+export interface MinecraftBedrockConfig {
+	/** Server address */
+	host: string;
+	/** Server port */
+	port?: number;
+	/** Connection timeout in seconds */
+	timeout?: number;
+}
+
 /**
  * Pulse monitoring configuration - defines what PulseMonitor should check
  * Only one type should be configured per monitor
@@ -174,6 +198,10 @@ export interface PulseConfig {
 	postgresql?: PulsePostgresqlConfig;
 	/** Redis monitoring */
 	redis?: PulseRedisConfig;
+	/** Minecraft Java monitoring */
+	"minecraft-java"?: MinecraftJavaConfig;
+	/** Minecraft Bedrock monitoring */
+	"minecraft-bedrock"?: MinecraftBedrockConfig;
 }
 
 /**