X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=be0e3c2734c3eb96b44de652d268da397ef869c1;hb=d33d2d2fed43d102479c38cc28b496872665a90d;hp=716376faf54ac6925cf4d4ff2ea4804e1d2cb38e;hpb=29ee7e9a3f325f87d889ef09ffc1eea4916a782f;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 716376fa..be0e3c27 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -6,7 +6,7 @@ import type { Queue } from '../queue' */ export type MessageHandler = ( this: Worker, - m: unknown + message: unknown ) => void /** @@ -14,7 +14,7 @@ export type MessageHandler = ( */ export type ErrorHandler = ( this: Worker, - e: Error + error: Error ) => void /** @@ -27,66 +27,146 @@ export type OnlineHandler = (this: Worker) => void */ export type ExitHandler = ( this: Worker, - code: number + exitCode: number ) => void /** * Message object that is passed as a task between main worker and worker. * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface Task { + /** + * Task name. + */ + readonly name?: string /** * Task input data that will be passed to the worker. */ readonly data?: Data /** - * UUID of the message. + * Timestamp. + */ + readonly timestamp?: number + /** + * Message UUID. */ readonly id?: string } /** - * Worker tasks usage statistics. + * Measurement statistics. + * + * @internal + */ +export interface MeasurementStatistics { + /** + * Measurement aggregate. + */ + aggregate: number + /** + * Measurement average. + */ + average: number + /** + * Measurement median. + */ + median: number + /** + * Measurement history. + */ + history: CircularArray +} + +/** + * Event loop utilization measurement statistics. + * + * @internal + */ +export interface EventLoopUtilizationMeasurementStatistics { + idle: MeasurementStatistics + active: MeasurementStatistics + utilization: number +} + +/** + * Task statistics. * * @internal */ -export interface TasksUsage { +export interface TaskStatistics { /** - * Number of tasks executed. + * Number of executed tasks. */ - run: number + executed: number /** - * Number of tasks running. + * Number of executing tasks. */ - running: number + executing: number /** - * Tasks runtime. + * Number of queued tasks. */ - runTime: number + readonly queued: number /** - * Tasks runtime history. + * Maximum number of queued tasks. */ - runTimeHistory: CircularArray + readonly maxQueued: number /** - * Average tasks runtime. + * Number of failed tasks. */ - avgRunTime: number + failed: number +} + +/** + * Worker information. + * + * @internal + */ +export interface WorkerInfo { + /** + * Worker id. + */ + id: number | undefined + /** + * Started flag. + */ + started: boolean +} + +/** + * Worker usage statistics. + * + * @internal + */ +export interface WorkerUsage { + /** + * Tasks statistics. + */ + tasks: TaskStatistics /** - * Median tasks runtime. + * Tasks runtime statistics. */ - medRunTime: number + runTime: MeasurementStatistics /** - * Number of tasks errored. + * Tasks wait time statistics. */ - error: number + waitTime: MeasurementStatistics + /** + * Tasks event loop utilization statistics. + */ + elu: EventLoopUtilizationMeasurementStatistics } /** * Worker interface. */ export interface IWorker { + /** + * Worker id. + */ + readonly id?: number + readonly threadId?: number /** * Register an event listener. * @@ -110,7 +190,7 @@ export interface IWorker { * Worker node interface. * * @typeParam Worker - Type of worker. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface WorkerNode { @@ -119,9 +199,13 @@ export interface WorkerNode { */ readonly worker: Worker /** - * Worker node tasks usage statistics. + * Worker node worker info. + */ + info: WorkerInfo + /** + * Worker node worker usage statistics. */ - tasksUsage: TasksUsage + usage: WorkerUsage /** * Worker node tasks queue. */