Skip to main content

Interface: UptimeEvents

Defined in: electron/events/eventTypes.ts:36

eslint-disable @typescript-eslint/no-empty-object-type -- Interface is intentionally augmented in eventTypes.catalogue.*.ts

Properties

cache:invalidated

cache: invalidated: UptimeEventPayload<CacheInvalidatedEventData>;

Defined in: electron/events/eventTypes.catalogue.core.d.ts:30

Emitted when a cache entry is invalidated for a site or monitor.

Remarks

Used to trigger cache refreshes or notify listeners of data changes.

See

CacheInvalidatedEventData for payload structure.


config:changed

config: changed: {
newValue: JsonValue | undefined;
oldValue: JsonValue | undefined;
setting: string;
source: "migration" | "user" | "system";
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.core.d.ts:45

Emitted when a configuration setting is changed.

newValue

newValue: JsonValue | undefined;

The new value of the setting.

oldValue

oldValue: JsonValue | undefined;

The previous value of the setting.

setting

setting: string;

The configuration key that changed.

source

source: "migration" | "user" | "system";

Origin of the change (user, system, migration).

timestamp

timestamp: number;

Unix timestamp (ms) when the change occurred.

Remarks

Used to propagate configuration changes throughout the app.

Param

newValue

The new value of the setting.

Param

oldValue

The previous value of the setting.

Param

setting

The name of the setting that changed.

Param

source

The origin of the change ("migration", "system", or "user").

Param

timestamp

Unix timestamp (ms) when the change occurred.


database:backup-created

database:backup-created: {
fileName: string;
size: number;
timestamp: number;
triggerType: "manual" | "scheduled" | "shutdown";
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:73

Emitted when a database backup is created.

fileName

fileName: string;

Name of the backup file.

Remarks

The filename of the created backup file, typically including timestamp information for identification purposes.

size

size: number;

Size of the backup file in bytes.

Remarks

The total size of the backup file in bytes, useful for monitoring backup size trends and storage management.

timestamp

timestamp: number;

Unix timestamp (ms) when backup was created.

Remarks

Precise timing of backup creation for audit trails and backup scheduling verification.

triggerType

triggerType: "manual" | "scheduled" | "shutdown";

What triggered the backup.

Remarks

Indicates the source of the backup operation: "manual" for user-initiated backups, "scheduled" for automatic backups, or "shutdown" for app shutdown backups.

Remarks

Used for backup tracking and notification.

Param

fileName

Name of the backup file.

Param

size

Size of the backup file in bytes.

Param

timestamp

Unix timestamp (ms) when backup was created.

Param

triggerType

What triggered the backup ("manual", "scheduled", or "shutdown").


database:backup-restored

database:backup-restored: {
checksum: string;
fileName: string;
schemaVersion: number;
size: number;
timestamp: number;
triggerType: "manual" | "scheduled" | "shutdown";
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:118

Emitted when a database backup is restored.

checksum

checksum: string;

fileName

fileName: string;

schemaVersion

schemaVersion: number;

size

size: number;

timestamp

timestamp: number;

triggerType

triggerType: "manual" | "scheduled" | "shutdown";

database:error

database:error: {
[key: string]: EventPayloadValue;
error: SerializedError;
operation: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:140

Emitted when a database error occurs.

Index Signature

[key: string]: EventPayloadValue

error

error: SerializedError;

The error object that caused the database operation to fail.

Remarks

Contains the specific error information including message, stack trace, and any additional error details for debugging purposes.

operation

operation: string;

The database operation that failed.

Remarks

Identifies which specific database operation encountered the error, such as "insert", "update", "delete", or "select".

timestamp

timestamp: number;

Unix timestamp (ms) when the error occurred.

Remarks

Provides precise timing of when the database error was encountered for debugging and audit trail purposes.

Remarks

Additional properties may be present for context.

Param

error

The error object.

Param

operation

The database operation that failed.

Param

timestamp

Unix timestamp (ms) when the error occurred.


database:retry

database:retry: {
[key: string]: EventPayloadValue;
attempt: number;
operation: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:181

Emitted when a database operation is retried after failure.

Index Signature

[key: string]: EventPayloadValue

attempt

attempt: number;

The retry attempt number.

Remarks

Indicates which retry attempt this is, starting from 1 for the first retry after the initial failure. Used for tracking retry patterns.

operation

operation: string;

The database operation being retried.

Remarks

Identifies which specific database operation is being retried after a previous failure, such as "insert", "update", "delete", or "select".

timestamp

timestamp: number;

Unix timestamp (ms) when the retry occurred.

Remarks

Provides precise timing of when the retry was attempted for debugging and performance analysis purposes.

Remarks

Additional properties may be present for context.

Param

attempt

The retry attempt number.

Param

operation

The database operation being retried.

Param

timestamp

Unix timestamp (ms) when the retry occurred.


database:success

database:success: {
[key: string]: EventPayloadValue;
duration?: number;
operation: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:224

Emitted when a database operation succeeds.

Index Signature

[key: string]: EventPayloadValue

duration?

optional duration?: number;

Optional duration (ms) of the operation.

Remarks

When available, provides the time in milliseconds that the database operation took to complete. Used for performance monitoring and optimization.

operation

operation: string;

The database operation that succeeded.

Remarks

Identifies which specific database operation completed successfully, such as "insert", "update", "delete", or "select".

timestamp

timestamp: number;

Unix timestamp (ms) when the operation succeeded.

Remarks

Provides precise timing of when the database operation completed successfully for audit trails and performance tracking.

Remarks

Additional properties may be present for context.

Param

duration

Optional duration (ms) of the operation.

Param

operation

The database operation that succeeded.

Param

timestamp

Unix timestamp (ms) when the operation succeeded.


database:transaction-completed

database:transaction-completed: {
cancelled?: boolean;
duration: number;
lifecycleStage?: "success" | "failure" | "start";
operation: string;
recordsAffected?: number;
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:267

Emitted when a database transaction completes.

cancelled?

optional cancelled?: boolean;

True when the transaction/operation ended due to cancellation.

Remarks

This flag allows consumers to distinguish between an actual failure (e.g. query errors) and expected cancellation (e.g. shutdown, user-initiated stop, or abort propagation).

duration

duration: number;

Duration (ms) of the transaction.

Remarks

The total time in milliseconds that the database transaction took to complete, including all operations within the transaction.

lifecycleStage?

optional lifecycleStage?: "success" | "failure" | "start";

Optional lifecycle tagging for instrumentation consumers.

Remarks

When present, indicates whether the emission represents the "start", "success", or "failure" stage of a tracked operation.

operation

operation: string;

The database operation performed in the transaction.

Remarks

Describes the type of operation that was performed within the transaction, such as "bulk-insert", "migration", or "backup".

recordsAffected?

optional recordsAffected?: number;

Optional number of records affected.

Remarks

When available, indicates how many database records were affected by the transaction operations.

success

success: boolean;

Whether the transaction was successful.

Remarks

Indicates if the transaction completed successfully (true) or was rolled back due to an error (false).

timestamp

timestamp: number;

Unix timestamp (ms) when the transaction completed.

Remarks

Provides precise timing of when the transaction finished, regardless of success or failure status.

Param

duration

Duration (ms) of the transaction.

Param

operation

The database operation performed in the transaction.

Param

recordsAffected

Optional number of records affected.

Param

success

Whether the transaction was successful.

Param

timestamp

Unix timestamp (ms) when the transaction completed.


diagnostics:report-created

diagnostics:report-created: {
channel: string;
correlationId: string;
guard: string;
metadataTruncated: boolean;
payloadPreviewLength: number;
payloadPreviewTruncated: boolean;
reason?: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:339

Emitted whenever a diagnostics report is captured from preload.

channel

channel: string;

The sanitized channel associated with the diagnostics payload.

correlationId

correlationId: string;

Correlation identifier shared with structured logs.

guard

guard: string;

Name of the guard that produced the diagnostics payload.

metadataTruncated

metadataTruncated: boolean;

True when metadata was omitted due to byte limits.

payloadPreviewLength

payloadPreviewLength: number;

Length of the sanitized payload preview string.

payloadPreviewTruncated

payloadPreviewTruncated: boolean;

True when the payload preview was truncated due to byte limits.

reason?

optional reason?: string;

Optional rejection reason reported by the guard.

timestamp

timestamp: number;

Timestamp supplied by the preload report.


internal:cache:all-invalidated

internal:cache:all-invalidated: {
cacheName: string;
itemCount: number;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:361

Emitted when every cache entry is invalidated.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

itemCount

itemCount: number;

Number of entries invalidated.

timestamp

timestamp: number;

Unix timestamp (ms) when invalidation occurred.


internal:cache:bulk-updated

internal:cache:bulk-updated: {
cacheName: string;
itemCount: number;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:373

Emitted when multiple cache entries are updated in a batch operation.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

itemCount

itemCount: number;

Number of items affected by the bulk update.

timestamp

timestamp: number;

Unix timestamp (ms) when the bulk update completed.


internal:cache:cleanup-completed

internal:cache:cleanup-completed: {
cacheName: string;
itemCount: number;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.core.d.ts:385

Emitted after expired cache entries have been cleaned up.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

itemCount

itemCount: number;

Number of entries removed during cleanup.

timestamp

timestamp: number;

Unix timestamp (ms) when cleanup finished.


internal:cache:cleared

internal: cache: cleared: {
cacheName: string;
itemCount: number;
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.core.d.ts:397

Emitted when the entire cache is cleared.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

itemCount

itemCount: number;

Number of entries removed.

timestamp

timestamp: number;

Unix timestamp (ms) when the clear action occurred.


internal:cache:item-cached

internal:cache:item-cached: {
cacheName: string;
key: string;
timestamp: number;
ttl?: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:18

Emitted when a cache entry is cached or updated.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

key

key: string;

Cache key that was stored.

timestamp

timestamp: number;

Unix timestamp (ms) when the item was cached.

ttl?

optional ttl?: number;

Optional TTL for the cached entry in milliseconds.


internal:cache:item-deleted

internal:cache:item-deleted: {
cacheName: string;
key: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:32

Emitted when a cache entry is explicitly deleted.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

key

key: string;

Cache key that was deleted.

timestamp

timestamp: number;

Unix timestamp (ms) when the item was deleted.


internal:cache:item-evicted

internal:cache:item-evicted: {
cacheName: string;
key: string;
reason: "manual" | "lru";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:44

Emitted when a cache entry is evicted, typically due to LRU strategy.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

key

key: string;

Cache key that was evicted.

reason

reason: "manual" | "lru";

Reason the entry was evicted ("lru" for least-recently-used).

timestamp

timestamp: number;

Unix timestamp (ms) when the eviction occurred.


internal:cache:item-expired

internal:cache:item-expired: {
cacheName: string;
key: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:58

Emitted when a cache entry expires.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

key

key: string;

Cache key that expired.

timestamp

timestamp: number;

Unix timestamp (ms) when the item expired.


internal:cache:item-invalidated

internal:cache:item-invalidated: {
cacheName: string;
key: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:70

Emitted when a cache entry is invalidated.

cacheName

cacheName: string;

Name of the cache instance emitting the event.

key

key: string;

Cache key that was invalidated.

timestamp

timestamp: number;

Unix timestamp (ms) when the item was invalidated.


internal:database:backup-downloaded

internal:database:backup-downloaded: {
fileName?: string;
operation: "backup-downloaded";
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:87

Emitted when a database backup is downloaded.

fileName?

optional fileName?: string;

Optional name of the backup file.

Remarks

When available, specifies the filename of the downloaded backup. May be undefined if the backup download operation failed.

operation

operation: "backup-downloaded";

The operation type (always "backup-downloaded").

Remarks

Constant value identifying this specific database operation type for event filtering and routing purposes.

success

success: boolean;

Whether the download was successful.

Remarks

Indicates if the backup download completed successfully (true) or encountered an error (false).

timestamp

timestamp: number;

Unix timestamp (ms) when the download completed.

Remarks

Provides precise timing of when the backup download operation finished, regardless of success or failure status.

Param

fileName

Optional name of the backup file.

Param

operation

The operation type (always "backup-downloaded").

Param

success

Whether the download was successful.

Param

timestamp

Unix timestamp (ms) when the download completed.


internal:database:backup-restored

internal:database:backup-restored: {
fileName: string;
operation: "backup-restored";
schemaVersion: number;
sizeBytes: number;
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:128

Emitted when a database backup restore completes.

fileName

fileName: string;

operation

operation: "backup-restored";

schemaVersion

schemaVersion: number;

sizeBytes

sizeBytes: number;

success

success: boolean;

timestamp

timestamp: number;

internal:database:data-exported

internal:database:data-exported: {
fileName?: string;
operation: "data-exported";
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:145

Emitted when database data is exported.

fileName?

optional fileName?: string;

Optional name of the exported file.

Remarks

When available, specifies the filename of the exported data file. May be undefined if the export operation failed.

operation

operation: "data-exported";

The operation type (always "data-exported").

Remarks

Constant value identifying this specific database operation type for event filtering and routing purposes.

success

success: boolean;

Whether the export was successful.

Remarks

Indicates if the data export completed successfully (true) or encountered an error (false).

timestamp

timestamp: number;

Unix timestamp (ms) when the export completed.

Remarks

Provides precise timing of when the data export operation finished, regardless of success or failure status.

Param

fileName

Optional name of the exported file.

Param

operation

The operation type (always "data-exported").

Param

success

Whether the export was successful.

Param

timestamp

Unix timestamp (ms) when the export completed.


internal:database:data-imported

internal:database:data-imported: {
operation: "data-imported";
recordCount?: number;
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:191

Emitted when database data is imported.

operation

operation: "data-imported";

The operation type (always "data-imported").

Remarks

Constant identifier for this specific internal database operation.

recordCount?

optional recordCount?: number;

Optional number of records imported.

Remarks

Provides count of successfully imported records for tracking and reporting purposes. May be undefined if count is not available.

success

success: boolean;

Whether the import was successful.

Remarks

Indicates overall success status of the import operation. False indicates the operation failed or was aborted.

timestamp

timestamp: number;

Unix timestamp (ms) when the import completed.

Remarks

Precise timing of when the import operation finished for audit trails and performance monitoring.

Param

operation

The operation type (always "data-imported").

Param

recordCount

Optional number of records imported.

Param

success

Whether the import was successful.

Param

timestamp

Unix timestamp (ms) when the import completed.


internal:database:get-sites-from-cache-requested

internal:database:get-sites-from-cache-requested: {
operation: "get-sites-from-cache-requested";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:236

Emitted when a request is made to get sites from the cache.

operation

operation: "get-sites-from-cache-requested";

The operation type (always "get-sites-from-cache-requested").

Remarks

Constant identifier for this specific internal database operation.

timestamp

timestamp: number;

Unix timestamp (ms) when the request was made.

Remarks

Precise timing of when the cache request was initiated for performance monitoring and debugging.

Param

operation

The operation type (always "get-sites-from-cache-requested").

Param

timestamp

Unix timestamp (ms) when the request was made.


internal:database:get-sites-from-cache-response

internal:database:get-sites-from-cache-response: {
operation: "get-sites-from-cache-response";
sites: Site[];
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:264

Emitted in response to a get-sites-from-cache request.

operation

operation: "get-sites-from-cache-response";

The operation type (always "get-sites-from-cache-response").

Remarks

Constant identifier for this specific internal database operation.

sites

sites: Site[];

The list of sites returned from the cache.

Remarks

Array of site objects retrieved from the cache in response to a get-sites-from-cache request.

timestamp

timestamp: number;

Unix timestamp (ms) when the response was sent.

Remarks

Precise timing of when the cache response was generated for performance monitoring and request tracking.

Param

operation

The operation type (always "get-sites-from-cache-response").

Param

sites

The list of sites returned from the cache.

Param

timestamp

Unix timestamp (ms) when the response was sent.


internal:database:history-limit-updated

internal:database:history-limit-updated: {
limit: number;
operation: "history-limit-updated";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:301

Emitted when the history limit for the database is updated.

limit

limit: number;

The new history limit value.

Remarks

Property value for this event data structure.

operation

operation: "history-limit-updated";

The operation type (always "history-limit-updated").

timestamp

timestamp: number;

Unix timestamp (ms) when the update occurred.

Param

limit

The new history limit value.

Param

operation

The operation type (always "history-limit-updated").

Param

timestamp

Unix timestamp (ms) when the update occurred.


internal:database:sites-refreshed

internal:database:sites-refreshed: {
operation: "sites-refreshed";
siteCount: number;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:326

Emitted when the sites cache is refreshed in the database.

operation

operation: "sites-refreshed";

The operation type (always "sites-refreshed").

siteCount

siteCount: number;

The number of sites refreshed.

Remarks

Numerical value for tracking and reporting purposes.

timestamp

timestamp: number;

Unix timestamp (ms) when the refresh completed.

Param

operation

The operation type (always "sites-refreshed").

Param

siteCount

The number of sites refreshed.

Param

timestamp

Unix timestamp (ms) when the refresh completed.


internal:database:update-sites-cache-requested

internal:database:update-sites-cache-requested: {
operation: "update-sites-cache-requested";
sites?: Site[];
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalCacheDatabase.d.ts:352

Emitted when a request is made to update the sites cache.

operation

operation: "update-sites-cache-requested";

The operation type (always "update-sites-cache-requested").

sites?

optional sites?: Site[];

Optional list of sites to update in the cache.

Remarks

Cache-related data for performance optimization.

timestamp

timestamp: number;

Unix timestamp (ms) when the request was made.

Param

operation

The operation type (always "update-sites-cache-requested").

Param

sites

Optional list of sites to update in the cache.

Param

timestamp

Unix timestamp (ms) when the request was made.


internal:monitor:all-started

internal:monitor:all-started: {
monitorCount: number;
operation: "all-started";
siteCount: number;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:30

Emitted when all monitors are started.

monitorCount

monitorCount: number;

The number of monitors started.

Remarks

Numerical value for tracking and reporting purposes.

operation

operation: "all-started";

The operation type (always "all-started").

siteCount

siteCount: number;

The number of sites involved.

Remarks

Numerical value for tracking and reporting purposes.

timestamp

timestamp: number;

Unix timestamp (ms) when the operation completed.

Param

monitorCount

The number of monitors started.

Param

operation

The operation type (always "all-started").

Param

siteCount

The number of sites involved.

Param

timestamp

Unix timestamp (ms) when the operation completed.


internal:monitor:all-stopped

internal:monitor:all-stopped: {
activeMonitors: number;
operation: "all-stopped";
reason: "error" | "user" | "shutdown";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:63

Emitted when all monitors are stopped.

activeMonitors

activeMonitors: number;

The number of monitors that were active.

Remarks

Numerical value for tracking and reporting purposes.

operation

operation: "all-stopped";

The operation type (always "all-stopped").

reason

reason: "error" | "user" | "shutdown";

The reason for stopping.

Remarks

Indicates the cause or trigger for this operation.

timestamp

timestamp: number;

Unix timestamp (ms) when the operation completed.

Param

activeMonitors

The number of monitors that were active.

Param

operation

The operation type (always "all-stopped").

Param

reason

The reason for stopping.

Param

timestamp

Unix timestamp (ms) when the operation completed.


internal:monitor:manual-check-completed

internal:monitor:manual-check-completed: {
identifier: string;
monitorId?: string;
operation: "manual-check-completed";
result: StatusUpdate;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:101

Emitted when a manual monitor check is completed.

identifier

identifier: string;

Unique identifier for tracking this manual check operation.

monitorId?

optional monitorId?: string;

Optional monitor ID that was checked.

operation

operation: "manual-check-completed";

Operation type constant for this event.

result

result: StatusUpdate;

Status update result from the manual check operation.

timestamp

timestamp: number;

Unix timestamp (ms) when the manual check completed.

Param

identifier

The unique identifier for the monitor or site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "manual-check-completed").

Param

result

The status update result.

Param

timestamp

Unix timestamp (ms) when the check completed.


internal:monitor:site-setup-completed

internal:monitor:site-setup-completed: {
identifier: string;
operation: "site-setup-completed";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:136

Emitted when site setup for monitoring is completed.

identifier

identifier: string;

Unique identifier for the site that had setup completed.

operation

operation: "site-setup-completed";

Operation type constant for this event.

timestamp

timestamp: number;

Unix timestamp (ms) when setup completed.

Param

identifier

The unique identifier for the site.

Param

operation

The operation type (always "site-setup-completed").

Param

timestamp

Unix timestamp (ms) when setup completed.


internal:monitor:started

internal:monitor:started: {
identifier: string;
monitorId?: string;
operation: "started";
summary?: MonitoringStartSummary;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:161

Emitted when a monitor is started.

identifier

identifier: string;

monitorId?

optional monitorId?: string;

operation

operation: "started";

summary?

optional summary?: MonitoringStartSummary;

timestamp

timestamp: number;

Param

identifier

The unique identifier for the monitor or site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "started").

Param

timestamp

Unix timestamp (ms) when the monitor started.


internal:monitor:stopped

internal:monitor:stopped: {
identifier: string;
monitorId?: string;
operation: "stopped";
reason: "error" | "user" | "shutdown";
summary?: MonitoringStopSummary;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:178

Emitted when a monitor is stopped.

identifier

identifier: string;

monitorId?

optional monitorId?: string;

operation

operation: "stopped";

reason

reason: "error" | "user" | "shutdown";

summary?

optional summary?: MonitoringStopSummary;

timestamp

timestamp: number;

Param

identifier

The unique identifier for the monitor or site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "stopped").

Param

reason

The reason for stopping.

Param

timestamp

Unix timestamp (ms) when the monitor stopped.


internal:site:added

internal: site: added: {
identifier: string;
operation: "added";
site: Site;
source: "import" | "migration" | "user";
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:198

Emitted when a site is added internally.

identifier

identifier: string;

operation

operation: "added";

site

site: Site;

source

source: "import" | "migration" | "user";

timestamp

timestamp: number;

Param

identifier

The unique identifier for the site.

Param

operation

The operation type (always "added").

Param

site

The site object added.

Param

timestamp

Unix timestamp (ms) when the site was added.


internal:site:cache-miss

internal:site:cache-miss: {
backgroundLoading: boolean;
identifier: string;
operation: "cache-lookup";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:215

Emitted when a site lookup misses the cache internally.

backgroundLoading

backgroundLoading: boolean;

identifier

identifier: string;

operation

operation: "cache-lookup";

timestamp

timestamp: number;

Param

backgroundLoading

Whether a background refresh was triggered.

Param

identifier

The unique identifier for the site.

Param

operation

The operation type (always "cache-lookup").

Param

timestamp

Unix timestamp (ms) when the cache miss occurred.


internal:site:cache-updated

internal:site:cache-updated: {
identifier: string;
operation: "background-load" | "cache-updated" | "manual-refresh";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:229

Emitted when a site's cache is updated internally.

identifier

identifier: string;

operation

operation: "background-load" | "cache-updated" | "manual-refresh";

timestamp

timestamp: number;

Param

identifier

The unique identifier for the site.

Param

operation

The operation type (always "cache-updated").

Param

timestamp

Unix timestamp (ms) when the cache was updated.


internal:site:is-monitoring-active-requested

internal:site:is-monitoring-active-requested: {
identifier: string;
monitorId?: string;
operation: "is-monitoring-active-requested";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:248

Emitted when a request is made to check if monitoring is active for a site.

identifier

identifier: string;

The unique identifier for the site.

monitorId?

optional monitorId?: string;

Optional monitor ID.

operation

operation: "is-monitoring-active-requested";

The operation type (always "is-monitoring-active-requested").

timestamp

timestamp: number;

Unix timestamp (ms) when the request was made.

Param

identifier

The unique identifier for the site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "is-monitoring-active-requested").

Param

timestamp

Unix timestamp (ms) when the request was made.


internal:site:is-monitoring-active-response

internal:site:is-monitoring-active-response: {
identifier: string;
isActive: boolean;
monitorId: string;
operation: "is-monitoring-active-response";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:269

Emitted in response to a monitoring active check request.

identifier

identifier: string;

The unique identifier for the site.

isActive

isActive: boolean;

Whether monitoring is active.

monitorId

monitorId: string;

The monitor ID.

operation

operation: "is-monitoring-active-response";

The operation type (always "is-monitoring-active-response").

timestamp

timestamp: number;

Unix timestamp (ms) when the response was sent.

Param

identifier

The unique identifier for the site.

Param

isActive

Whether monitoring is active.

Param

monitorId

The monitor ID.

Param

operation

The operation type (always "is-monitoring-active-response").

Param

timestamp

Unix timestamp (ms) when the response was sent.


internal:site:removed

internal:site:removed: {
cascade?: boolean;
identifier?: string;
operation: "removed";
site?: Site;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:291

Emitted when a site is removed internally.

cascade?

optional cascade?: boolean;

Whether the removal was part of a cascade/bulk operation.

identifier?

optional identifier?: string;

operation

operation: "removed";

site?

optional site?: Site;

timestamp

timestamp: number;

Param

identifier

The unique identifier for the site (optional when unavailable).

Param

operation

The operation type (always "removed").

Param

site

Optional site snapshot captured prior to removal.

Param

timestamp

Unix timestamp (ms) when the site was removed.


internal:site:restart-monitoring-requested

internal:site:restart-monitoring-requested: {
identifier: string;
monitor: Monitor;
operation: "restart-monitoring-requested";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:309

Emitted when a request is made to restart monitoring for a site.

identifier

identifier: string;

The unique identifier for the site.

monitor

monitor: Monitor;

The monitor object.

operation

operation: "restart-monitoring-requested";

The operation type (always "restart-monitoring-requested").

timestamp

timestamp: number;

Unix timestamp (ms) when the request was made.

Param

identifier

The unique identifier for the site.

Param

monitor

The monitor object.

Param

operation

The operation type (always "restart-monitoring-requested").

Param

timestamp

Unix timestamp (ms) when the request was made.


internal:site:restart-monitoring-response

internal:site:restart-monitoring-response: {
identifier: string;
monitorId?: string;
operation: "restart-monitoring-response";
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:330

Emitted in response to a restart monitoring request.

identifier

identifier: string;

The unique identifier for the site.

monitorId?

optional monitorId?: string;

Optional monitor ID.

operation

operation: "restart-monitoring-response";

The operation type (always "restart-monitoring-response").

success

success: boolean;

Whether the restart was successful.

timestamp

timestamp: number;

Unix timestamp (ms) when the response was sent.

Param

identifier

The unique identifier for the site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "restart-monitoring-response").

Param

success

Whether the restart was successful.

Param

timestamp

Unix timestamp (ms) when the response was sent.


internal:site:start-monitoring-requested

internal:site:start-monitoring-requested: {
identifier: string;
monitorId?: string;
operation: "start-monitoring-requested";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:352

Emitted when a request is made to start monitoring for a site.

identifier

identifier: string;

The unique identifier for the site.

monitorId?

optional monitorId?: string;

Optional monitor ID.

operation

operation: "start-monitoring-requested";

The operation type (always "start-monitoring-requested").

timestamp

timestamp: number;

Unix timestamp (ms) when the request was made.

Param

identifier

The unique identifier for the site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "start-monitoring-requested").

Param

timestamp

Unix timestamp (ms) when the request was made.


internal:site:start-monitoring-response

internal:site:start-monitoring-response: {
identifier: string;
monitorId?: string;
operation: "start-monitoring-response";
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:366

Emitted in response to a start monitoring request.

identifier

identifier: string;

The unique identifier for the site.

monitorId?

optional monitorId?: string;

Optional monitor ID.

operation

operation: "start-monitoring-response";

The operation type (always "start-monitoring-response").

success

success: boolean;

Whether the start operation was successful.

timestamp

timestamp: number;

Unix timestamp (ms) when the response was sent.


internal:site:stop-monitoring-requested

internal:site:stop-monitoring-requested: {
identifier: string;
monitorId?: string;
operation: "stop-monitoring-requested";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:388

Emitted when a request is made to stop monitoring for a site.

identifier

identifier: string;

The unique identifier for the site.

monitorId?

optional monitorId?: string;

Optional monitor ID.

operation

operation: "stop-monitoring-requested";

The operation type (always "stop-monitoring-requested").

timestamp

timestamp: number;

Unix timestamp (ms) when the request was made.

Param

identifier

The unique identifier for the site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "stop-monitoring-requested").

Param

timestamp

Unix timestamp (ms) when the request was made.


internal:site:stop-monitoring-response

internal:site:stop-monitoring-response: {
identifier: string;
monitorId?: string;
operation: "stop-monitoring-response";
success: boolean;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:409

Emitted in response to a stop monitoring request.

identifier

identifier: string;

The unique identifier for the site.

monitorId?

optional monitorId?: string;

Optional monitor ID.

operation

operation: "stop-monitoring-response";

The operation type (always "stop-monitoring-response").

success

success: boolean;

Whether the stop operation was successful.

timestamp

timestamp: number;

Unix timestamp (ms) when the response was sent.

Param

identifier

The unique identifier for the site.

Param

monitorId

Optional monitor ID.

Param

operation

The operation type (always "stop-monitoring-response").

Param

success

Whether the stop operation was successful.

Param

timestamp

Unix timestamp (ms) when the response was sent.


internal:site:updated

internal:site:updated: {
identifier: string;
operation: "updated";
previousSite?: Site;
site: Site;
timestamp: number;
updatedFields?: string[];
};

Defined in: electron/events/eventTypes.catalogue.internalMonitoringSite.d.ts:433

Emitted when a site is updated internally.

identifier

identifier: string;

The unique identifier for the site.

operation

operation: "updated";

The operation type (always "updated").

previousSite?

optional previousSite?: Site;

Previous site snapshot before the update (optional).

site

site: Site;

The updated site object.

timestamp

timestamp: number;

Unix timestamp (ms) when the update occurred.

updatedFields?

optional updatedFields?: string[];

Optional list of updated field names.

Param

identifier

The unique identifier for the site.

Param

operation

The operation type (always "updated").

Param

site

The updated site object.

Param

previousSite

Optional snapshot of the site before the update.

Param

timestamp

Unix timestamp (ms) when the update occurred.

Param

updatedFields

Optional list of updated field names.


monitor:added

monitor: added: {
monitor: Monitor;
siteIdentifier: string;
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:35

Emitted when a monitor is added.

monitor

monitor: Monitor;

The monitor object added.

siteIdentifier

siteIdentifier: string;

The identifier of the site the monitor belongs to.

timestamp

timestamp: number;

Unix timestamp (ms) when the monitor was added.

Param

monitor

The monitor object added.

Param

siteIdentifier

The identifier of the site the monitor belongs to.

Param

timestamp

Unix timestamp (ms) when the monitor was added.


monitor:backoff-applied

monitor:backoff-applied: {
backoffAttempt: number;
correlationId: string;
delayMs: number;
monitorId: string;
siteIdentifier: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:45

Scheduler backoff applied for a monitor following failure/timeout.

backoffAttempt

backoffAttempt: number;

correlationId

correlationId: string;

delayMs

delayMs: number;

monitorId

monitorId: string;

siteIdentifier

siteIdentifier: string;

timestamp

timestamp: number;

monitor:check-completed

monitor:check-completed: {
checkType: "manual" | "scheduled";
monitorId: string;
result: StatusUpdate;
siteIdentifier: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:64

Emitted when a monitor check is completed.

checkType

checkType: "manual" | "scheduled";

The type of check ("manual" or "scheduled").

monitorId

monitorId: string;

The monitor ID.

result

result: StatusUpdate;

The status update result.

siteIdentifier

siteIdentifier: string;

The identifier of the site the monitor belongs to.

timestamp

timestamp: number;

Unix timestamp (ms) when the check completed.

Param

checkType

The type of check ("manual" or "scheduled").

Param

monitorId

The monitor ID.

Param

result

The status update result.

Param

siteIdentifier

The identifier of the site the monitor belongs to.

Param

timestamp

Unix timestamp (ms) when the check completed.


monitor:down

monitor:down:
| never
| number & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "down";
}
| bigint & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "down";
}
| false & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "down";
}
| true & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "down";
}
| symbol & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "down";
}
| never
| never
| UnknownRecord & {
length?: undefined;
} & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "down";
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:82

Emitted when a monitor goes down.

See

MonitorDownEventData for payload details.


monitor:manual-check-started

monitor:manual-check-started: {
correlationId: string;
monitorId: string;
siteIdentifier: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:85

Manual check dispatched for a monitor (pre-empts scheduled job).

correlationId

correlationId: string;

monitorId

monitorId: string;

siteIdentifier

siteIdentifier: string;

timestamp

timestamp: number;

monitor:removed

monitor: removed: {
monitorId: string;
siteIdentifier: string;
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:100

Emitted when a monitor is removed.

monitorId

monitorId: string;

The monitor ID.

siteIdentifier

siteIdentifier: string;

The identifier of the site the monitor belonged to.

timestamp

timestamp: number;

Unix timestamp (ms) when the monitor was removed.

Param

monitorId

The monitor ID.

Param

siteIdentifier

The identifier of the site the monitor belonged to.

Param

timestamp

Unix timestamp (ms) when the monitor was removed.


monitor:schedule-updated

monitor:schedule-updated: {
backoffAttempt: number;
correlationId: string;
delayMs: number;
monitorId: string;
siteIdentifier: string;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:110

Scheduler emitted when a monitor job is scheduled or rescheduled.

backoffAttempt

backoffAttempt: number;

correlationId

correlationId: string;

delayMs

delayMs: number;

monitorId

monitorId: string;

siteIdentifier

siteIdentifier: string;

timestamp

timestamp: number;

monitor:status-changed

monitor:status-changed:
| never
| number & StatusUpdate
| bigint & StatusUpdate
| false & StatusUpdate
| true & StatusUpdate
| symbol & StatusUpdate
| never
| never
| UnknownRecord & {
length?: undefined;
} & StatusUpdate;

Defined in: electron/events/eventTypes.catalogue.public.d.ts:124

Emitted when a monitor's status changes.

See

MonitorStatusChangedEventData for payload details.


monitor:timeout

monitor: timeout: {
correlationId: string;
monitorId: string;
siteIdentifier: string;
timeoutMs: number;
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:127

Emitted when a monitor check times out before completion.

correlationId

correlationId: string;

monitorId

monitorId: string;

siteIdentifier

siteIdentifier: string;

timeoutMs

timeoutMs: number;

timestamp

timestamp: number;

monitor:up

monitor:up:
| never
| number & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "up";
}
| bigint & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "up";
}
| false & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "up";
}
| true & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "up";
}
| symbol & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "up";
}
| never
| never
| UnknownRecord & {
length?: undefined;
} & StatusUpdate & {
monitor: Monitor;
site: Site;
} & {
status: "up";
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:140

Emitted when a monitor goes up.

See

MonitorUpEventData for payload details.


monitoring:started

monitoring: started: UptimeEventPayload<MonitoringStartedEventData>;

Defined in: electron/events/eventTypes.catalogue.public.d.ts:147

Emitted when monitoring is started.

See

MonitoringControlEventData (shared/types/events) for common metadata fields.


monitoring:stopped

monitoring: stopped: UptimeEventPayload<MonitoringStoppedEventData>;

Defined in: electron/events/eventTypes.catalogue.public.d.ts:154

Emitted when monitoring is stopped.

See

MonitoringControlEventData (shared/types/events) for common metadata fields.


notification:sent

notification: sent: {
correlationId: string;
monitorId: string;
siteIdentifier: string;
status: "down" | "up";
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:160

Emitted when a system notification is dispatched for a monitor status change.

correlationId

correlationId: string;

Correlation identifier for the notification emission.

monitorId

monitorId: string;

Identifier of the monitor that triggered the notification.

siteIdentifier

siteIdentifier: string;

Identifier of the site that owns the monitor.

status

status: "down" | "up";

Monitor status associated with the notification.

timestamp

timestamp: number;

Unix timestamp (ms) when the notification was dispatched.


performance:metric

performance: metric: {
category: "monitoring" | "database" | "system" | "ui";
metric: string;
timestamp: number;
unit: string;
value: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:183

Emitted when a performance metric is recorded.

category

category: "monitoring" | "database" | "system" | "ui";

The metric category ("database", "monitoring", "system", or "ui").

metric

metric: string;

The metric name.

timestamp

timestamp: number;

Unix timestamp (ms) when the metric was recorded.

unit

unit: string;

The unit of the metric.

value

value: number;

The value of the metric.

Param

category

The metric category ("database", "monitoring", "system", or "ui").

Param

metric

The metric name.

Param

timestamp

Unix timestamp (ms) when the metric was recorded.

Param

unit

The unit of the metric.

Param

value

The value of the metric.


performance:warning

performance:warning: {
actual: number;
metric: string;
suggestion?: string;
threshold: number;
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:213

Emitted when a performance warning is triggered.

actual

actual: number;

The actual value that triggered the warning.

metric

metric: string;

The metric name.

suggestion?

optional suggestion?: string;

Optional suggestion for remediation.

threshold

threshold: number;

The threshold value for the warning.

timestamp

timestamp: number;

Unix timestamp (ms) when the warning was triggered.

Param

actual

The actual value that triggered the warning.

Param

metric

The metric name.

Param

suggestion

Optional suggestion for remediation.

Param

threshold

The threshold value for the warning.

Param

timestamp

Unix timestamp (ms) when the warning was triggered.


settings:history-limit-updated

settings:history-limit-updated: UptimeEventPayload<HistoryLimitUpdatedEventData>;

Defined in: electron/events/eventTypes.catalogue.public.d.ts:235

Emitted when the database history retention limit changes.

Remarks

Forwarded to renderer clients so settings views remain synchronized when imports or backend tooling adjust the configured limit.

See

HistoryLimitUpdatedEventData for payload structure.


site:added

site: added: {
site: Site;
source: "import" | "migration" | "user";
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:245

Emitted when a site is added.

site

site: Site;

The site object added.

source

source: "import" | "migration" | "user";

The source of the addition ("import", "migration", or "user").

timestamp

timestamp: number;

Unix timestamp (ms) when the site was added.

Param

site

The site object added.

Param

source

The source of the addition ("import", "migration", or "user").

Param

timestamp

Unix timestamp (ms) when the site was added.


site:removed

site: removed: {
cascade: boolean;
siteIdentifier: string;
siteName: string;
timestamp: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:262

Emitted when a site is removed.

cascade

cascade: boolean;

Whether the removal was cascaded.

siteIdentifier

siteIdentifier: string;

The identifier of the site removed.

siteName

siteName: string;

The name of the site removed.

timestamp

timestamp: number;

Unix timestamp (ms) when the site was removed.

Param

cascade

Whether the removal was cascaded.

Param

siteIdentifier

The identifier of the site removed.

Param

siteName

The name of the site removed.

Param

timestamp

Unix timestamp (ms) when the site was removed.


site:updated

site:updated: {
previousSite: Site;
site: Site;
timestamp: number;
updatedFields: string[];
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:281

Emitted when a site is updated.

previousSite

previousSite: Site;

The previous site object.

site

site: Site;

The updated site object.

timestamp

timestamp: number;

Unix timestamp (ms) when the update occurred.

updatedFields

updatedFields: string[];

List of updated field names.

Param

previousSite

The previous site object.

Param

site

The updated site object.

Param

timestamp

Unix timestamp (ms) when the update occurred.

Param

updatedFields

List of updated field names.


sites:state-synchronized

sites:state-synchronized: StateSyncEventData;

Defined in: electron/events/eventTypes.catalogue.public.d.ts:302

Emitted when site state is synchronized.

Param

action

The synchronization action ("bulk-sync", "delete", or "update").

Param

siteIdentifier

Optional site identifier.

Param

source

Optional source of the synchronization ("cache", "database", or "frontend").

Param

timestamp

Unix timestamp (ms) when synchronization occurred.


system:error

system:error: {
context: string;
error: Error;
recovery?: string;
severity: "medium" | "high" | "low" | "critical";
timestamp: number;
};

Defined in: electron/events/eventTypes.catalogue.public.d.ts:314

Emitted when a system error occurs.

context

context: string;

The error context string.

error

error: Error;

The error object.

recovery?

optional recovery?: string;

Optional recovery suggestion.

severity

severity: "medium" | "high" | "low" | "critical";

The severity of the error ("critical", "high", "low", or "medium").

timestamp

timestamp: number;

Unix timestamp (ms) when the error occurred.

Param

context

The error context string.

Param

error

The error object.

Param

recovery

Optional recovery suggestion.

Param

severity

The severity of the error ("critical", "high", "low", or "medium").

Param

timestamp

Unix timestamp (ms) when the error occurred.


system:shutdown

system: shutdown: {
reason: "error" | "update" | "user";
timestamp: number;
uptime: number;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:342

Emitted when the system is shutting down.

reason

reason: "error" | "update" | "user";

The reason for shutdown ("error", "update", or "user").

timestamp

timestamp: number;

Unix timestamp (ms) when shutdown started.

uptime

uptime: number;

The system uptime in ms.

Param

reason

The reason for shutdown ("error", "update", or "user").

Param

timestamp

Unix timestamp (ms) when shutdown started.

Param

uptime

The system uptime in ms.


system:startup

system: startup: {
environment: "development" | "production" | "test";
timestamp: number;
version: string;
}

Defined in: electron/events/eventTypes.catalogue.public.d.ts:362

Emitted when the system starts up.

environment

environment: "development" | "production" | "test";

The runtime environment ("development", "production", or "test").

timestamp

timestamp: number;

Unix timestamp (ms) when startup completed.

version

version: string;

The app version string.

Param

environment

The runtime environment ("development", "production", or "test").

Param

timestamp

Unix timestamp (ms) when startup completed.

Param

version

The app version string.