stop_monitoring
Stop background deployment monitoring in Optimizely DXP to halt automatic polling and retrieve final deployment status. Use when deployment completes or manual monitoring is preferred.
Instructions
🛑 Stop background monitoring for deployment. INSTANT: <1s. Stops polling immediately and returns final deployment status at time of stop. Monitor is removed from active monitors list. Use when deployment completes or when manual monitoring is preferred. Required: monitorId. Returns final deployment status and monitor summary.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deploymentId | No | ||
| all | No |
Implementation Reference
- Helper method to stop background monitoring for a specific database export monitor. This is likely used by the stop_monitoring tool to stop active database export monitors.static stopBackgroundMonitoring(exportId: string): boolean { const monitor = this.backgroundMonitors.get(exportId); if (monitor) { if (monitor.intervalId) { clearInterval(monitor.intervalId); } this.backgroundMonitors.delete(exportId); OutputLogger.info(`Stopped background monitoring for export ${exportId}`); return true; } return false; }
- lib/deployment-monitor.ts:194-230 (helper)Class method to stop monitoring for a specific deployment monitor ID.stopMonitoring(monitorId: string): boolean { const monitor = this.monitors.get(monitorId); if (!monitor) { return false; } // Clear timer if (monitor.timer) { clearTimeout(monitor.timer); monitor.timer = null; } // Mark as inactive monitor.isActive = false; this.stats.activeMonitors--; this.stats.completedMonitors++; if (this.options.debug) { console.error(`Stopped monitoring deployment ${monitor.deploymentId}`); } // Emit stop event this.emit('monitorStopped', { monitorId, deploymentId: monitor.deploymentId, projectId: monitor.projectId, duration: Date.now() - monitor.startTime, updateCount: monitor.updateCount }); // Remove from active monitors after a delay (keep for stats) setTimeout(() => { this.monitors.delete(monitorId); }, 60000); // Keep for 1 minute return true; }
- lib/telemetry-health.ts:246-263 (helper)Method to stop telemetry health monitoring intervals.stopMonitoring(): void { if (this.healthTimers.endpoint) { clearInterval(this.healthTimers.endpoint); this.healthTimers.endpoint = null; } if (this.healthTimers.system) { clearInterval(this.healthTimers.system); this.healthTimers.system = null; } // Save final health state this.saveHealthState(); if (process.env.DEBUG || process.env.TELEMETRY_DEBUG) { console.error('[TELEMETRY HEALTH] Stopped health monitoring'); } }
- lib/utils/tool-availability-matrix.ts:314-318 (registration)Registration/availability entry for the stop_monitoring tool in the tool availability matrix.'stop_monitoring': { hostingTypes: ['dxp-paas', 'dxp-saas', 'self-hosted', 'unknown'], category: 'Monitoring', description: 'Stop monitoring' },
- Documentation/reference to the stop_monitoring tool in list of available monitoring commands.response.push('• `stop_monitoring` - Stop active monitors');