feat: rename plugin to harbor-forge, remove sidecar, add --install-cli
Major changes: - Renamed plugin id from harborforge-monitor to harbor-forge (TODO 4.1) - Removed sidecar server/ directory and spawn logic (TODO 4.2) - Added monitorPort to plugin config schema (TODO 4.3) - Added --install-cli flag to installer for building hf CLI (TODO 4.4) - skills/hf/ only deployed when --install-cli is present (TODO 4.5) - Plugin now serves telemetry data directly via tools - Installer handles migration from old plugin name - Bumped version to 0.2.0
This commit is contained in:
179
plugin/index.ts
179
plugin/index.ts
@@ -1,11 +1,14 @@
|
||||
/**
|
||||
* HarborForge Monitor Plugin for OpenClaw
|
||||
* HarborForge Plugin for OpenClaw
|
||||
*
|
||||
* Manages sidecar lifecycle and provides monitor-related tools.
|
||||
* Provides monitor-related tools and exposes OpenClaw metadata
|
||||
* for the HarborForge Monitor bridge (via monitor_port).
|
||||
*
|
||||
* Sidecar architecture has been removed. Telemetry data is now
|
||||
* served directly by the plugin when Monitor queries via the
|
||||
* local monitor_port communication path.
|
||||
*/
|
||||
import { spawn } from 'child_process';
|
||||
import { join } from 'path';
|
||||
import { existsSync } from 'fs';
|
||||
import { hostname, freemem, totalmem, uptime, loadavg, platform } from 'os';
|
||||
import { getLivePluginConfig, type HarborForgeMonitorConfig } from './core/live-config';
|
||||
|
||||
interface PluginAPI {
|
||||
@@ -23,14 +26,14 @@ interface PluginAPI {
|
||||
}
|
||||
|
||||
export default {
|
||||
id: 'harborforge-monitor',
|
||||
name: 'HarborForge Monitor',
|
||||
id: 'harbor-forge',
|
||||
name: 'HarborForge',
|
||||
register(api: PluginAPI) {
|
||||
const logger = api.logger || {
|
||||
info: (...args: any[]) => console.log('[HF-Monitor]', ...args),
|
||||
error: (...args: any[]) => console.error('[HF-Monitor]', ...args),
|
||||
debug: (...args: any[]) => console.debug('[HF-Monitor]', ...args),
|
||||
warn: (...args: any[]) => console.warn('[HF-Monitor]', ...args),
|
||||
info: (...args: any[]) => console.log('[HarborForge]', ...args),
|
||||
error: (...args: any[]) => console.error('[HarborForge]', ...args),
|
||||
debug: (...args: any[]) => console.debug('[HarborForge]', ...args),
|
||||
warn: (...args: any[]) => console.warn('[HarborForge]', ...args),
|
||||
};
|
||||
|
||||
const baseConfig: HarborForgeMonitorConfig = {
|
||||
@@ -43,122 +46,53 @@ export default {
|
||||
...(api.pluginConfig || {}),
|
||||
};
|
||||
|
||||
const serverPath = join(__dirname, 'server', 'telemetry.mjs');
|
||||
let sidecar: ReturnType<typeof spawn> | null = null;
|
||||
|
||||
function resolveConfig() {
|
||||
return getLivePluginConfig(api, baseConfig);
|
||||
}
|
||||
|
||||
function startSidecar() {
|
||||
/**
|
||||
* Collect current system telemetry snapshot.
|
||||
* This data is exposed to the Monitor bridge when it queries the plugin.
|
||||
*/
|
||||
function collectTelemetry() {
|
||||
const live = resolveConfig();
|
||||
const enabled = live.enabled !== false;
|
||||
|
||||
logger.info('HarborForge Monitor plugin config resolved', {
|
||||
enabled,
|
||||
hasApiKey: Boolean(live.apiKey),
|
||||
backendUrl: live.backendUrl ?? null,
|
||||
identifier: live.identifier ?? null,
|
||||
});
|
||||
|
||||
if (!enabled) {
|
||||
logger.info('HarborForge Monitor plugin disabled');
|
||||
return;
|
||||
}
|
||||
|
||||
if (sidecar) {
|
||||
logger.debug('Sidecar already running');
|
||||
return;
|
||||
}
|
||||
|
||||
if (!live.apiKey) {
|
||||
logger.warn('Missing config: apiKey');
|
||||
logger.warn('API authentication will fail. Generate apiKey from HarborForge Monitor admin.');
|
||||
}
|
||||
|
||||
if (!existsSync(serverPath)) {
|
||||
logger.error('Telemetry server not found:', serverPath);
|
||||
return;
|
||||
}
|
||||
|
||||
logger.info('Starting HarborForge Monitor telemetry server...');
|
||||
|
||||
const env = {
|
||||
...process.env,
|
||||
HF_MONITOR_BACKEND_URL: live.backendUrl || 'https://monitor.hangman-lab.top',
|
||||
HF_MONITOR_IDENTIFIER: live.identifier || '',
|
||||
HF_MONITOR_API_KEY: live.apiKey || '',
|
||||
HF_MONITOR_REPORT_INTERVAL: String(live.reportIntervalSec || 30),
|
||||
HF_MONITOR_HTTP_FALLBACK_INTERVAL: String(live.httpFallbackIntervalSec || 60),
|
||||
HF_MONITOR_LOG_LEVEL: live.logLevel || 'info',
|
||||
OPENCLAW_PATH: process.env.OPENCLAW_PATH || join(process.env.HOME || '/root', '.openclaw'),
|
||||
HF_MONITOR_PLUGIN_VERSION: api.version || 'unknown',
|
||||
const load = loadavg();
|
||||
return {
|
||||
identifier: live.identifier || hostname(),
|
||||
platform: platform(),
|
||||
hostname: hostname(),
|
||||
uptime: uptime(),
|
||||
memory: {
|
||||
total: totalmem(),
|
||||
free: freemem(),
|
||||
used: totalmem() - freemem(),
|
||||
usagePercent: ((totalmem() - freemem()) / totalmem()) * 100,
|
||||
},
|
||||
load: {
|
||||
avg1: load[0],
|
||||
avg5: load[1],
|
||||
avg15: load[2],
|
||||
},
|
||||
openclaw: {
|
||||
version: api.version || 'unknown',
|
||||
pluginVersion: '0.2.0',
|
||||
},
|
||||
timestamp: new Date().toISOString(),
|
||||
};
|
||||
|
||||
sidecar = spawn('node', [serverPath], {
|
||||
env,
|
||||
detached: false,
|
||||
stdio: ['ignore', 'pipe', 'pipe'],
|
||||
});
|
||||
|
||||
sidecar.stdout?.on('data', (data: Buffer) => {
|
||||
logger.info('[telemetry]', data.toString().trim());
|
||||
});
|
||||
|
||||
sidecar.stderr?.on('data', (data: Buffer) => {
|
||||
logger.error('[telemetry]', data.toString().trim());
|
||||
});
|
||||
|
||||
sidecar.on('exit', (code, signal) => {
|
||||
logger.info(`Telemetry server exited (code: ${code}, signal: ${signal})`);
|
||||
sidecar = null;
|
||||
});
|
||||
|
||||
sidecar.on('error', (err: Error) => {
|
||||
logger.error('Failed to start telemetry server:', err.message);
|
||||
sidecar = null;
|
||||
});
|
||||
|
||||
logger.info('Telemetry server started with PID:', sidecar.pid);
|
||||
}
|
||||
|
||||
function stopSidecar() {
|
||||
if (!sidecar) {
|
||||
logger.debug('Telemetry server not running');
|
||||
return;
|
||||
}
|
||||
|
||||
logger.info('Stopping HarborForge Monitor telemetry server...');
|
||||
sidecar.kill('SIGTERM');
|
||||
|
||||
const timeout = setTimeout(() => {
|
||||
if (sidecar && !sidecar.killed) {
|
||||
logger.warn('Telemetry server did not exit gracefully, forcing kill');
|
||||
sidecar.kill('SIGKILL');
|
||||
}
|
||||
}, 5000);
|
||||
|
||||
sidecar.on('exit', () => {
|
||||
clearTimeout(timeout);
|
||||
});
|
||||
}
|
||||
|
||||
api.on('gateway_start', () => {
|
||||
logger.info('gateway_start received, starting telemetry server...');
|
||||
startSidecar();
|
||||
logger.info('HarborForge plugin active');
|
||||
});
|
||||
|
||||
api.on('gateway_stop', () => {
|
||||
logger.info('gateway_stop received, stopping telemetry server...');
|
||||
stopSidecar();
|
||||
logger.info('HarborForge plugin stopping');
|
||||
});
|
||||
|
||||
process.on('SIGTERM', stopSidecar);
|
||||
process.on('SIGINT', stopSidecar);
|
||||
|
||||
// Tool: plugin status
|
||||
api.registerTool(() => ({
|
||||
name: 'harborforge_monitor_status',
|
||||
description: 'Get HarborForge Monitor plugin status',
|
||||
name: 'harborforge_status',
|
||||
description: 'Get HarborForge plugin status and current telemetry snapshot',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: {},
|
||||
@@ -167,18 +101,31 @@ export default {
|
||||
const live = resolveConfig();
|
||||
return {
|
||||
enabled: live.enabled !== false,
|
||||
sidecarRunning: sidecar !== null && sidecar.exitCode === null,
|
||||
pid: sidecar?.pid || null,
|
||||
config: {
|
||||
backendUrl: live.backendUrl,
|
||||
identifier: live.identifier || 'auto-detected',
|
||||
identifier: live.identifier || hostname(),
|
||||
monitorPort: (live as any).monitorPort || null,
|
||||
reportIntervalSec: live.reportIntervalSec,
|
||||
hasApiKey: Boolean(live.apiKey),
|
||||
},
|
||||
telemetry: collectTelemetry(),
|
||||
};
|
||||
},
|
||||
}));
|
||||
|
||||
logger.info('HarborForge Monitor plugin registered');
|
||||
// Tool: telemetry snapshot (for Monitor bridge queries)
|
||||
api.registerTool(() => ({
|
||||
name: 'harborforge_telemetry',
|
||||
description: 'Get current system telemetry data for HarborForge Monitor',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: {},
|
||||
},
|
||||
async execute() {
|
||||
return collectTelemetry();
|
||||
},
|
||||
}));
|
||||
|
||||
logger.info('HarborForge plugin registered (id: harbor-forge)');
|
||||
},
|
||||
};
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"id": "harborforge-monitor",
|
||||
"name": "HarborForge Monitor",
|
||||
"version": "0.1.0",
|
||||
"description": "Server monitoring plugin for HarborForge - streams telemetry to Monitor",
|
||||
"id": "harbor-forge",
|
||||
"name": "HarborForge",
|
||||
"version": "0.2.0",
|
||||
"description": "HarborForge plugin for OpenClaw - project management, monitoring, and CLI integration",
|
||||
"entry": "./index.js",
|
||||
"configSchema": {
|
||||
"type": "object",
|
||||
@@ -11,7 +11,7 @@
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Enable the monitor plugin"
|
||||
"description": "Enable the HarborForge plugin"
|
||||
},
|
||||
"backendUrl": {
|
||||
"type": "string",
|
||||
@@ -26,6 +26,10 @@
|
||||
"type": "string",
|
||||
"description": "API Key from HarborForge Monitor admin panel (optional but required for authentication)"
|
||||
},
|
||||
"monitorPort": {
|
||||
"type": "number",
|
||||
"description": "Local port for communication between HarborForge Monitor and this plugin"
|
||||
},
|
||||
"reportIntervalSec": {
|
||||
"type": "number",
|
||||
"default": 30,
|
||||
|
||||
Reference in New Issue
Block a user