Skip to main content

Interface: MonitoringControlEventData

Defined in: shared/types/events.ts:724

Payload for monitoring control events (global monitoring start/stop).

Remarks​

Used to signal global monitoring state changes, such as starting or stopping all monitors.

  • monitorCount: Number of monitors involved in the operation.
  • summary: Optional aggregate metrics describing the lifecycle result.
  • reason: Reason for stopping (for stopped events).
  • siteCount: Number of sites involved in the operation.
  • timestamp: The time (in ms since epoch) when the event occurred.

Example​

// Example: Monitoring stopped by user

const event: MonitoringControlEventData = {
    reason: "user",
    activeMonitors: 0,
    siteCount: 3,
    timestamp: Date.now(),
};

Hierarchy​

View Summary

Extends​

Indexable​

[key: string]: unknown
[key: number]: unknown
[key: symbol]: unknown

Properties​

timestamp​

readonly timestamp: number;

Defined in: shared/types/events.ts:104

The time (in milliseconds since epoch) when the event occurred.

Inherited from​

BaseEventData.timestamp

_meta?​

readonly optional _meta?: EventMetadata;

Defined in: shared/types/events.ts:106

Runtime metadata describing the emission context.

Inherited from​

BaseStateSyncEventData._meta

_originalMeta?​

readonly optional _originalMeta?: EventMetadata;

Defined in: shared/types/events.ts:108

Preserves previously attached metadata when re-emitting events.

Inherited from​

BaseStateSyncEventData._originalMeta

activeMonitors?​

readonly optional activeMonitors?: number;

Defined in: shared/types/events.ts:728

Number of active monitors (for stopped events).

monitorCount?​

readonly optional monitorCount?: number;

Defined in: shared/types/events.ts:732

Number of monitors involved in the operation.

reason?​

readonly optional reason?: MonitoringControlReason;

Defined in: shared/types/events.ts:739

Reason for stopping (for stopped events).

Remarks​

Refer to MONITORING_CONTROL_REASON for the complete list.

siteCount?​

readonly optional siteCount?: number;

Defined in: shared/types/events.ts:743

Number of sites involved in the operation.

summary?​

readonly optional summary?: MonitoringOperationSummary;

Defined in: shared/types/events.ts:747

Aggregate metrics describing the monitoring lifecycle outcome.